Skip to content

npm-license-tracker will track all the npm dependencies and their corresponding licenses. The module will generate the JSON file with all meta information about npm packages and copy corresponding license files.

License

Notifications You must be signed in to change notification settings

amittkSharma/npm-license-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npm-license-tracker

npm-license-tracker will track all the npm dependencies and their corrosponding licenses in the specified package. The module will generate the JSON file with all meta information about npm packages and copy corrosponding license files in a directory named "npm_licenses". This new folder will be created under the same project directory.

#Features

  • Creation of JSON file with meta information about licenses
  • Copying license files
  • Creation of CSV file with meta information for Audit purpose
  • Find Immediate and transitive dependencies

Updates

Date Author Description
2018-03-15 AmittK Module capable to find immediate or transitive dependencies.
2017-09-24 AmittK Module to track npm dependencies with all meta information and license files.

Installing via Npm

npm install -g npm-license-tracker

Usage

  • Install the module using: npm install -g npm-license-tracker
  • On command line, execute the command: npm-tracker "Path to package.json"
  • To generate CSV, execute the command: npm-tracker "Path to package.json" true || false (default value is false )

Api Usage

npm install npm-license-tracker
var licenseChecker = require('npm-license-tracker/src');
var options = {
  path: 'C:\\Workspace\\DEMO_PROJECT',
  isExcel: true
}
licenseChecker.run(options)
API Type Description
path string Path to package.json in the project
isExcel boolean For generating CSV file, default value is false

Example of license JSON so produced by app

Alt text

Command line help

npm-license-tracker --help

License

MIT

About

npm-license-tracker will track all the npm dependencies and their corresponding licenses. The module will generate the JSON file with all meta information about npm packages and copy corresponding license files.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published