🚀 Usage

npx node-modules-cleanup@latest <path>

📚 Examples

# Find all node_modules in the current directory
npx node-modules-cleanup@latest ./

# Find all node_modules in a specific directory
npx node-modules-cleanup@latest ~/Desktop/projects

# Skip confirmation before deleting folders
npx node-modules-cleanup@latest ./ --skip-confirmation

# Dry run of the cleanup process, no folders are deleted
npx node-modules-cleanup@latest ./ --dry

📝 Arguments

| Argument | Description | Required | | --------------------- | ---------------------------------------------------------- | -------- | | <path> | The path to search for node_modules folders | Yes | | --skip-confirmation | Skip confirmation before deleting folders | No | | --dry | Dry run of the cleanup process, no folders will be deleted | No | | --help | Show help information | No | | --version | Show package version | No |

💻 Development

Install Bun

This project is built with Bun, to install it run the following command:

curl -fsSL https://bun.sh/install | bash

Install dependencies

To install the dependencies, run the following command:

bun install

Generate mocked node_modules folders

For easier development a script is available that will generate multiple mocked node_modules folders inside of the ./mock folder. The number of folders, files, and their names are randomized to simulate real-world scenarios.

# Generate a simple set of mocked folders (default, ~1s cleanup time)
bun run create-mocks

# Generate a complex set of mocked folders (~7s cleanup time)
bun run create-mocks -- --mode=complex

Run the script

The following command will then execute the script.

bun run dev ./mock              # Or any other path

Useful commands during development

bun run dev                     # Runs the script
bun run test                    # Runs the test suite
bun run unused-code-check       # Check for unused code
bun run lint                    # Run ESLint
bun run tsc                     # Runs TypeScript checks
bun run build                   # Builds the package