eslint-plugin-package-json 0.52.0 → 0.53.0

package/lib/utils/createSimpleValidPropertyRule.d.ts

@@ -1,8 +1,6 @@
-import * as eslint from 'eslint';
-import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
-import { PackageJsonRuleContext } from '../createRule.js';
-import 'estree';
+import { PackageJsonRuleModule } from "../createRule.js";
 
+//#region src/utils/createSimpleValidPropertyRule.d.ts
 type ValidationFunction = (value: unknown) => string[];
 /**
  * Given a top-level property name, and a validation function, create a rule that validates the property using the validation function.
@@ -11,8 +9,8 @@ type ValidationFunction = (value: unknown) => string[];
  * to create a more complex rule, create it in its own file.
  */
 declare const createSimpleValidPropertyRule: (propertyName: string, validationFunction: ValidationFunction, aliases?: string[]) => {
-    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
-    meta: eslint.Rule.RuleMetaData;
+  rule: PackageJsonRuleModule<unknown[]>;
+  ruleName: string;
 };
-
-export { type ValidationFunction, createSimpleValidPropertyRule };
+//#endregion
+export { ValidationFunction, createSimpleValidPropertyRule };

package/lib/utils/createSimpleValidPropertyRule.js

@@ -1,43 +1,49 @@
 import { createRule } from "../createRule.js";
 import { formatErrors } from "./formatErrors.js";
+
+//#region src/utils/createSimpleValidPropertyRule.ts
+/**
+* Given a top-level property name, and a validation function, create a rule that validates the property using the validation function.
+* These rules will always be included in the recommended config.
+* Note: this will only create a basic validation rule, with no options.  If you need
+* to create a more complex rule, create it in its own file.
+*/
 const createSimpleValidPropertyRule = (propertyName, validationFunction, aliases = []) => {
-  const propertyNames = [propertyName, ...aliases];
-  return createRule({
-    create(context) {
-      return propertyNames.reduce((acc, name) => {
-        acc[`Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=${name}]`] = (node) => {
-          const valueNode = node.value;
-          const value = JSON.parse(
-            context.sourceCode.getText(valueNode)
-          );
-          const errors = validationFunction(value);
-          if (errors.length) {
-            context.report({
-              data: {
-                errors: formatErrors(errors)
-              },
-              messageId: "validationError",
-              node: valueNode
-            });
-          }
-        };
-        return acc;
-      }, {});
-    },
-    meta: {
-      docs: {
-        category: "Best Practices",
-        description: `Enforce that the \`${propertyName}\`${aliases.length ? ` (also: ${aliases.map((alias) => `\`${alias}\``).join(", ")})` : ""} property is valid.`,
-        recommended: true
-      },
-      messages: {
-        validationError: `Invalid ${propertyName}: {{ errors }}`
-      },
-      schema: [],
-      type: "problem"
-    }
-  });
-};
-export {
-  createSimpleValidPropertyRule
+	const ruleName = `valid-${propertyName}`;
+	const propertyNames = [propertyName, ...aliases];
+	const rule = createRule({
+		create(context) {
+			return propertyNames.reduce((acc, name) => {
+				acc[`Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=${name}]`] = (node) => {
+					const valueNode = node.value;
+					const value = JSON.parse(context.sourceCode.getText(valueNode));
+					const errors = validationFunction(value);
+					if (errors.length) context.report({
+						data: { errors: formatErrors(errors) },
+						messageId: "validationError",
+						node: valueNode
+					});
+				};
+				return acc;
+			}, {});
+		},
+		meta: {
+			docs: {
+				category: "Best Practices",
+				description: `Enforce that the \`${propertyName}\`${aliases.length ? ` (also: ${aliases.map((alias) => `\`${alias}\``).join(", ")})` : ""} property is valid.`,
+				recommended: true
+			},
+			messages: { validationError: `Invalid ${propertyName}: {{ errors }}` },
+			schema: [],
+			type: "problem"
+		},
+		name: ruleName
+	});
+	return {
+		rule,
+		ruleName
+	};
 };
+
+//#endregion
+export { createSimpleValidPropertyRule };

