JoshuaKGoldbergeslint-plugin-package-json
Rules for consistent, readable, and valid package.json files. ๐๏ธ
Installation
This package requires ESLint >=8:
npm install eslint eslint-plugin-package-json --save-dev
Usage
Flat Config
This plugin's recommended configuration enables its rules on **/package.json files, parsing them with jsonc-eslint-parser.
In your ESLint configuration file:
import packageJson from "eslint-plugin-package-json";
export default [
// your other ESLint configurations
packageJson.configs.recommended,
];
If you want to override the recommended rules:
import packageJson from "eslint-plugin-package-json";
export default [
// your other ESLint configurations
packageJson.configs.recommended,
{
rules: {
"package-json/valid-package-definition": "off",
},
},
];
See ESLint's Configuration Files guide for details on how to customize your rules and other config settings.
Legacy Config
Usage with ESLint's legacy ("eslintrc") format requires also installing jsonc-eslint-parser:
npm install jsonc-eslint-parser --save-dev
Add an override to your ESLint configuration file that specifies jsonc-eslint-parser, this plugin, and its recommended rules for your package.json file:
module.exports = {
overrides: [
{
extends: ["plugin:package-json/legacy-recommended"],
files: ["package.json"],
parser: "jsonc-eslint-parser",
},
],
};
You may also want to individually configure rules. See ESLint's Configure Rules guide for details on how to customize your rules.
module.exports = {
overrides: [
{
extends: ["plugin:package-json/legacy-recommended"],
files: ["package.json"],
parser: "jsonc-eslint-parser",
rules: {
"package-json/valid-package-definition": "error",
},
},
],
};
Usage Alongside Prettier
prettier-plugin-packagejson is a Prettier plugin that enforces the same package.json keys ordering as the order-properties and sort-collections rules with default options.
We recommend using both the Prettier plugin and eslint-plugin-package-json's recommended configuration.
The default settings don't conflict, and Prettier plugins can quickly fix up ordering in your editor on save and/or as a Git hook.
Supported Rules
๐ผ Configurations enabled in.\
โ๏ธ Set in the legacy-recommended configuration.\
โ
Set in the recommended configuration.\
๐ง Automatically fixable by the --fix CLI option.\
๐ก Manually fixable by editor suggestions.\
โ Deprecated.
| Name | Description | ๐ผ | ๐ง | ๐ก | โ |
|---|---|---|---|---|---|
| no-empty-fields | Reports on unnecessary empty arrays and objects. | โ๏ธ โ | ๐ก | ||
| no-redundant-files | Prevents adding unnecessary / redundant files. | ๐ก | |||
| order-properties | Package properties must be declared in standard order | โ๏ธ โ | ๐ง | ||
| repository-shorthand | Enforce either object or shorthand declaration for repository. | โ๏ธ โ | ๐ง | ||
| require-author | Requires the author property to be present. |
||||
| require-description | Requires the description property to be present. |
โ๏ธ โ | |||
| require-engines | Requires the engines property to be present. |
||||
| require-files | Requires the files property to be present. |
||||
| require-keywords | Requires the keywords property to be present. |
||||
| require-name | Requires the name property to be present. |
โ๏ธ โ | |||
| require-types | Requires the types property to be present. |
||||
| require-version | Requires the version property to be present. |
โ๏ธ โ | |||
| restrict-dependency-ranges | Restricts the range of dependencies to allow or disallow specific types of ranges. | ๐ก | |||
| sort-collections | Dependencies, scripts, and configuration values must be declared in alphabetical order. | โ๏ธ โ | ๐ง | ||
| unique-dependencies | Checks a dependency isn't specified more than once (i.e. in dependencies and devDependencies) |
โ๏ธ โ | ๐ก | ||
| valid-local-dependency | Checks existence of local dependencies in the package.json | โ๏ธ โ | |||
| valid-name | Enforce that package names are valid npm package names | โ๏ธ โ | |||
| valid-package-def | Enforce that package.json has all properties required by the npm spec | โ | |||
| valid-package-definition | Enforce that package.json has all properties required by the npm spec | โ๏ธ โ | |||
| valid-repository-directory | Enforce that if repository directory is specified, it matches the path to the package.json file | โ๏ธ โ | ๐ก | ||
| valid-version | Enforce that package versions are valid semver specifiers | โ๏ธ โ |
These rules only run on package.json files; they will ignore all other files being linted.
They can lint package.json files at project root and in any subfolder of the project, making this plugin great for monorepos.
Development
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! ๐
Contributors
Appreciation
Many thanks to @zetlen for creating the initial version and core infrastructure of this package! ๐
๐ This package was templated with
create-typescript-appusing the Bingo engine.