eslint-plugin-package-json

<h1 align="center">eslint-plugin-package-json</h1> <p align="center">用于保持一致、可读性和有效性的package.json文件规则。🗂️</p> <p align="center"> <a href="#contributors" target="_blank"> <!-- prettier-ignore-start --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <img alt="所有贡献者：15 👪" src="https://yellow-cdn.veclightyear.com/835a84d5/31fe7c86-cddb-4592-a11a-40e74f6ea9d8.svg" /> <!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- prettier-ignore-end --> </a> <a href="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json" target="_blank"><img alt="Codecov 测试覆盖率" src="https://yellow-cdn.veclightyear.com/835a84d5/eb267c4a-bb8e-4b70-8c80-61de7b16cc0a.svg"/></a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="贡献者公约" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/LICENSE.md" target="_blank"><img alt="许可证：MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/eslint-plugin-package-json?color=21bb42"></a> <img alt="代码风格：Prettier" src="https://yellow-cdn.veclightyear.com/835a84d5/3a9f73bb-ff06-430c-8fdc-e1d1c829b84b.svg" /> <a href="https://www.npmjs.com/package/eslint-plugin-package-json"><img alt="npm包版本" src="https://img.shields.io/npm/v/eslint-plugin-package-json?color=21bb42" /></a> </p>

安装

本插件需要 ESLint 8 和 jsonc-eslint-parser：

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

使用方法

扁平配置

本插件的推荐配置会在 **/package.json 文件上启用其规则，并使用 jsonc-eslint-parser 解析它们：

在你的 ESLint 配置文件中：

import packageJson from "eslint-plugin-package-json/configs/recommended";

export default [
	// 你的其他 ESLint 配置
	packageJson,
];

如果你想覆盖推荐的规则：

import packageJson from "eslint-plugin-package-json/configs/recommended";

export default [
	// 你的其他 ESLint 配置
	{
		...packageJson,
		rules: {
			...packageJson.rules,
			"package-json/valid-package-def": "off",
		},
	},
];

有关如何自定义规则和其他配置设置的详细信息，请参阅 ESLint 的《配置文件》指南。

传统配置

在你的 ESLint 配置文件中为 package.json 文件添加一个覆盖，指定本插件、jsonc-eslint-parser 以及其推荐规则：

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

你可能还想单独配置规则。有关如何自定义规则的详细信息，请参阅 ESLint 的《配置规则》指南。

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 一起使用

prettier-plugin-packagejson 是一个 Prettier 插件，它强制执行与默认选项下的 order-properties 和 sort-collections 规则相同的 package.json 键排序。我们建议同时使用 Prettier 插件和 eslint-plugin-package-json 的推荐配置。默认设置不会冲突，Prettier 插件可以在编辑器保存时和/或作为 Git 钩子快速修复排序。

支持的规则

<!-- prettier-ignore-start --> <!-- begin auto-generated rules list -->

💼 表示在配置中启用。
✅ 表示在 recommended 配置中设置。
🔧 表示可通过 --fix CLI 选项 自动修复。
💡 表示可通过 编辑器建议 手动修复。

名称	描述	💼	🔧	💡
order-properties	包属性必须按标准顺序声明	✅	🔧
repository-shorthand	强制使用对象或简写方式声明仓库	✅	🔧
sort-collections	依赖项、脚本和配置值必须按字母顺序声明	✅	🔧
unique-dependencies	确保如果指定了仓库目录，它与package.json文件的路径匹配	✅		💡
valid-local-dependency	检查package.json中本地依赖项的存在性	✅
valid-name	强制包名为有效的npm包名	✅
valid-package-def	确保package.json包含npm规范要求的所有属性	✅
valid-repository-directory	确保如果指定了仓库目录，它与package.json文件的路径匹配	✅		💡
valid-version	强制包版本为有效的语义化版本规范	✅

这些规则仅在package.json文件上运行；它们将忽略所有其他被检查的文件。 它们可以检查项目根目录和项目任何子文件夹中的package.json文件，使得这个插件非常适合单体仓库。

贡献者

<!-- spellchecker: disable --> <!-- ALL-CONTRIBUTORS-LIST:START - 请勿删除或修改此部分 --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://alan.norbauer.com"><img src="https://avatars.githubusercontent.com/u/1009?v=4?s=100" width="100px;" alt="Alan"/><br />_<b>Alan</b></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aaltano" title="Bug报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=altano" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/AndreasLindbergPAF"><img src="https://avatars.githubusercontent.com/u/59874563?v=4?s=100" width="100px;" alt="Andreas Lindberg"/><br />_{<b>Andreas Lindberg</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aandreaslindbergpaf" title="Bug报告">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="http://technotes.khitrenovich.com/"><img src="https://avatars.githubusercontent.com/u/3424762?v=4?s=100" width="100px;" alt="Anton Khitrenovich"/><br />_{<b>Anton Khitrenovich</b>}</a><br /><a href="#ideas-khitrenovich" title="想法、规划与反馈">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://azat.io"><img src="https://avatars.githubusercontent.com/u/5698350?v=4?s=100" width="100px;" alt="Azat S."/><br />_{<b>Azat S.</b>}</a><br /><a href="#ideas-azat-io" title="想法、规划与反馈">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=azat-io" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zamiell"><img src="https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width="100px;" alt="James"/><br />_<b>James</b></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=Zamiell" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/zetlen"><img src="https://avatars.githubusercontent.com/u/1643758?v=4?s=100" width="100px;" alt="James Zetlen"/><br />_{<b>James Zetlen</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="代码">💻</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Azetlen" title="Bug报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="文档">📖</a> <a href="#infra-zetlen" title="基础设施（托管、构建工具等）">🚇</a> <a href="#maintenance-zetlen" title="维护">🚧</a> <a href="#tool-zetlen" title="工具">🔧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://piranna.github.io/"><img src="https://avatars.githubusercontent.com/u/532414?v=4?s=100" width="100px;" alt="Jesús Leganés-Combarro"/><br />_{<b>Jesús Leganés-Combarro</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=piranna" title="代码">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br />_{<b>Josh Goldberg ✨</b>}</a><br /><a href="#tool-JoshuaKGoldberg" title="工具">🔧</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3AJoshuaKGoldberg" title="Bug报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="代码">💻</a> <a href="#infra-JoshuaKGoldberg" title="基础设施（托管、构建工具等）">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="文档">📖</a> <a href="#maintenance-JoshuaKGoldberg" title="维护">🚧</a> <a href="#ideas-JoshuaKGoldberg" title="想法、规划与反馈">🤔</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kendallgassner"><img src="https://avatars.githubusercontent.com/u/15275462?v=4?s=100" width="100px;" alt="Kendall Gassner"/><br />_{<b>Kendall Gassner</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=kendallgassner" title="代码">💻</a> <a href="#maintenance-kendallgassner" title="维护">🚧</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/KristjanESPERANTO"><img src="https://avatars.githubusercontent.com/u/35647502?v=4?s=100" width="100px;" alt="Kristjan ESPERANTO"/><br />_{<b>Kristjan ESPERANTO</b>}</a><br /><a href="#ideas-kristjanesperanto" title="想法、规划与反馈">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Akristjanesperanto" title="错误报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=kristjanesperanto" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/nschonni"><img src="https://avatars.githubusercontent.com/u/1297909?v=4?s=100" width="100px;" alt="Nick Schonning"/><br />_{<b>Nick Schonning</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=nschonni" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/sirugh"><img src="https://avatars.githubusercontent.com/u/1278869?v=4?s=100" width="100px;" alt="Stephen"/><br />_{<b>Stephen</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=sirugh" title="代码">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://hyoban.cc"><img src="https://avatars.githubusercontent.com/u/38493346?v=4?s=100" width="100px;" alt="Stephen Zhou"/><br />_{<b>Stephen Zhou</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Ahyoban" title="错误报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=hyoban" title="代码">💻</a> <a href="#ideas-hyoban" title="想法、规划与反馈">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=hyoban" title="文档">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://ota-meshi.github.io/"><img src="https://avatars.githubusercontent.com/u/16508807?v=4?s=100" width="100px;" alt="Yosuke Ota"/><br />_{<b>Yosuke Ota</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aota-meshi" title="错误报告">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=ota-meshi" title="代码">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/b3rnhard"><img src="https://avatars.githubusercontent.com/u/10774404?v=4?s=100" width="100px;" alt="b3rnhard"/><br />_{<b>b3rnhard</b>}</a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Ab3rnhard" title="错误报告">🐛</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> <!-- spellchecker: enable -->

致谢

非常感谢 @zetlen 创建了这个包的初始版本和核心基础架构！💖

💙 本包是使用 create-typescript-app 模板创建的。