Repository files navigation

Rules for consistent, readable, and valid package.json files. 🗂️

This package requiresESLint 8 andjsonc-eslint-parser:

npm install eslint eslint-plugin-package-json jsonc-eslint-parser --save-dev

This plugin's recommended configuration enables its rules on**/package.json files, parsing them withjsonc-eslint-parser:

In your ESLint configuration file:

importpackageJsonfrom"eslint-plugin-package-json/configs/recommended";exportdefault[// your other ESLint configurationspackageJson,];

If you want to override the recommended rules:

importpackageJsonfrom"eslint-plugin-package-json/configs/recommended";exportdefault[// your other ESLint configurations{...packageJson,rules:{...packageJson.rules,"package-json/valid-package-def":"off",},},];

SeeESLint'sConfiguration Files guide for details on how to customize your rules and other config settings.

Add an override to your ESLint configuration file that specifies this plugin,jsonc-eslint-parser, and its recommended rules for yourpackage.json file:

module.exports={overrides:[{extends:["plugin:package-json/recommended"],files:["package.json"],parser:"jsonc-eslint-parser",plugins:["package-json"],},],};

You may also want to individually configure rules.SeeESLint'sConfigure Rules guide for details on how to customize your rules.

module.exports={overrides:[{extends:["plugin:package-json/recommended"],files:["package.json"],parser:"jsonc-eslint-parser",plugins:["package-json"],rules:{"package-json/valid-package-def":"error",},},],};

prettier-plugin-packagejson is aPrettier plugin that enforces the samepackage.json keys ordering as theorder-properties andsort-collections rules with default options.We recommend using both the Prettier plugin andeslint-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.

💼 Configurations enabled in.
✅ Set in therecommended configuration.
🔧 Automatically fixable by the--fix CLI option.
💡 Manually fixable byeditor suggestions.

These rules only run onpackage.json files; they will ignore all other files being linted.They can lintpackage.json files at project root and in any subfolder of the project, making this plugin great for monorepos.

Alan 🐛💻	Andreas Lindberg 🐛	Anton Khitrenovich 🤔	Azat S. 🤔💻	James 💻	James Zetlen 💻🐛📖🚇🚧🔧	Jesús Leganés-Combarro 💻
Josh Goldberg ✨ 🔧🐛💻🚇📖🚧🤔	Kendall Gassner 💻🚧	Kristjan ESPERANTO 🤔🐛💻	Nick Schonning 💻	Stephen 💻	Stephen Zhou 🐛💻🤔📖	Yosuke Ota 🐛💻
b3rnhard 🐛

Many thanks to@zetlen for creating the initial version and core infrastructure of this package! 💖

💙 This package was templated withcreate-typescript-app.