nm_cleaner v1.0.4

NM_Cleaner :recycle:

Cleans node_modules from non code files (e.g. README.md).

WARNING This utility is unstable and not production-ready.

Cleaning Results

Installation

Tested on versions: yarn: 1.13 node: 11.10

npm i -g nm_cleaner

# or
yarn global add nm_cleaner

Usage

Just clean the node_modules in a project directory.

nm_clean <project_folder>

Show files that are deleted.

nm_clean <project_folder> -a

Demo

mkdir nm_clean-demo
cd nm_clean-demo
npm init -y
npm i koa
nm_clean ./ -a

Demo uses koa, express and fs-extra packages for demonstration.

How it works

nm_clean goes recursively through node_modules, then picks unnessesary files and deletes them. Yes, so simple.

Supported extensions & directories

• Markdown files
• License files
• Every file ending with 'rc'
• 'ignore' files
• Makefile
• Tests and example directories
• YAML files, for example travis.yml
• Unnesesary config files such as .editorconfig

and some more in the future...

TODO

• Create nm_clean
• Also remove directories
• Add timers to count how many seconds it took to clean
• Make everything async for better perfomance
• Publish the package
• Create plugin for Gulp & Webpack
• Add more file extensions