No description

JavaScript 100%

Find a file

dependabot[bot] 45dbb06d8f Bump jest from 27.5.0 to 27.5.1 (#249 )		2022-02-08 14:37:50 -06:00
.github	Bump actions/setup-node from 2.5.0 to 2.5.1 (#245 )	2021-12-29 09:06:51 -06:00
test	Bump deps (#19 )	2019-10-06 15:21:56 -05:00
.editorconfig	1.0.0 (#1 )	2017-02-18 19:24:14 -06:00
.eslintrc.json	1.0.0 (#1 )	2017-02-18 19:24:14 -06:00
.gitattributes	1.0.0 (#1 )	2017-02-18 19:24:14 -06:00
.gitignore	1.0.0 (#1 )	2017-02-18 19:24:14 -06:00
.npmpackagejsonlintrc.json	1.0.0 (#1 )	2017-02-18 19:24:14 -06:00
CHANGELOG.md	Update deps (#38 )	2019-12-06 19:30:14 -06:00
CONTRIBUTING.md	v3.0.0 (#71 )	2020-04-12 11:29:19 -05:00
index.js	v3.0.0 (#71 )	2020-04-12 11:29:19 -05:00
LICENSE	Update LICENSE	2022-01-14 15:54:30 -06:00
package-lock.json	Bump jest from 27.5.0 to 27.5.1 (#249 )	2022-02-08 14:37:50 -06:00
package.json	Bump jest from 27.5.0 to 27.5.1 (#249 )	2022-02-08 14:37:50 -06:00
README.md	Update README.md	2022-01-14 15:54:22 -06:00

README.md

npm-package-json-lint-config-default

Default npm-package-json-lint shareable config

What is npm-package-json-lint-config-default?

Shared configuration for npm-package-json-lint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file.

How do I install it?

First thing first, let's make sure you have the necessary pre-requisites.

System Dependencies

Node

Node.js - v10.0.0+
npm - v6.0.0+

Command

npm install npm-package-json-lint-config-default --save-dev

Usage

Add the following to your .npmpackagejsonlintrc.json file:

{
  "extends": "npm-package-json-lint-config-default"
}

If you need to override a rule, your .npmpackagejsonlintrc.json file should look like the example below. All shared rules will be used, but license-type will be turned off.

{
  "extends": "npm-package-json-lint-config-default",
  "rules": {
    "license-type": "off"
  }
}