node-peruse

node-peruse

CLI tool designed to help Node.js developers analyze and review node.js project.

Key Features

• Validate dockerfiles
• Git commit best practices Validator
• Check outdated dependencies
• Check Node.js version
• Check system memory usage
• Analyze project dependencies

There are many more features to come, so keep on eye on this repository.

Download/install

npm install -g node-peruse

yarn add -g node-peruse

Once installed, you can use node-peruse directly in your terminal.

node-peruse <command> [options]

Documentation

1. Check or validate dockerfiles

Find issues in your dockerfiles (e.g., Dockerfile, compose.yml), use the --dockerfile flag.

node-peruse --dockerfile

2. Git commit best practices validator

This feature scans recent Git commits to ensure they follow best practices: (e.g., feat:, fix:, chore:, etc.)

node-peruse --git

3. Check outdated dependencies

To check outdated packages in your project, use the --outdated flag.

node-peruse --outdated

4. Check Node.js version

To check node.js version, use the --node-check flag.

node-peruse --node-check

5. Check system memory usage

To check system memory is sufficient, use the --memory-check flag.

node-peruse --memory-check

6. Check unused dependencies

To check unused dependencies in you node.js application, use the --unused flag.

node-peruse --unused

7. Check your os architecture

To get os architecture, use the --arch flag.

node-peruse --arch

8. Check your os name

To get your os name, use the --name flag.

node-peruse --name

9. Analyze project dependencies

Use the --dependencies option to analyze and list all dependencies in your project.

node-peruse --dependencies

Using Node-Peruse with npx

To run Node-Peruse without installing it globally, users can simply use:

npx node-peruse <command> [options]

mean you can remove node-peruse with npx and run the command directly and it will work the same way.

Contributing

See CONTRIBUTING.md for more information on how to contribute to node-peruse.

Support

• Give a ⭐️ if this project helped you!
• You can also sponsor me on Github