Cleanerfish

About Cleanerfish

Cleanerfish is your new favourite utility to cleanup your node.js projects from actually unused files and dependencies!

Dependencies

Cleanerfish is not the usual boring and ineffective npm prune. Insteat it actually scans your project to seek dependencies that are not imported/required, but are present in your package.json and removes them!

Files (hard mode)

Cleanerfish can also scan your project to prune it from all files that are not imported/required in the filnal bundle (--hard or --hard-only). Just remember to always provide the list of entrypoints of your project (usualy not imported by something else) to prevent Cleanerfish to eat them up too - just use the --exclude-hard option.

Cleanerfish is compatible with both npm and yarn package managers and supports require, import and coffeescript syntaxes.

Cleanerfish Installation

npm instal -g cleanerfish

Cleanerfish Usage

Safe (confirmation required)

cleanerfish clean

Automatic (no confirmation required)

cleanerfish clean -y

Other options

-p, --folder-path <string>  specify a folder to inspect (must be a sub-folder of the project)
-f, --file <string>         specify a file to inspect (must be inside the project/main folder)
-i, --ignore <string>       ignore list of packages (comma-separated)
--prevent-defaults          prevent default ignored packages from being skipped (false by default)
--exclude-dirs <string>     specify a comma-separated list of directories to exclude (must be sub-folder of the project/main folder)
--exclude-files <string>    specify a comma-separated list of files to exclude (must be inside the project/main folder)
-c, --comments              considers commented imports as valid (false by default)
-o, --optional              include optionalDependencies (false by default)
-d, --dev                   include devDependencies (false by default)
--yarn                      use yarn instead of npm

Hard mode

Hard mode removes unused project files before scanning it for unimported dependencies.

cleanerfish clean --hard

--hard-only                 hard mode only (skip dependencies cleanup)
--exclude-hard <string>     prevent comma-separated files from being removed in hard/hard-only mode (e.g. project entrypoints)

List defaults

cleanerfish defaults