package/lib/utils/findPropertyWithKeyValue.d.ts

@@ -1,9 +1,10 @@
-import { AST } from 'jsonc-eslint-parser';
+import { AST } from "jsonc-eslint-parser";
 
+//#region src/utils/findPropertyWithKeyValue.d.ts
 type JSONPropertyWithKeyAndValue<Value extends string> = AST.JSONProperty & {
-    key: AST.JSONStringLiteral;
-    value: Value;
+  key: AST.JSONStringLiteral;
+  value: Value;
 };
 declare function findPropertyWithKeyValue<Value extends string>(properties: AST.JSONProperty[], value: Value): JSONPropertyWithKeyAndValue<Value> | undefined;
-
-export { type JSONPropertyWithKeyAndValue, findPropertyWithKeyValue };
+//#endregion
+export { JSONPropertyWithKeyAndValue, findPropertyWithKeyValue };

package/lib/utils/findPropertyWithKeyValue.js

@@ -1,8 +1,7 @@
+//#region src/utils/findPropertyWithKeyValue.ts
 function findPropertyWithKeyValue(properties, value) {
-  return properties.find(
-    (property) => property.key.type === "JSONLiteral" && property.key.value === value
-  );
+	return properties.find((property) => property.key.type === "JSONLiteral" && property.key.value === value);
 }
-export {
-  findPropertyWithKeyValue
-};
+
+//#endregion
+export { findPropertyWithKeyValue };

package/lib/utils/formatErrors.d.ts

@@ -1,8 +1,9 @@
+//#region src/utils/formatErrors.d.ts
 /**
  * Formats an array of error messages into a single string.
  * When there is more than one error, the errors will be formatted as a list,
  * starting on a new line.
  */
 declare const formatErrors: (errors: string[]) => string;
-
-export { formatErrors };
+//#endregion
+export { formatErrors };

package/lib/utils/formatErrors.js

@@ -1,9 +1,13 @@
+//#region src/utils/formatErrors.ts
+/**
+* Formats an array of error messages into a single string.
+* When there is more than one error, the errors will be formatted as a list,
+* starting on a new line.
+*/
 const formatErrors = (errors) => {
-  if (errors.length === 0) {
-    return "";
-  }
-  return errors.length > 1 ? ["", ...errors].join("\n - ") : errors[0];
-};
-export {
-  formatErrors
+	if (errors.length === 0) return "";
+	return errors.length > 1 ? ["", ...errors].join("\n - ") : errors[0];
 };
+
+//#endregion
+export { formatErrors };

package/lib/utils/isPackageJson.d.ts

@@ -1,3 +1,4 @@
+//#region src/utils/isPackageJson.d.ts
 declare const isPackageJson: (filePath: string) => boolean;
-
-export { isPackageJson };
+//#endregion
+export { isPackageJson };

package/lib/utils/isPackageJson.js

@@ -1,4 +1,5 @@
+//#region src/utils/isPackageJson.ts
 const isPackageJson = (filePath) => /(?:^|[/\\])package.json$/.test(filePath);
-export {
-  isPackageJson
-};
+
+//#endregion
+export { isPackageJson };

package/lib/utils/predicates.d.ts

@@ -1,6 +1,7 @@
-import { AST } from 'jsonc-eslint-parser';
+import { AST } from "jsonc-eslint-parser";
 
+//#region src/utils/predicates.d.ts
 declare function isJSONStringLiteral(node: AST.JSONNode): node is AST.JSONStringLiteral;
 declare function isNotNullish<T extends NonNullable<unknown>>(value: null | T | undefined): value is T;
-
-export { isJSONStringLiteral, isNotNullish };
+//#endregion
+export { isJSONStringLiteral, isNotNullish };

package/lib/utils/predicates.js

@@ -1,10 +1,10 @@
+//#region src/utils/predicates.ts
 function isJSONStringLiteral(node) {
-  return node.type === "JSONLiteral" && typeof node.value === "string";
+	return node.type === "JSONLiteral" && typeof node.value === "string";
 }
 function isNotNullish(value) {
-  return value !== null && value !== void 0;
+	return value !== null && value !== void 0;
 }
