https://github.com/amittksharma/npm-license-tracker

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.
https://github.com/amittksharma/npm-license-tracker

javascript json license license-crawler license-csv license-management license-tracker npm npm-license-crawler npm-license-tracker npm-licenses npm-module npm-package npm-scripts opensource package-json tracker

Last synced: 4 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/amittksharma/npm-license-tracker
• Owner: amittkSharma
• License: mit
• Created: 2017-09-23T23:10:40.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T21:54:47.000Z (over 1 year ago)
• Last Synced: 2025-07-01T10:01:40.823Z (12 months ago)
• Topics: javascript, json, license, license-crawler, license-csv, license-management, license-tracker, npm, npm-license-crawler, npm-license-tracker, npm-licenses, npm-module, npm-package, npm-scripts, opensource, package-json, tracker
• Language: JavaScript
• Homepage:
• Size: 105 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# npm-license-tracker

[![](https://img.shields.io/npm/v/npm-license-tracker.svg)](https://www.npmjs.com/package/npm-license-tracker)

[![](https://img.shields.io/npm/dm/npm-license-tracker.svg)](https://www.npmjs.com/package/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

```

```js

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](https://github.com/amittkSharma/npm-license-tracker/blob/master/images/license_json.PNG?raw=true "npm packages meta information")

## Command line help

```

npm-license-tracker --help

```

## License

MIT