build: automate generation of recommended rules config (#118)

* chore: automate generation of recommended rules config

* clean up workflows

Author: xbinaryx

.github/workflows/ci.yml

@@ -18,8 +18,6 @@ jobs:
                   node-version: "lts/*"
             - name: Install dependencies
               run: npm install
-            - name: Build
-              run: npm run build
             - name: Lint files
               run: npm run lint
             - name: Check Formatting
@@ -56,8 +54,6 @@ jobs:
                   node-version: "lts/*"
             - name: Install dependencies
               run: npm install
-            - name: Build
-              run: npm run build
             - name: Check Types
               run: npm run test:types
     jsr_test:
@@ -71,6 +67,4 @@ jobs:
             - name: Install Packages
               run: npm install
             - name: Run --dry-run
-              run: |
-                  npm run build
-                  npm run test:jsr
+              run: npm run test:jsr

.github/workflows/release-please.yml

@@ -25,7 +25,6 @@ jobs:
             - name: Publish to npm
               run: |
                   npm install
-                  npm run build --if-present
                   npm publish --provenance
               env:
                   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -63,3 +63,6 @@ dist
 
 # Lock files
 package-lock.json
+
+# Build
+src/build

eslint.config.js

@@ -114,4 +114,10 @@ export default defineConfig([
 			"eslint-plugin/test-case-shorthand-strings": "error",
 		},
 	},
+	{
+		files: ["tools/**/*.js"],
+		rules: {
+			"no-console": "off",
+		},
+	},
 ]);

package.json

@@ -60,15 +60,17 @@
   "scripts": {
     "build:dedupe-types": "node tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js",
     "build:cts": "node tools/build-cts.js",
-    "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
+    "build:rules": "node tools/build-rules.js",
+    "build": "npm run build:rules && rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
     "build:readme": "node tools/update-readme.js",
     "build:update-rules-docs": "node tools/update-rules-docs.js",
-    "test:jsr": "npx jsr@latest publish --dry-run",
+    "prepare": "npm run build",
     "pretest": "npm run build",
     "lint": "eslint",
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
     "test": "mocha tests/**/*.js",
+    "test:jsr": "npx jsr@latest publish --dry-run",
     "test:coverage": "c8 npm test",
     "test:types": "tsc -p tests/types/tsconfig.json"
   },

src/index.js

@@ -9,12 +9,8 @@
 
 import { JSONLanguage } from "./languages/json-language.js";
 import { JSONSourceCode } from "./languages/json-source-code.js";
-import noDuplicateKeys from "./rules/no-duplicate-keys.js";
-import noEmptyKeys from "./rules/no-empty-keys.js";
-import noUnsafeValues from "./rules/no-unsafe-values.js";
-import noUnnormalizedKeys from "./rules/no-unnormalized-keys.js";
-import sortKeys from "./rules/sort-keys.js";
-import topLevelInterop from "./rules/top-level-interop.js";
+import recommendedRules from "./build/recommended-config.js";
+import rules from "./build/rules.js";
 
 //-----------------------------------------------------------------------------
 // Plugin
@@ -30,23 +26,11 @@ const plugin = {
 		jsonc: new JSONLanguage({ mode: "jsonc" }),
 		json5: new JSONLanguage({ mode: "json5" }),
 	},
-	rules: {
-		"no-duplicate-keys": noDuplicateKeys,
-		"no-empty-keys": noEmptyKeys,
-		"no-unsafe-values": noUnsafeValues,
-		"no-unnormalized-keys": noUnnormalizedKeys,
-		"sort-keys": sortKeys,
-		"top-level-interop": topLevelInterop,
-	},
+	rules,
 	configs: {
 		recommended: {
 			plugins: {},
-			rules: /** @type {const} */ ({
-				"json/no-duplicate-keys": "error",
-				"json/no-empty-keys": "error",
-				"json/no-unsafe-values": "error",
-				"json/no-unnormalized-keys": "error",
-			}),
+			rules: recommendedRules,
 		},
 	},
 };

tools/build-rules.js

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview Generates the recommended configuration and import file for rules.
+ *
+ * Usage:
+ *  node tools/build-rules.js
+ *
+ * @author Nicholas C. Zakas
+ */
+
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+//-----------------------------------------------------------------------------
+// Main
+//-----------------------------------------------------------------------------
+
+const thisDir = path.dirname(fileURLToPath(import.meta.url));
+const rulesPath = path.resolve(thisDir, "../src/rules");
+const rules = fs.readdirSync(rulesPath);
+const recommended = [];
+
+for (const ruleId of rules) {
+	const rulePath = path.resolve(rulesPath, ruleId);
+	const rule = await import(pathToFileURL(rulePath));
+
+	if (rule.default.meta.docs.recommended) {
+		recommended.push(ruleId);
+	}
+}
+
+const output = `const rules = /** @type {const} */ ({
+    ${recommended.map(id => `"json/${id.slice(0, -3)}": "error"`).join(",\n    ")}
+});
+
+export default rules;
+`;
+
+fs.mkdirSync(path.resolve(thisDir, "../src/build"), { recursive: true });
+fs.writeFileSync(
+	path.resolve(thisDir, "../src/build/recommended-config.js"),
+	output,
+);
+
+console.log("Recommended rules generated successfully.");
+
+const rulesOutput = `
+${rules.map((id, index) => `import rule${index} from "../rules/${id}";`).join("\n")}
+
+export default {
+    ${rules.map((id, index) => `"${id.slice(0, -3)}": rule${index},`).join("\n    ")}
+};
+`.trim();
+
+fs.writeFileSync(path.resolve(thisDir, "../src/build/rules.js"), rulesOutput);
+
+console.log("Rules import file generated successfully.");