li

libs-inspector

A UI report of all dependencies in your package.json with their description and suggestions for upgrade

Showing:

Popularity

Downloads/wk

73

GitHub Stars

28

Maintenance

Last Commit

11d ago

Contributors

2

Package

Dependencies

2

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

libs-inspector

Current Version GitHub Stars MIT license

What is it

This is a UI report of all dependencies in your package.json with their description and suggestions for upgrade

Demo

Here is the running demo of generated libs-inspector report: alt text

Install

npm install --save-dev libs-inspector

Usage

  1. open your project's root folder
  2. run in the terminal: libs-inspector
  3. a new folder will be generated in project's root: libs-inspector-report
  4. open it's index.html

Tips for automated usage:

  1. add new npm script to your package.json file, that will call libs-inspector library. E.g:
"scripts": {
   "generate:lib-report": "libs-inspector"
}
  1. You can run this script whenever you want in your CI, but better - to add it to postinstall script. E.g:
"scripts": {
   "postinstall": "npm run generate:lib-report"
}

Each time you setup a project and install dependencies, the report will be automatically generated

Details of realisation

  • The report generates 2 tables: dependencies and devDependencies
  • If your project doesn't have devDependencies, then it will be written in empty block
  • Information for each dependency is being retrieved from: https://npms.io
  • If the dependency info couldn't be got from npms.io, then the row is highlighted in red
  • When package version can be updated to new major version, its cell is highlighted
  • If dependency is being duplicated in devDependencies, then the row is highlighted in red

Next features to come

  • vulnerabilities check
  • configuration file for excluding specific libs

License

You can check out the full license here

This project is licensed under the terms of the MIT license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100