eslint-plugin-package-json 0.82.0 → 0.83.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +8 -2
  2. package/README.md +1 -0
  3. package/lib/plugin.mjs +16 -14
  4. package/lib/rules/specify-peers-locally.d.mts +6 -0
  5. package/lib/rules/specify-peers-locally.mjs +65 -0
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,11 +1,17 @@
1
1
  # Changelog
2
2
 
3
- # [0.82.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.81.0...v0.82.0) (2025-11-17)
3
+ # [0.83.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.82.0...v0.83.0) (2025-11-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **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)
4
9
 
10
+ # [0.82.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.81.0...v0.82.0) (2025-11-17)
5
11
 
6
12
  ### Features
7
13
 
8
- * **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)
14
+ - **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)
9
15
 
10
16
  # [0.81.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.80.0...v0.81.0) (2025-11-17)
11
17
 
package/README.md CHANGED
@@ -213,6 +213,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
213
213
  | [restrict-private-properties](docs/rules/restrict-private-properties.md) | Disallows unnecessary properties in private packages. | | 🔧 | 💡 | |
214
214
  | [scripts-name-casing](docs/rules/scripts-name-casing.md) | Enforce that names for `scripts` are in kebab case (optionally separated by colons). | 🎨 | | 💡 | |
215
215
  | [sort-collections](docs/rules/sort-collections.md) | Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts). | ✔️ ✅ | 🔧 | | |
216
+ | [specify-peers-locally](docs/rules/specify-peers-locally.md) | Requires that all peer dependencies are also declared as dev dependencies | ✔️ ✅ | | 💡 | |
216
217
  | [unique-dependencies](docs/rules/unique-dependencies.md) | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`) | ✔️ ✅ | | 💡 | |
217
218
  | [valid-author](docs/rules/valid-author.md) | Enforce that the `author` property is valid. | ✔️ ✅ | | | |
218
219
  | [valid-bin](docs/rules/valid-bin.md) | Enforce that the `bin` property is valid. | ✔️ ✅ | | | |
package/lib/plugin.mjs CHANGED
@@ -11,13 +11,14 @@ import { rule as rule$8 } from "./rules/restrict-dependency-ranges.mjs";
11
11
  import { rule as rule$9 } from "./rules/restrict-private-properties.mjs";
12
12
  import { rule as rule$10 } from "./rules/scripts-name-casing.mjs";
13
13
  import { rule as rule$11 } from "./rules/sort-collections.mjs";
14
- import { rule as rule$12 } from "./rules/unique-dependencies.mjs";
15
- import { rule as rule$13 } from "./rules/valid-local-dependency.mjs";
16
- import { rule as rule$14 } from "./rules/valid-name.mjs";
17
- import { rule as rule$15 } from "./rules/valid-package-definition.mjs";
14
+ import { rule as rule$12 } from "./rules/specify-peers-locally.mjs";
15
+ import { rule as rule$13 } from "./rules/unique-dependencies.mjs";
16
+ import { rule as rule$14 } from "./rules/valid-local-dependency.mjs";
17
+ import { rule as rule$15 } from "./rules/valid-name.mjs";
18
+ import { rule as rule$16 } from "./rules/valid-package-definition.mjs";
18
19
  import { rules as rules$1 } from "./rules/valid-properties.mjs";
19
- import { rule as rule$16 } from "./rules/valid-repository-directory.mjs";
20
- import { rule as rule$17 } from "./rules/valid-version.mjs";
20
+ import { rule as rule$17 } from "./rules/valid-repository-directory.mjs";
21
+ import { rule as rule$18 } from "./rules/valid-version.mjs";
21
22
  import { createRequire } from "node:module";
22
23
  import * as parserJsonc from "jsonc-eslint-parser";
23
24
 
@@ -37,16 +38,17 @@ const rules$2 = {
37
38
  "restrict-private-properties": rule$9,
38
39
  "scripts-name-casing": rule$10,
39
40
  "sort-collections": rule$11,
40
- "unique-dependencies": rule$12,
41
+ "specify-peers-locally": rule$12,
42
+ "unique-dependencies": rule$13,
41
43
  ...rules$1,
42
- "valid-local-dependency": rule$13,
43
- "valid-name": rule$14,
44
- "valid-package-definition": rule$15,
45
- "valid-repository-directory": rule$16,
46
- "valid-version": rule$17
44
+ "valid-local-dependency": rule$14,
45
+ "valid-name": rule$15,
46
+ "valid-package-definition": rule$16,
47
+ "valid-repository-directory": rule$17,
48
+ "valid-version": rule$18
47
49
  };
48
- const recommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$18]) => rule$18.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
49
- 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"])) };
50
+ const recommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$19]) => rule$19.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
51
+ 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"])) };
50
52
  const plugin = {
51
53
  configs: {
52
54
  "legacy-recommended": {
package/lib/rules/specify-peers-locally.d.mts ADDED
@@ -0,0 +1,6 @@
1
+ import { PackageJsonRuleModule } from "../createRule.mjs";
2
+
3
+ //#region src/rules/specify-peers-locally.d.ts
4
+ declare const rule: PackageJsonRuleModule<[], []>;
5
+ //#endregion
6
+ export { rule };
package/lib/rules/specify-peers-locally.mjs ADDED
@@ -0,0 +1,65 @@
1
+ import { createRule } from "../createRule.mjs";
2
+ import { isJSONStringLiteral } from "../utils/predicates.mjs";
3
+
4
+ //#region src/rules/specify-peers-locally.ts
5
+ const rule = createRule({
6
+ create(context) {
7
+ const devDependencyNames = /* @__PURE__ */ new Set();
8
+ let devDependenciesObjectNode;
9
+ const peerDependencyMap = {};
10
+ return {
11
+ "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression][key.value=devDependencies]"(node) {
12
+ devDependenciesObjectNode = node.value;
13
+ for (const devDependencyPropertyNode of node.value.properties) {
14
+ const dependencyKey = devDependencyPropertyNode.key;
15
+ if (isJSONStringLiteral(dependencyKey)) devDependencyNames.add(dependencyKey.value);
16
+ }
17
+ },
18
+ "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression][key.value=peerDependencies]"(node) {
19
+ for (const peerDependencyPropertyNode of node.value.properties) {
20
+ const dependencyKey = peerDependencyPropertyNode.key;
21
+ if (isJSONStringLiteral(dependencyKey)) peerDependencyMap[dependencyKey.value] = peerDependencyPropertyNode;
22
+ }
23
+ },
24
+ "Program:exit"() {
25
+ for (const [peerDependencyName, peerDependencyNode] of Object.entries(peerDependencyMap)) if (!devDependencyNames.has(peerDependencyName)) {
26
+ const peerDependencyValue = peerDependencyNode.value;
27
+ context.report({
28
+ data: { name: peerDependencyName },
29
+ messageId: "devDependencyNotDefined",
30
+ node: peerDependencyNode,
31
+ suggest: devDependenciesObjectNode && isJSONStringLiteral(peerDependencyValue) ? [{
32
+ data: { name: peerDependencyName },
33
+ fix: (fixer) => {
34
+ const updatedDevDependencies = {
35
+ ...JSON.parse(context.sourceCode.getText(devDependenciesObjectNode)),
36
+ [peerDependencyName]: peerDependencyValue.value
37
+ };
38
+ const sortedDevDependencies = Object.fromEntries(Object.entries(updatedDevDependencies).sort((a, b) => a[0] > b[0] ? 1 : -1));
39
+ return fixer.replaceText(devDependenciesObjectNode, JSON.stringify(sortedDevDependencies, null, 2).split("\n").join("\n "));
40
+ },
41
+ messageId: "addToDevDependencies"
42
+ }] : []
43
+ });
44
+ }
45
+ }
46
+ };
47
+ },
48
+ meta: {
49
+ docs: {
50
+ description: "Requires that all peer dependencies are also declared as dev dependencies",
51
+ recommended: true
52
+ },
53
+ hasSuggestions: true,
54
+ messages: {
55
+ addToDevDependencies: "Add \"{{ name }}\" to `devDependencies`",
56
+ devDependencyNotDefined: "Peer dependency \"{{ name }}\" is not also declared in `devDependencies`."
57
+ },
58
+ schema: [],
59
+ type: "problem"
60
+ },
61
+ name: "specify-peers-locally"
62
+ });
63
+
64
+ //#endregion
65
+ export { rule };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-plugin-package-json",
3
- "version": "0.82.0",
3
+ "version": "0.83.0",
4
4
  "description": "Rules for consistent, readable, and valid package.json files. 🗂️",
5
5
  "homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
6
6
  "bugs": {