Giter VIP home page Giter VIP logo

licensewatch's Introduction

LicenseWatch

What is this?

This module reads the node_modules directory of a given path and fetches all licenses from reading each module's package.json and aggregates their counts into a hashmap object of licenses.

Implementation

Current implementation is with an Observable pattern so consumers need to add listeners to events the module emits.

Previous version of this module includes a Promises-based implementation and complete code coverage.

Installation

yarn add licensewatch

Usage

const LicenseWatch = require('licensewatch')
const licenses = new LicenseWatch('node_modules/**/package.json')

licenses.fetch()
let licensesCount = 0

licenses.on('files', (files) => {
  console.log('files processed' + ' - ' + files.length + ' - ' + files[0])
})

licenses.on('license', () => {
  licensesCount++
})

licenses.on('licenses', (licenses) => {
  console.log(licenses.length)
})

licenses.on('licensesSummary', (licenses) => {
  console.log(licenses)
})

licenses.on('error', (error) => {
  console.log('errors mate, from down under')
  console.log(error)
})

Tests

Project tests:

yarn run test

Project linting:

yarn run lint

Coverage

yarn run test:coverage

Commit

The project uses the commitizen tool for standardizing changelog style commit messages so you should follow it as so:

git add .           # add files to staging
npm run commit      # use the wizard for the commit message

licensewatch's People

Contributors

lirantal avatar bluzi avatar civan avatar

Stargazers

Roman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.