eslint-plugin-package-json 0.81.0 → 0.83.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-# [0.81.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.80.0...v0.81.0) (2025-11-17)
+# [0.83.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.82.0...v0.83.0) (2025-11-17)
+
+
+### Features
+
+* **specify-peers-locally:** add rule to require all peers are declared as dev dependencies ([#1407](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1407)) ([5a102ec](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/5a102ecd0f6fb025f42e838492844e2fa32ba786)), closes [#1053](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1053)
 
+# [0.82.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.81.0...v0.82.0) (2025-11-17)
+
+### Features
+
+- **require-sideEffects:** add new rule for requiring `sideEffects` ([#1406](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1406)) ([0a8388d](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0a8388d6be21e6d4d7c0203fd65be96751ca5f29)), closes [#1405](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1405)
+
+# [0.81.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.80.0...v0.81.0) (2025-11-17)
 
 ### Features
 
-* **require-attribution:** add new rule to require proper attribution ([#1408](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1408)) ([e646f94](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/e646f941bfc8ac2e4cb7c28509a8bd800b912442)), closes [#1404](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1404)
+- **require-attribution:** add new rule to require proper attribution ([#1408](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1408)) ([e646f94](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/e646f941bfc8ac2e4cb7c28509a8bd800b912442)), closes [#1404](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1404)
 
 # [0.80.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.79.0...v0.80.0) (2025-11-17)
 

package/README.md

@@ -205,6 +205,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [require-name](docs/rules/require-name.md)                                 | Requires the `name` property to be present.                                                                                                                                                  | ✔️ ✅ |    |    |    |
 | [require-optionalDependencies](docs/rules/require-optionalDependencies.md) | Requires the `optionalDependencies` property to be present.                                                                                                                                  |      |    |    |    |
 | [require-peerDependencies](docs/rules/require-peerDependencies.md)         | Requires the `peerDependencies` property to be present.                                                                                                                                      |      |    |    |    |
+| [require-sideEffects](docs/rules/require-sideEffects.md)                   | Requires the `sideEffects` property to be present.                                                                                                                                           |      |    |    |    |
 | [require-type](docs/rules/require-type.md)                                 | Requires the `type` property to be present.                                                                                                                                                  | ✔️ ✅ |    |    |    |
 | [require-types](docs/rules/require-types.md)                               | Requires the `types` property to be present.                                                                                                                                                 |      |    |    |    |
 | [require-version](docs/rules/require-version.md)                           | Requires the `version` property to be present.                                                                                                                                               | ✔️ ✅ |    |    |    |
@@ -212,6 +213,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [restrict-private-properties](docs/rules/restrict-private-properties.md)   | Disallows unnecessary properties in private packages.                                                                                                                                        |      | 🔧 | 💡 |    |
 | [scripts-name-casing](docs/rules/scripts-name-casing.md)                   | Enforce that names for `scripts` are in kebab case (optionally separated by colons).                                                                                                         | 🎨   |    | 💡 |    |
 | [sort-collections](docs/rules/sort-collections.md)                         | Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts).                                                                                  | ✔️ ✅ | 🔧 |    |    |
+| [specify-peers-locally](docs/rules/specify-peers-locally.md)               | Requires that all peer dependencies are also declared as dev dependencies                                                                                                                    | ✔️ ✅ |    | 💡 |    |
 | [unique-dependencies](docs/rules/unique-dependencies.md)                   | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`)                                                                                            | ✔️ ✅ |    | 💡 |    |
 | [valid-author](docs/rules/valid-author.md)                                 | Enforce that the `author` property is valid.                                                                                                                                                 | ✔️ ✅ |    |    |    |
 | [valid-bin](docs/rules/valid-bin.md)                                       | Enforce that the `bin` property is valid.                                                                                                                                                    | ✔️ ✅ |    |    |    |

package/lib/plugin.mjs

@@ -11,13 +11,14 @@ import { rule as rule$8 } from "./rules/restrict-dependency-ranges.mjs";
 import { rule as rule$9 } from "./rules/restrict-private-properties.mjs";
 import { rule as rule$10 } from "./rules/scripts-name-casing.mjs";
 import { rule as rule$11 } from "./rules/sort-collections.mjs";
-import { rule as rule$12 } from "./rules/unique-dependencies.mjs";
-import { rule as rule$13 } from "./rules/valid-local-dependency.mjs";
-import { rule as rule$14 } from "./rules/valid-name.mjs";
-import { rule as rule$15 } from "./rules/valid-package-definition.mjs";
+import { rule as rule$12 } from "./rules/specify-peers-locally.mjs";
+import { rule as rule$13 } from "./rules/unique-dependencies.mjs";
+import { rule as rule$14 } from "./rules/valid-local-dependency.mjs";
+import { rule as rule$15 } from "./rules/valid-name.mjs";
+import { rule as rule$16 } from "./rules/valid-package-definition.mjs";
 import { rules as rules$1 } from "./rules/valid-properties.mjs";
-import { rule as rule$16 } from "./rules/valid-repository-directory.mjs";
-import { rule as rule$17 } from "./rules/valid-version.mjs";
+import { rule as rule$17 } from "./rules/valid-repository-directory.mjs";
+import { rule as rule$18 } from "./rules/valid-version.mjs";
 import { createRequire } from "node:module";
 import * as parserJsonc from "jsonc-eslint-parser";
 
@@ -37,16 +38,17 @@ const rules$2 = {
 	"restrict-private-properties": rule$9,
 	"scripts-name-casing": rule$10,
 	"sort-collections": rule$11,
-	"unique-dependencies": rule$12,
+	"specify-peers-locally": rule$12,
+	"unique-dependencies": rule$13,
 	...rules$1,
-	"valid-local-dependency": rule$13,
-	"valid-name": rule$14,
-	"valid-package-definition": rule$15,
-	"valid-repository-directory": rule$16,
-	"valid-version": rule$17
+	"valid-local-dependency": rule$14,
+	"valid-name": rule$15,
+	"valid-package-definition": rule$16,
+	"valid-repository-directory": rule$17,
+	"valid-version": rule$18
 };
-const recommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$18]) => rule$18.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
-const stylisticRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$18]) => rule$18.meta.docs?.category === "Stylistic").map(([name$1]) => ["package-json/" + name$1, "error"])) };
+const recommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$19]) => rule$19.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
+const stylisticRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$19]) => rule$19.meta.docs?.category === "Stylistic").map(([name$1]) => ["package-json/" + name$1, "error"])) };
 const plugin = {
 	configs: {
 		"legacy-recommended": {

package/lib/rules/require-properties.mjs

@@ -22,6 +22,7 @@ const properties = [
 	}],
 	["optionalDependencies"],
 	["peerDependencies"],
+	["sideEffects"],
 	["type", { isRecommended: true }],
 	["types"],
 	["version", {

package/lib/rules/specify-peers-locally.d.mts

@@ -0,0 +1,6 @@
+import { PackageJsonRuleModule } from "../createRule.mjs";
+
+//#region src/rules/specify-peers-locally.d.ts
+declare const rule: PackageJsonRuleModule<[], []>;
+//#endregion
+export { rule };

package/lib/rules/specify-peers-locally.mjs

@@ -0,0 +1,65 @@
+import { createRule } from "../createRule.mjs";
+import { isJSONStringLiteral } from "../utils/predicates.mjs";
+
+//#region src/rules/specify-peers-locally.ts
+const rule = createRule({
+	create(context) {
+		const devDependencyNames = /* @__PURE__ */ new Set();
+		let devDependenciesObjectNode;
+		const peerDependencyMap = {};
+		return {
+			"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression][key.value=devDependencies]"(node) {
+				devDependenciesObjectNode = node.value;
+				for (const devDependencyPropertyNode of node.value.properties) {
+					const dependencyKey = devDependencyPropertyNode.key;
+					if (isJSONStringLiteral(dependencyKey)) devDependencyNames.add(dependencyKey.value);
+				}
+			},
+			"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression][key.value=peerDependencies]"(node) {
+				for (const peerDependencyPropertyNode of node.value.properties) {
+					const dependencyKey = peerDependencyPropertyNode.key;
+					if (isJSONStringLiteral(dependencyKey)) peerDependencyMap[dependencyKey.value] = peerDependencyPropertyNode;
+				}
+			},
+			"Program:exit"() {
+				for (const [peerDependencyName, peerDependencyNode] of Object.entries(peerDependencyMap)) if (!devDependencyNames.has(peerDependencyName)) {
+					const peerDependencyValue = peerDependencyNode.value;
+					context.report({
+						data: { name: peerDependencyName },
+						messageId: "devDependencyNotDefined",
+						node: peerDependencyNode,
+						suggest: devDependenciesObjectNode && isJSONStringLiteral(peerDependencyValue) ? [{
+							data: { name: peerDependencyName },
+							fix: (fixer) => {
+								const updatedDevDependencies = {
+									...JSON.parse(context.sourceCode.getText(devDependenciesObjectNode)),
+									[peerDependencyName]: peerDependencyValue.value
+								};
+								const sortedDevDependencies = Object.fromEntries(Object.entries(updatedDevDependencies).sort((a, b) => a[0] > b[0] ? 1 : -1));
+								return fixer.replaceText(devDependenciesObjectNode, JSON.stringify(sortedDevDependencies, null, 2).split("\n").join("\n  "));
+							},
+							messageId: "addToDevDependencies"
+						}] : []
+					});
+				}
+			}
+		};
+	},
+	meta: {
+		docs: {
+			description: "Requires that all peer dependencies are also declared as dev dependencies",
+			recommended: true
+		},
+		hasSuggestions: true,
+		messages: {
+			addToDevDependencies: "Add \"{{ name }}\" to `devDependencies`",
+			devDependencyNotDefined: "Peer dependency \"{{ name }}\" is not also declared in `devDependencies`."
+		},
+		schema: [],
+		type: "problem"
+	},
+	name: "specify-peers-locally"
+});
+
+//#endregion
+export { rule };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.81.0",
+	"version": "0.83.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {