https://github.com/zont/nlfa

nlaf is a utility for attempting to identify the licenses and author of modules in a node.js project.
https://github.com/zont/nlfa

Last synced: 5 days ago
JSON representation

nlaf is a utility for attempting to identify the licenses and author of modules in a node.js project.

• Host: GitHub
• URL: https://github.com/zont/nlfa
• Owner: zont
• License: mit
• Created: 2019-05-14T07:54:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-14T13:16:58.000Z (over 5 years ago)
• Last Synced: 2024-09-21T23:30:00.996Z (about 2 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - zont/nlfa - nlaf is a utility for attempting to identify the licenses and author of modules in a node.js project. (others)

README

        
# nlfa

[!['Build status'][travis_image_url]][travis_page_url]

[travis_image_url]: https://api.travis-ci.org/zont/nlfa.svg

[travis_page_url]: https://travis-ci.org/zont/nlfa

nlfa is a utility for attempting to identify the licenses and author of modules in a nodejs project.

It looks for license information in package.json, readme and license files in the project.

Please note, in many cases the utility is looking for standard strings in these files, such as MIT, BSD, Apache,

GPL etc - this is not error free, so if you have any concerns at all about the accuracy of the results, you will

need to perform a detailed manual review of the project and its dependencies, reading all terms of any included

or referenced license.

## Install

```sh

npm i -D nlfa

```

## Use

```sh

nlfa [options] 

options:

  - `-p`, `--production` (Default: false) - exclude devDependencies

  - `-j`, `--json` (Default: false) - output in JSON

 is `licenses.csv` or `licenses.json` by default

```

Example:

```sh

nlfa -p licenses-with-authors.csv

```