GitHub - tclindner/npm-package-json-lint-config-default: Default npm-package-json-lint shareable config (original) (raw)

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 - v18.0.0+
npm - v9.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" } }