@inigomarquinez/npm-package-json-lint-config-default

[!NOTE] @inigomarquinez opinionated shareable configuration for npm-package-json-lint.

📖 Table of Contents

• Installation
• Documentation
• Custom rules
• Contributing
• Changelog
• License

📦 Installation

Install this package as a devDependencies in your project:

# npm
npm install @inigomarquinez/npm-package-json-lint-config-default --save-dev

# Yarn
yarn add @inigomarquinez/npm-package-json-lint-config-default --dev

After installing it, if a configuration file does not already exist, a .npmpackagejsonlintrc file will be created automatically in the project's root folder with the following configuration:

{
  "extends": [
    "@inigomarquinez/npm-package-json-lint-config-default"
  ]
}

📚 Documentation

Read the npm-package-json-lint docs for more information. You can find specific information about sharing configurations here.

📏 Custom rules

This library extends the configuration defined in npm-package-json-lint-config-default package and customizes the following rules:

Rule	Custom value
require-description	error
require-license	error
require-repository	error
no-repeated-dependencies	error
prefer-alphabetical-dependencies	error
prefer-alphabetical-devDependencies	error
prefer-alphabetical-bundledDependencies	error
prefer-alphabetical-optionalDependencies	error
prefer-alphabetical-peerDependencies	error
description-format	error
prefer-property-order	error
no-duplicate-properties	error

If you are extending this library but you need to override a rule to adapt it to your needs, your .npmpackagejsonlintrc file should look like the example below. In that example, all shared rules will be used, but description-format will be turned off:

{
  "extends": "@inigomarquinez/npm-package-json-lint-config-default",
  "rules": {
    "description-format": "off"
  }
}

🧩 Contributing

If you are interested in helping contribute, please open an issue or pull request.

📝 Changelog

See CHANGELOG for a human-readable history of changes.

©️ License

Distributed under the MIT License. See LICENSE for more information.