eslint-plugin-package-json 0.40.4 → 0.41.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-## [0.40.4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.40.3...v0.40.4) (2025-06-20)
+# [0.41.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.40.5...v0.41.0) (2025-06-24)
+
+
+### Features
+
+* **valid-type:** add new rule ([#1120](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1120)) ([7425f27](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/7425f2796560e94420a85fa6494996cb052c06c4)), closes [#842](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/842)
 
+## [0.40.5](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.40.4...v0.40.5) (2025-06-23)
+
+### Bug Fixes
+
+- **deps:** update dependency package-json-validator to ~0.16.0 ([#1135](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1135)) ([4a4a2a0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4a4a2a07fdfef6b1869a51824a6697bbb2c34ecb))
+
+## [0.40.4](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.40.3...v0.40.4) (2025-06-20)
 
 ### Bug Fixes
 
-* **deps:** update dependency package-json-validator to ~0.15.0 ([#1131](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1131)) ([4bf7d9c](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4bf7d9cd091faf9ac0fb286b5968d6417328c79c))
+- **deps:** update dependency package-json-validator to ~0.15.0 ([#1131](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1131)) ([4bf7d9c](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4bf7d9cd091faf9ac0fb286b5968d6417328c79c))
 
 ## [0.40.3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.40.2...v0.40.3) (2025-06-19)
 

package/README.md

@@ -144,6 +144,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [valid-package-def](docs/rules/valid-package-def.md)                   | Enforce that package.json has all properties required by the npm spec                             |      |    |    | ❌  |
 | [valid-package-definition](docs/rules/valid-package-definition.md)     | Enforce that package.json has all properties required by the npm spec                             | ✔️ ✅ |    |    |    |
 | [valid-repository-directory](docs/rules/valid-repository-directory.md) | Enforce that if repository directory is specified, it matches the path to the package.json file   | ✔️ ✅ |    | 💡 |    |
+| [valid-type](docs/rules/valid-type.md)                                 | Enforce that the `type` property is valid.                                                        | ✔️ ✅ |    |    |    |
 | [valid-version](docs/rules/valid-version.md)                           | Enforce that package versions are valid semver specifiers                                         | ✔️ ✅ |    |    |    |
 
 <!-- end auto-generated rules list -->

package/lib/plugin.js

@@ -14,6 +14,7 @@ import { rule as validLocalDependency } from "./rules/valid-local-dependency.js"
 import { rule as validName } from "./rules/valid-name.js";
 import { rule as validPackageDefinition } from "./rules/valid-package-definition.js";
 import { rule as validRepositoryDirectory } from "./rules/valid-repository-directory.js";
+import { rule as validType } from "./rules/valid-type.js";
 import { rule as validVersion } from "./rules/valid-version.js";
 const require2 = createRequire(import.meta.url);
 const { name, version } = require2("../package.json");
@@ -32,6 +33,7 @@ const rules = {
   "valid-name": validName,
   "valid-package-definition": validPackageDefinition,
   "valid-repository-directory": validRepositoryDirectory,
+  "valid-type": validType,
   "valid-version": validVersion,
   /** @deprecated use 'valid-package-definition' instead */
   "valid-package-def": {

package/lib/rules/valid-author.js

@@ -6,9 +6,7 @@ const rule = createRule({
     return {
       "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=author]"(node) {
         const authorValue = JSON.parse(
-          context.sourceCode.getText(
-            node.value
-          )
+          context.sourceCode.getText(node.value)
         );
         const errors = validateAuthor(authorValue);
         if (errors.length > 0) {

package/lib/rules/valid-type.d.ts

@@ -0,0 +1,11 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
+import 'estree';
+
+declare const rule: {
+    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { rule };

package/lib/rules/valid-type.js

@@ -0,0 +1,40 @@
+import { validateType } from "package-json-validator";
+import { createRule } from "../createRule.js";
+import { formatErrors } from "../utils/formatErrors.js";
+const rule = createRule({
+  create(context) {
+    return {
+      "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=type]"(node) {
+        const typeValueNode = node.value;
+        const typeValue = JSON.parse(
+          context.sourceCode.getText(typeValueNode)
+        );
+        const errors = validateType(typeValue);
+        if (errors.length) {
+          context.report({
+            data: {
+              errors: formatErrors(errors)
+            },
+            messageId: "validationError",
+            node: typeValueNode
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Enforce that the `type` property is valid.",
+      recommended: true
+    },
+    messages: {
+      validationError: "Invalid type: {{ errors }}"
+    },
+    schema: [],
+    type: "problem"
+  }
+});
+export {
+  rule
+};

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.40.4",
+	"version": "0.41.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -50,7 +50,7 @@
 		"detect-indent": "7.0.1",
 		"detect-newline": "4.0.1",
 		"eslint-fix-utils": "^0.4.0",
-		"package-json-validator": "~0.15.0",
+		"package-json-validator": "~0.16.0",
 		"semver": "^7.5.4",
 		"sort-object-keys": "^1.1.3",
 		"sort-package-json": "^3.0.0",
@@ -58,7 +58,7 @@
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-		"@eslint/js": "9.28.0",
+		"@eslint/js": "9.29.0",
 		"@release-it/conventional-changelog": "10.0.0",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/estree": "1.0.7",
@@ -70,11 +70,11 @@
 		"@vitest/eslint-plugin": "1.2.0",
 		"console-fail-test": "0.5.0",
 		"create-typescript-app": "2.42.0",
-		"cspell": "9.0.2",
-		"eslint": "9.28.0",
+		"cspell": "9.1.1",
+		"eslint": "9.29.0",
 		"eslint-doc-generator": "2.1.2",
 		"eslint-plugin-eslint-plugin": "6.4.0",
-		"eslint-plugin-jsdoc": "50.8.0",
+		"eslint-plugin-jsdoc": "51.0.1",
 		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.0",
 		"eslint-plugin-n": "17.20.0",