# npm-janitor

> Validate package.json for all the user modules

Latest version **1.0.1** (published 2015-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-janitor
pnpm add npm-janitor
yarn add npm-janitor
bun add npm-janitor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-09-29 |
| First published | 2015-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Hemanth.HM |
| Maintainers | hemanth |

## Links

- npm: https://www.npmjs.com/package/npm-janitor
- Repository: https://github.com/hemanth/node-npm-janitor
- Homepage: https://github.com/hemanth/node-npm-janitor#readme
- Issues: https://github.com/hemanth/node-npm-janitor/issues
- npm.io page: https://npm.io/package/npm-janitor

## Dependencies (4)

- [async](https://npm.io/package/async.md) ^1.4.2
- [npm-stats](https://npm.io/package/npm-stats.md) ^1.1.0
- [package-json](https://npm.io/package/package-json.md) ^1.2.0
- [package-json-validator](https://npm.io/package/package-json-validator.md) ^0.6.0

## Recent versions

- 1.0.1 (latest) — 2015-09-29
- 1.0.0 — 2015-09-29
- 0.0.0 — 2015-09-26

## README

# npm-janitor [![Build Status](https://travis-ci.org/hemanth/node-npm-janitor.svg?branch=master)](https://travis-ci.org/hemanth/node-npm-janitor)

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


## Install

```sh
$ npm install --save npm-janitor
```


## Usage

```js
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](http://h3manth.com)

---
_Source: https://npm.io/package/npm-janitor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._