README.md

@wordpress/npm-package-json-lint-config

WordPress npm-package-json-lint shareable config

Installation

Install the module

$ npm install @wordpress/npm-package-json-lint-config

Usage

Add this to your package.json file:

"npmPackageJsonLintConfig": {
	"extends": "@wordpress/npm-package-json-lint-config",
},

Or to a .npmpackagejsonlintrc.json file in the root of your repo:

{
	"extends": "@wordpress/npm-package-json-lint-config",
}

To add, modify, or override any npm-package-json-lint rules add this to your package.json file:

"npmPackageJsonLintConfig": {
	"extends": "@wordpress/npm-package-json-lint-config",
	"rules": {
		"valid-values-author": [
			"error",
			[
				"WordPress"
			]
		]
	}
},

Or to a .npmpackagejsonlintrc.json file in the root of your repo:

{
	"extends": "@wordpress/npm-package-json-lint-config",
	"rules": {
		"require-publishConfig": "error",
		"valid-values-author": [
			"error",
			[
				"WordPress"
			]
		]
	}
}