-export {
-  isJSONStringLiteral,
-  isNotNullish
-};
+
+//#endregion
+export { isJSONStringLiteral, isNotNullish };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.52.0",
+	"version": "0.53.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -28,7 +28,7 @@
 		"lib/"
 	],
 	"scripts": {
-		"build": "tsup",
+		"build": "tsdown",
 		"build:docs": "pnpm build --no-dts && eslint-doc-generator",
 		"format": "prettier .",
 		"lint": "eslint . --max-warnings 0",
@@ -44,7 +44,7 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"dependencies": {
-		"@altano/repository-tools": "^2.0.0",
+		"@altano/repository-tools": "^2.0.1",
 		"change-case": "^5.4.4",
 		"detect-indent": "^7.0.1",
 		"detect-newline": "^4.0.1",
@@ -52,8 +52,8 @@
 		"package-json-validator": "~0.27.0",
 		"semver": "^7.5.4",
 		"sort-object-keys": "^1.1.3",
-		"sort-package-json": "^3.0.0",
-		"validate-npm-package-name": "^6.0.0"
+		"sort-package-json": "^3.3.0",
+		"validate-npm-package-name": "^6.0.2"
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
@@ -71,7 +71,7 @@
 		"create-typescript-app": "2.46.1",
 		"eslint": "9.32.0",
 		"eslint-doc-generator": "2.2.0",
-		"eslint-plugin-eslint-plugin": "6.5.0",
+		"eslint-plugin-eslint-plugin": "7.0.0",
 		"eslint-plugin-jsdoc": "52.0.0",
 		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.0",
@@ -92,9 +92,9 @@
 		"prettier-plugin-sh": "0.18.0",
 		"release-it": "19.0.1",
 		"sentences-per-line": "0.3.0",
-		"tsup": "8.5.0",
+		"tsdown": "0.13.3",
 		"typescript": "5.9.2",
-		"typescript-eslint": "8.38.0",
+		"typescript-eslint": "8.39.0",
 		"vitest": "3.2.0"
 	},
 	"peerDependencies": {

package/lib/tests/rules/ruleTester.d.ts

@@ -1,15 +0,0 @@
-import { RuleTester } from 'eslint';
-import { PackageJsonRuleModule } from '../../createRule.js';
-import 'estree';
-import 'jsonc-eslint-parser';
-
-type JsonRuleTester = RuleTester & {
-    run: JsonRuleTesterRun;
-};
-type JsonRuleTesterRun = (name: string, rule: PackageJsonRuleModule, tests: {
-    invalid?: RuleTester.InvalidTestCase[] | undefined;
-    valid?: (RuleTester.ValidTestCase | string)[] | undefined;
-}) => void;
-declare const ruleTester: JsonRuleTester;
-
-export { type JsonRuleTester, type JsonRuleTesterRun, ruleTester };

package/lib/tests/rules/ruleTester.js

@@ -1,25 +0,0 @@
-import { RuleTester } from "eslint";
-import jsoncESLintParser from "jsonc-eslint-parser";
-import * as vitest from "vitest";
-RuleTester.describe = vitest.describe;
-RuleTester.it = vitest.it;
-RuleTester.itOnly = vitest.it.only;
-const ruleTester = new RuleTester({
-  languageOptions: { parser: jsoncESLintParser }
-});
-const originalRun = ruleTester.run;
-ruleTester.run = (name, rule, tests) => {
-  originalRun.call(ruleTester, name, rule, {
-    invalid: tests.invalid?.map((test) => ({
-      filename: "package.json",
-      ...test
-    })),
-    valid: tests.valid?.map((test) => ({
-      filename: "package.json",
-      ...typeof test === "string" ? { code: test } : { ...test }
-    }))
-  });
-};
-export {
-  ruleTester
-};

package/lib/types/estree.d.d.ts

@@ -1,7 +0,0 @@
-import { JSONNode } from 'jsonc-eslint-parser';
-
-declare module "estree" {
-	interface NodeMap {
-		JSONNode: JSONNode;
-	}
-}