Skip to content

npm-janitor/node-npm-janitor

Repository files navigation

npm-janitor Build Status

Validates package.json for all the user modules.

Install

$ npm install --save npm-janitor

Usage

var npmJanitor = require('npm-janitor');

npmJanitor('hemanth', function(err, data){
  if(!err) console.log(data);
});

// data would be array of objects that look like:

/*
{ module: 'an-async',
  homepage: 'https://github.com/hemanth/node-an-async',
  info: 
   { valid: true,
     warnings: [ 'Missing recommended field: contributors' ],
     recommendations: 
      [ 'Missing optional field: dependencies',
        'Missing optional field: engines' ] } }
*/

TODO

  • Promisifiy stuff?

License

MIT © Hemanth.HM

About

Validates `package.json` for all the user modules.

Resources

License

Stars

Watchers

Forks

Packages

No packages published