npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

npm-license-crawler

v0.2.1

Published

Analyzes license information for multiple node.js modules (package.json files) as part of your software project.

Downloads

85,332

Readme

NPM License Crawler

npm version Greenkeeper badge

NPM License Crawler is a wrapper around license-checker to analyze several node packages (package.json files) as part of your software project. This way, it is possible to create a list of third party licenses for your software project in one go. File paths containing ".git" or "node_modules" are ignored at the stage where 'package.json' files are matched to provide the entry points to calling license-checker.

Contributions

If you like npm-license-crawler, please consider ★ starring the project on github. Contributions to the project are welcome. You can simply fork the project and create a pull request with your contribution to start with.

Installation

Use global installation to be able to run npm-license-crawler from the command line.

npm i npm-license-crawler -g

Options

  • --start directory-path: path to the directory the license search should start from. If omitted the current working directory is assumed.

  • --exclude directory-path: path to a directory to be excluded (and its subdirectories) from the search.

  • --unknown: show only licenses that can't be determined or have been guessed.

  • --dependencies: show only third-party licenses, i.e., only list the dependencies defined in package.json.

  • --production: show only production dependencies

  • --development: show only development dependencies

  • --onlyDirectDependencies: show only direct dependencies licenses, i.e., don't list dependencies of dependencies.

  • --omitVersion: omit version numbers in result (e.g. "[email protected]" becomes "npm-license-crawler")

  • --no-color: (or --no-color) don't show colors in the console output

  • --relativeLicensePath: output the relative file path for license files.

  • --json /path/to/save.json: export data as JSON to the given file. The path will be created if it does not exist.

  • --csv /path/to/save.csv: export the data as comma-separated values to the given file. The path will be created if it does not exist.

Example

Called from the npm-license-crawler installation directory. If called in another directory make sure the given exclude path exists (or omit the --exclude option and argument).

npm-license-crawler  --exclude ./lib --dependencies --csv licenses.csv

Using npm-license-crawler API

See the following example.

var crawler = require('npm-license-crawler'),
    options = {
        start: ['../..'],
        exclude: ['.'],
        json: 'licenses.json',
        unknown: true
    };

crawler.dumpLicenses(options,
    function(error, res){
        if (error) {
            console.error("Error:", error);
        }
        else {
            console.dir(res);
        }
    }
);

History

See Release History.

Build Status

Build Status