nitpick

A command line tool to make you feel bad about how you set up your app.

Install

$ npm i -g nitpick

Usage

In your project's root directory, simply run:

$ nitpick

Options

• --disable-colors (-d): Disable beatiful colors, will happen automatically in terminals that can't handle color;
• --explain (-e): Provide an explanation on how to fix an error, note: will not work with --quiet;
• --quiet (-q): Run silently, will throw error if necessary;

Ignoring rules

In package.json, add a nitpick key:

{
    ...
    "nitpick": {
        "ignore": [
            <rules>
        ]
    }
    ...
}

The identifiers are:

package.json
README.md
.gitignore
.editorconfig
.eslintrc
.eslintignore
.babelrc
LICENSE
.travis.yml

Aliases

Some packages can be used in different ways, such as including Babel options in your package.json file. Current valid filename aliases are as follows:

README.md
└─readme.md
└─README
.eslintrc
└─.eslintrc.json
└─.eslintrc.yml
.eslintignore
└─.eslintignore.json
└─.eslintignore.yml
.babelrc
└─.babelrc.json
└─.babelrc.yml
LICENSE
└─license.md
└─LICENSE.md

Current files with package.json support:

• .eslintrc -> "eslint"
• .babelrc -> "babel"
• LICENSE -> "license"

License

MIT © Connor Wilson