build: Enable JSON linting (#18681)

nzakas · fasttime · amareshsm · web-flow · commit 45144243f3b5 · 2024-07-18T15:47:00.000+02:00
* build: Enable JSON linting

* Update eslint.config.js

Co-authored-by: Francesco Trotta &lt;github@fasttime.org&gt;

* Update eslint.config.js

Co-authored-by: Amaresh  S M  &lt;amareshsm13@gmail.com&gt;

* Apply feedback

* Fix internal paths strings

---------

Co-authored-by: Francesco Trotta &lt;github@fasttime.org&gt;
Co-authored-by: Amaresh  S M &lt;amareshsm13@gmail.com&gt;
diff --git a/Makefile.js b/Makefile.js
@@ -73,7 +73,6 @@ const NODE = "node ", // intentional extra space
 
     // Files
     RULE_FILES = glob.sync("lib/rules/*.js").filter(filePath => path.basename(filePath) !== "index.js"),
-    JSON_FILES = find("conf/").filter(fileType("json")),
     MARKDOWNLINT_IGNORE_INSTANCE = ignore().add(fs.readFileSync(path.join(__dirname, ".markdownlintignore"), "utf-8")),
     MARKDOWN_FILES_ARRAY = MARKDOWNLINT_IGNORE_INSTANCE.filter(find("docs/").concat(ls(".")).filter(fileType("md"))),
     TEST_FILES = "\"tests/{bin,conf,lib,tools}/**/*.js\"",
@@ -93,18 +92,6 @@ const NODE = "node ", // intentional extra space
 // Helpers
 //------------------------------------------------------------------------------
 
-/**
- * Simple JSON file validation that relies on ES JSON parser.
- * @param {string} filePath Path to JSON.
- * @throws Error If file contents is invalid JSON.
- * @returns {undefined}
- */
-function validateJsonFile(filePath) {
-    const contents = fs.readFileSync(filePath, "utf8");
-
-    JSON.parse(contents);
-}
-
 /**
  * Generates a function that matches files with a particular extension.
  * @param {string} extension The file extension (i.e. "js")
@@ -572,9 +559,6 @@ target.lint = function([fix = false] = []) {
         errors++;
     }
 
-    echo("Validating JSON Files");
-    JSON_FILES.forEach(validateJsonFile);
-
     echo("Validating Markdown Files");
     lastReturn = lintMarkdown(MARKDOWN_FILES_ARRAY);
     if (lastReturn.code !== 0) {
diff --git a/eslint.config.js b/eslint.config.js
@@ -16,19 +16,27 @@ const eslintPluginTestsRecommendedConfig = require("eslint-plugin-eslint-plugin/
 const globals = require("globals");
 const eslintConfigESLintCJS = require("eslint-config-eslint/cjs");
 const eslintConfigESLintFormatting = require("eslint-config-eslint/formatting");
+const json = require("@eslint/json");
 
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
 
-const INTERNAL_FILES = {
+const INTERNAL_PATHS = {
     CLI_ENGINE_PATTERN: "lib/cli-engine/**/*",
     LINTER_PATTERN: "lib/linter/**/*",
     RULE_TESTER_PATTERN: "lib/rule-tester/**/*",
     RULES_PATTERN: "lib/rules/**/*",
     SOURCE_CODE_PATTERN: "lib/source-code/**/*"
 };
 
