Helps you find dead files!
🍖🦅Cawww 🦅🍖
Clone this repo
I am working on getting the name of the package vulture from another package
of the same name that is no longer being worked on. Then it would be through NPM
~~ IN PROGRESS, suspect to change ~~
Currently, you must pass in a configuration file that has these keys:
module.exports = {
project: process.cwd(), // path to project
sourceDir: `${process.cwd()}/src` // path to source,
entryPoints: [
`${process.cwd()}/src/index.js`, // path(s) to mount points of application
],
alternatePaths: ['src/_shared'],
}In the future, this will be a .vulturerc file, similar to how babel or eslint
are configured.
For local dev, follow these steps!
At the root of the package:
- npm link
- yarn start
You should now be able to use the vulture command.
At a high level, this is what we are doing...
- given a set of roots, go through each file and
- follow all imports, collecting file paths as you go
- once all files have been traversed, compare file list to all files in src
Contributors Welcome!