Skip to content

tclindner/npm-package-json-lint-config-tc

Repository files navigation

npm-package-json-lint-config-tc

npm-package-json-lint shareable config for TC's projects

license npm ci Dependency Status devDependency Status

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

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

Command

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

Usage

Add the following to your .npmpackagejsonlintrc.json file:

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

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-tc",
  "rules": {
    "license-type": "off"
  }
}

Contributing

Please see CONTRIBUTING.md.

Release History

Please see CHANGELOG.md.

License

Copyright (c) 2017-2023 Thomas Lindner. Licensed under the MIT license.