eslint-plugin-package-json 1.7.1 → 1.8.0

package/README.md

@@ -46,6 +46,7 @@ See [Getting Started](https://eslint-plugin-package-json.dev/getting-started) fo
 | [no-redundant-files](https://eslint-plugin-package-json.dev/rules/no-redundant-files)                                           | Prevents adding unnecessary / redundant files.                                                                                                                                               | ✅  |     | 💡  |
 | [no-redundant-publishConfig](https://eslint-plugin-package-json.dev/rules/no-redundant-publishConfig)                           | Warns when publishConfig.access is used in unscoped packages.                                                                                                                                | ✅  |     | 💡  |
 | [order-properties](https://eslint-plugin-package-json.dev/rules/order-properties)                                               | Enforces that package properties are declared in a consistent order.                                                                                                                         | 🎨  | 🔧  |     |
+| [prefer-rolling-workspace-spec](https://eslint-plugin-package-json.dev/rules/prefer-rolling-workspace-spec)                     | Require that dependencies declared with workspace protocol use a rolling workspace spec instead of a specific semver range.                                                                  |     |     | 💡  |
 | [repository-shorthand](https://eslint-plugin-package-json.dev/rules/repository-shorthand)                                       | Enforce either object or shorthand declaration for repository.                                                                                                                               | ✅  | 🔧  |     |
 | [require-attribution](https://eslint-plugin-package-json.dev/rules/require-attribution)                                         | Ensures that proper attribution is included, requiring that either `author` or `contributors` is defined, and that if `contributors` is present, it should include at least one contributor. | ✅  |     | 💡  |
 | [restrict-dependency-ranges](https://eslint-plugin-package-json.dev/rules/restrict-dependency-ranges)                           | Restricts the range of dependencies to allow or disallow specific types of ranges.                                                                                                           |     |     | 💡  |

package/dist/experimental/index.mjs

@@ -1,4 +1,4 @@
-import { t as plugin$1 } from "../plugin-BG90Pf7y.mjs";
+import { t as plugin$1 } from "../plugin-Ciw4gT9_.mjs";
 import { toCompatRule } from "eslint-json-compat-utils";
 //#region src/experimental/plugin.ts
 const language = "json/json";

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { t as plugin } from "./plugin-BG90Pf7y.mjs";
+import { t as plugin } from "./plugin-Ciw4gT9_.mjs";
 //#region src/index.ts
 const rules = plugin.rules;
 const configs = plugin.configs;

package/dist/{plugin-BG90Pf7y.mjs → plugin-Ciw4gT9_.mjs}

@@ -6,8 +6,8 @@ import detectIndent from "detect-indent";
 import { detectNewlineGraceful } from "detect-newline";
 import sortObjectKeys from "sort-object-keys";
 import sortPackageJson, { sortOrder } from "sort-package-json";
-import { execFileSync } from "node:child_process";
 import semver from "semver";
+import { execFileSync } from "node:child_process";
 import { validateAuthor, validateBin, validateBrowser, validateBugs, validateBundleDependencies, validateConfig, validateContributors, validateCpu, validateDependencies, validateDescription, validateDevEngines, validateDirectories, validateEngines, validateExports, validateFiles, validateFunding, validateGypfile, validateHomepage, validateKeywords, validateLibc, validateLicense, validateMain, validateMan, validateName, validateOs, validatePackageManager, validatePeerDependenciesMeta, validatePrivate, validatePublishConfig, validateRepository, validateScripts, validateSideEffects, validateType, validateVersion, validateWorkspaces } from "package-json-validator";
 import fs from "node:fs";
 import path from "node:path";
@@ -50,7 +50,7 @@ function createRule(rule) {
 }
 //#endregion
 //#region src/rules/bin-name-casing.ts
-const rule$18 = createRule({
+const rule$19 = createRule({
 	create(context) {
 		return { "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=bin]"(node) {
 			if (node.value.type === "JSONObjectExpression") for (const property of node.value.properties) {
@@ -92,7 +92,7 @@ function isImplicitFormat(node) {
 	if (node.type === "JSONLiteral") return true;
 	return node.properties.every((property) => !isJSONStringLiteral(property.key) || !property.key.value.startsWith("."));
 }
-const rule$17 = createRule({
+const rule$18 = createRule({
 	create(context) {
 		const [{ prefer = "explicit" } = {}] = context.options;
 		function validateForExplicit(node) {
@@ -193,7 +193,7 @@ const getTopLevelProperty = (node) => {
 	return n.type === "JSONProperty" ? n.key : void 0;
 };
 const defaultIgnoreProperties = ["files"];
-const rule$16 = createRule({
+const rule$17 = createRule({
 	create(context) {
 		const ignoreProperties = new Set(context.options[0]?.ignoreProperties ?? defaultIgnoreProperties);
 		return {
@@ -249,7 +249,7 @@ const getBundledDependencyNames = (value) => {
 	if (value?.type === "JSONArrayExpression") for (const element of value.elements.filter(isNotNullish).filter(isJSONStringLiteral)) names.add(element.value);
 	return names;
 };
-const rule$15 = createRule({
+const rule$16 = createRule({
 	create(context) {
 		const ignorePrivate = context.options[0]?.ignorePrivate ?? true;
 		let isPrivate = false;
@@ -320,7 +320,7 @@ const getCachedLocalFileRegex = (filename) => {
 		return regex;
 	}
 };
-const rule$14 = createRule({
+const rule$15 = createRule({
 	create(context) {
 		const entryCache = {
 			bin: [],
@@ -397,7 +397,7 @@ const rule$14 = createRule({
 });
 //#endregion
 //#region src/rules/no-redundant-publishConfig.ts
-const rule$13 = createRule({
+const rule$14 = createRule({
 	create(context) {
 		let packageName;
 		let publishConfigAccessProperty;
@@ -443,7 +443,7 @@ const rule$13 = createRule({
 });
 //#endregion
 //#region src/rules/order-properties.ts
-const rule$12 = createRule({
+const rule$13 = createRule({
 	create(context) {
 		return { "Program:exit"() {
 			const { ast, text } = context.sourceCode;
@@ -500,6 +500,73 @@ const rule$12 = createRule({
 	name: "order-properties"
 });
 //#endregion
+//#region src/rules/prefer-rolling-workspace-spec.ts
+const rollingWorkspaceSpecRegex = /^workspace:[*^~]?$/;
+const convertibleSpecRegex = /^(workspace:[~^])/;
+const rule$12 = createRule({
+	create(context) {
+		const { ignoreDependencies = [], ignorePatterns = [] } = context.options[0] ?? {};
+		const ignoreRegexes = ignorePatterns.map((pattern) => new RegExp(pattern));
+		const isIgnored = (name) => ignoreDependencies.includes(name) || ignoreRegexes.some((regex) => regex.test(name));
+		return { "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral]:matches([key.value=dependencies], [key.value=devDependencies])"(node) {
+			if (node.value.type === "JSONObjectExpression") for (const property of node.value.properties) {
+				const key = property.key.value;
+				if (isIgnored(key)) continue;
+				const valueNode = property.value;
+				if (!isJSONStringLiteral(valueNode) || !valueNode.value.startsWith("workspace:")) continue;
+				const dependencySpec = valueNode.value;
+				if (!rollingWorkspaceSpecRegex.test(dependencySpec)) {
+					let conversion;
+					const convertibleMatch = convertibleSpecRegex.exec(dependencySpec);
+					const rawVersion = dependencySpec.replace("workspace:", "");
+					if (convertibleMatch) conversion = convertibleMatch[1];
+					else if (semver.parse(rawVersion)) conversion = "workspace:*";
+					context.report({
+						messageId: "nonRollingWorkspaceSpec",
+						node: valueNode,
+						suggest: conversion ? [{
+							fix: (fixer) => {
+								return fixer.replaceText(valueNode, JSON.stringify(conversion));
+							},
+							messageId: "convertToRolling"
+						}] : void 0
+					});
+				}
+			}
+		} };
+	},
+	meta: {
+		defaultOptions: [{}],
+		docs: {
+			category: "Best Practices",
+			description: "Require that dependencies declared with workspace protocol use a rolling workspace spec instead of a specific semver range."
+		},
+		hasSuggestions: true,
+		messages: {
+			convertToRolling: "Convert to rolling workspace spec",
+			nonRollingWorkspaceSpec: "Workspace spec should not include specific semver range. Use a rolling workspace spec instead."
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: {
+				ignoreDependencies: {
+					items: { type: ["string"] },
+					type: ["array"],
+					description: "Specific dependencies to ignore."
+				},
+				ignorePatterns: {
+					items: { type: ["string"] },
+					type: ["array"],
+					description: "Regex patterns for dependency names to ignore."
+				}
+			},
+			type: "object"
+		}],
+		type: "suggestion"
+	},
+	name: "prefer-rolling-workspace-spec"
+});
+//#endregion
 //#region src/utils/findPropertyWithKeyValue.ts
 function findPropertyWithKeyValue(properties, value) {
 	return properties.find((property) => property.key.type === "JSONLiteral" && property.key.value === value);
@@ -1864,13 +1931,14 @@ const rule = createRule({
 //#region src/plugin.ts
 const require = createRequire(import.meta.url);
 const rules = {
-	"bin-name-casing": rule$18,
-	"exports-subpaths-style": rule$17,
-	"no-empty-fields": rule$16,
-	"no-local-dependencies": rule$15,
-	"no-redundant-files": rule$14,
-	"no-redundant-publishConfig": rule$13,
-	"order-properties": rule$12,
+	"bin-name-casing": rule$19,
+	"exports-subpaths-style": rule$18,
+	"no-empty-fields": rule$17,
+	"no-local-dependencies": rule$16,
+	"no-redundant-files": rule$15,
+	"no-redundant-publishConfig": rule$14,
+	"order-properties": rule$13,
+	"prefer-rolling-workspace-spec": rule$12,
 	"require-attribution": rule$10,
 	...rules$2,
 	"repository-shorthand": rule$11,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-package-json",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Rules for consistent, readable, and valid package.json files. 🗂️",
   "homepage": "https://github.com/michaelfaith/eslint-plugin-package-json#readme",
   "bugs": {
@@ -73,22 +73,23 @@
     "@vitest/eslint-plugin": "1.6.20",
     "astro": "7.2.0",
     "astro-og-canvas": "0.13.0",
-    "canvaskit-wasm": "0.41.1",
+    "canvaskit-wasm": "0.42.0",
     "console-fail-test": "0.6.0",
-    "eslint": "10.8.0",
+    "eslint": "10.9.0",
     "eslint-doc-generator": "3.7.0",
     "eslint-plugin-eslint-plugin": "7.6.0",
-    "eslint-plugin-jsdoc": "64.0.0",
+    "eslint-plugin-jsdoc": "64.2.0",
     "eslint-plugin-jsonc": "3.4.0",
-    "eslint-plugin-n": "18.2.1",
+    "eslint-plugin-n": "18.3.0",
     "eslint-plugin-node-dependencies": "2.2.0",
     "eslint-plugin-perfectionist": "5.10.0",
-    "eslint-plugin-regexp": "3.1.0",
+    "eslint-plugin-regexp": "3.2.0",
     "eslint-plugin-unicorn": "73.0.0",
     "eslint-plugin-yml": "3.8.0",
     "jiti": "2.7.0",
     "json-schema-to-ts": "3.1.1",
     "knip": "6.32.0",
+    "pkg-pr-new": "0.0.87",
     "prettier": "3.9.0",
     "prettier-plugin-curly": "0.4.1",
     "prettier-plugin-packagejson": "3.0.2",
@@ -99,7 +100,7 @@
     "starlight-auto-sidebar": "0.4.0",
     "tsdown": "0.22.2",
     "typescript": "npm:@typescript/typescript6@6.0.2",
-    "typescript-eslint": "8.66.0",
+    "typescript-eslint": "8.68.0",
     "vitest": "4.1.8"
   },
   "peerDependencies": {