https://github.com/shivarm/node-peruse
A powerful CLI tool designed to analyze your node.js application
https://github.com/shivarm/node-peruse
analyze dependencies git node-cli
Last synced: 6 months ago
JSON representation
A powerful CLI tool designed to analyze your node.js application
- Host: GitHub
- URL: https://github.com/shivarm/node-peruse
- Owner: shivarm
- License: mit
- Created: 2024-11-06T15:45:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T01:32:24.000Z (6 months ago)
- Last Synced: 2025-04-22T12:12:54.428Z (6 months ago)
- Topics: analyze, dependencies, git, node-cli
- Language: JavaScript
- Homepage:
- Size: 177 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
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
```bash
npm install -g node-peruse
yarn add -g node-peruse
```
Once installed, you can use node-peruse directly in your terminal.
```bash
node-peruse [options]
```
## Documentation
### 1. Check or validate dockerfiles
Find issues in your dockerfiles (e.g., Dockerfile, compose.yml), use the `--dockerfile` flag.
```bash
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.)
```bash
node-peruse --git
```
### 3. Check outdated dependencies
To check outdated packages in your project, use the `--outdated` flag.
```bash
node-peruse --outdated
```
### 4. Check Node.js version
To check node.js version, use the `--node-check` flag.
```bash
node-peruse --node-check
```
### 5. Check system memory usage
To check system memory is sufficient, use the `--memory-check` flag.
```bash
node-peruse --memory-check
```
### 6. Check unused dependencies
To check unused dependencies in you node.js application, use the `--unused` flag.
```bash
node-peruse --unused
```
### 7. Check your os architecture
To get os architecture, use the `--arch` flag.
```bash
node-peruse --arch
```
### 8. Check your os name
To get your os name, use the `--name` flag.
```bash
node-peruse --name
```
### 9. Analyze project dependencies
Use the `--dependencies` option to analyze and list all dependencies in your project.
```bash
node-peruse --dependencies
```
## Using Node-Peruse with npx
To run Node-Peruse without installing it globally, users can simply use:
```bash
npx node-peruse [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](./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](https://github.com/sponsors/shivam-sharma7)