lgtome/rm-node-modules-cli

CLI for removing unused node_modules

Remove node_modules cli

This is the CLI that allows removing unused by days count node_modules. Zero dependencies, ~100% test coverage. ✨

Table of Contents

• Installation And Usage
• Arguments
• Example Structure
• Example Commands
• Future Goals
• Contribution

Installation and Usage

Prerequisites: Node.js (^12.22.0, ^14.17.0, or >=16.0.0) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

You can install using npm:

npm i -g rm-nmless

After that, you can execute by the command line using:

rm-nm $COMMAND$ $PATH$ $DAYS$

See the Arguments for more information.

Arguments

Allowed methods:

check - check and print folders which should be deleted. (default method)

rm-nm check

execute - delete folders and print deleted folders.

rm-nm execute

Allowed arguments:

path - path to folder with projects. See Structure and Examples for more information.

--path=$VALUE$

days - how many days passed after the last editing. Any number value, if that will be zero it equal to all the time. (Default 14 days)

--days=$VALUE$

verbose - where parse ended, print additional information about a files

--v

or

--verbose

Example Structure

projects <-- path to this folder
│
└───sample_proj_1
│   │   node_modules <-- will be deleted
│   │   ...
└───sample_proj_2
│   │   node_modules <-- will be deleted
│   │   ...
└───sample_proj_3
│   │   node_modules <-- will be deleted
│   │   ...

Example Commands

Default usage:

rm-nm check --path=../../ --days=7
rm-nm execute --path=../../ --days=7

or without path:

rm-nm check <- would be used current  folder

• path also can be like this:

rm-nm check --path=.

or this:

rm-nm check --path=~ <-- parse user directory

or event this:

rm-nm check --path=/ <-- parse root directory

• also you can use like this to check:

rm-nm --path=../../ --days=7

• you can also use without days(default 14d), like this:

rm-nm check --path=../../
rm-nm execute --path=../../

• days = 0, says that the last changed irrelevant:

rm-nm --path=../../ --days=0 <-- will be deleted all node_modules which will be found

Future Goals

• Providing more information about projects.

Contribution

Show your ❤️ and support by giving a ⭐. Any suggestions, issues or PR's are welcome!