+// same paths but with `.js` at the end
+const INTERNAL_FILES = Object.fromEntries(
+    Object.entries(INTERNAL_PATHS).map(([key, value]) => [key, `${value}.js`])
+);
+
+const ALL_JS_FILES = "**/*.js";
+
 /**
  * Resolve an absolute path or glob pattern.
  * @param {string} pathOrPattern the path or glob pattern.
@@ -44,7 +52,7 @@ function resolveAbsolutePath(pathOrPattern) {
  * @returns {Object[]} The array of `no-restricted-require` entries.
  */
 function createInternalFilesPatterns(pattern = null) {
-    return Object.values(INTERNAL_FILES)
+    return Object.values(INTERNAL_PATHS)
         .filter(p => p !== pattern)
         .map(p => ({
             name: [
@@ -59,8 +67,16 @@ function createInternalFilesPatterns(pattern = null) {
 }
 
 module.exports = [
-    ...eslintConfigESLintCJS,
-    eslintConfigESLintFormatting,
+    ...eslintConfigESLintCJS.map(config => ({
+        ...config,
+        name: `eslint/${config.name}`,
+        files: [ALL_JS_FILES]
+    })),
+    {
+        ...eslintConfigESLintFormatting,
+        name: "eslint/formatting",
+        files: [ALL_JS_FILES]
+    },
     {
         name: "eslint/global-ignores",
         ignores: [
@@ -74,11 +90,13 @@ module.exports = [
             "tests/fixtures/**",
             "tests/performance/**",
             "tmp/**",
-            "**/test.js"
+            "**/test.js",
+            ".vscode"
         ]
     },
     {
         name: "eslint/internal-rules",
+        files: [ALL_JS_FILES],
         plugins: {
             "internal-rules": internalPlugin
         },
@@ -99,7 +117,7 @@ module.exports = [
     },
     {
         name: "eslint/rules",
-        files: ["lib/rules/*", "tools/internal-rules/*"],
+        files: ["lib/rules/*.js", "tools/internal-rules/*.js"],
         ignores: ["**/index.js"],
         ...eslintPluginRulesRecommendedConfig,
         rules: {
@@ -113,15 +131,15 @@ module.exports = [
     },
     {
         name: "eslint/core-rules",
-        files: ["lib/rules/*"],
+        files: ["lib/rules/*.js"],
         ignores: ["**/index.js"],
         rules: {
             "eslint-plugin/require-meta-docs-url": ["error", { pattern: "https://eslint.org/docs/latest/rules/{{name}}" }]
         }
     },
     {
         name: "eslint/rules-tests",
-        files: ["tests/lib/rules/*", "tests/tools/internal-rules/*"],
+        files: ["tests/lib/rules/*.js", "tests/tools/internal-rules/*.js"],
         ...eslintPluginTestsRecommendedConfig,
         rules: {
             ...eslintPluginTestsRecommendedConfig.rules,
@@ -156,10 +174,27 @@ module.exports = [
         }
     },
 
+    // JSON files
+    {
+        name: "eslint/json",
+        files: ["**/*.json", ".c8rc"],
+        ignores: ["**/package-lock.json"],
+        language: "json/json",
+        ...json.configs.recommended
+    },
+
+    // JSONC files
+    {
+        name: "eslint/jsonc",
+        files: ["knip.jsonc"],
+        language: "json/jsonc",
+        ...json.configs.recommended
+    },
+
     // Restrict relative path imports
     {
         name: "eslint/lib",
-        files: ["lib/*"],
+        files: ["lib/*.js"],
         ignores: ["lib/unsupported-api.js"],
         rules: {
             "n/no-restricted-require": ["error", [
@@ -172,7 +207,7 @@ module.exports = [
         files: [INTERNAL_FILES.CLI_ENGINE_PATTERN],
         rules: {
             "n/no-restricted-require": ["error", [
-                ...createInternalFilesPatterns(INTERNAL_FILES.CLI_ENGINE_PATTERN)
+                ...createInternalFilesPatterns(INTERNAL_PATHS.CLI_ENGINE_PATTERN)
             ]]
         }
     },
@@ -181,7 +216,7 @@ module.exports = [
         files: [INTERNAL_FILES.LINTER_PATTERN],
         rules: {
             "n/no-restricted-require": ["error", [
-                ...createInternalFilesPatterns(INTERNAL_FILES.LINTER_PATTERN),
+                ...createInternalFilesPatterns(INTERNAL_PATHS.LINTER_PATTERN),
                 "fs",
                 resolveAbsolutePath("lib/cli-engine/index.js"),
                 resolveAbsolutePath("lib/rule-tester/index.js")
@@ -193,7 +228,7 @@ module.exports = [
         files: [INTERNAL_FILES.RULES_PATTERN],
         rules: {
             "n/no-restricted-require": ["error", [
-                ...createInternalFilesPatterns(INTERNAL_FILES.RULES_PATTERN),
+                ...createInternalFilesPatterns(INTERNAL_PATHS.RULES_PATTERN),
                 "fs",
                 resolveAbsolutePath("lib/cli-engine/index.js"),
                 resolveAbsolutePath("lib/linter/index.js"),
@@ -204,7 +239,7 @@ module.exports = [
     },
     {
         name: "eslint/shared",
-        files: ["lib/shared/**/*"],
+        files: ["lib/shared/**/*.js"],
         rules: {
             "n/no-restricted-require": ["error", [
                 ...createInternalFilesPatterns(),
@@ -220,7 +255,7 @@ module.exports = [
         files: [INTERNAL_FILES.SOURCE_CODE_PATTERN],
         rules: {
             "n/no-restricted-require": ["error", [
-                ...createInternalFilesPatterns(INTERNAL_FILES.SOURCE_CODE_PATTERN),
+                ...createInternalFilesPatterns(INTERNAL_PATHS.SOURCE_CODE_PATTERN),
                 "fs",
                 resolveAbsolutePath("lib/cli-engine/index.js"),
                 resolveAbsolutePath("lib/linter/index.js"),
diff --git a/package.json b/package.json
@@ -105,6 +105,7 @@
     "@babel/core": "^7.4.3",
     "@babel/preset-env": "^7.4.3",
     "@eslint/core": "^0.1.0",
+    "@eslint/json": "^0.1.0",
     "@types/estree": "^1.0.5",
     "@types/node": "^20.11.5",
     "@wdio/browser-runner": "^8.38.3",
