feat: add support for flat config (#301)

* feat: add support for flat config

* fix

* Create rare-coats-report.md

* fix test

Author: ota-meshi

.changeset/rare-coats-report.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-json-schema-validator": minor
+---
+
+feat: add support for flat config

.eslintrc.js

@@ -188,5 +188,17 @@ module.exports = {
         "eslint-plugin/require-meta-schema": "off",
       },
     },
+    {
+      files: ["*.mjs"],
+      parserOptions: {
+        sourceType: "module",
+      },
+    },
+    {
+      files: ["*.md/**", "**/*.md/**"],
+      rules: {
+        "n/no-missing-import": "off",
+      },
+    },
   ],
 };

README.md

@@ -43,7 +43,35 @@ npm install --save-dev eslint eslint-plugin-jsonc eslint-plugin-json-schema-vali
 
 ### Configuration
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+#### New (ESLint>=v9) Config (Flat Config)
+
+Use `eslint.config.js` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/configuration-files-new>.
+
+Example **eslint.config.js**:
+
+```mjs
+import eslintPluginJsonSchemaValidator from 'eslint-plugin-json-schema-validator';
+export default [
+  // add more generic rule sets here, such as:
+  // js.configs.recommended,
+  ...eslintPluginJsonSchemaValidator.configs['flat/recommended'],
+  {
+    rules: {
+      // override/add rules settings here, such as:
+      // 'json-schema-validator/no-invalid': 'warn'
+    }
+  }
+];
+```
+
+This plugin provides configs:
+
+- `*.configs['flat/base']` ... Configuration to enable correct JSON, YAML and TOML parsing.
+- `*.configs['flat/recommended']` ... Above, plus rule to validate with JSON Schema.
+
+#### Legacy Config (ESLint<v9)
+
+Use `.eslintrc.*` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/>.
 
 Example **.eslintrc.js**:
 

docs/user-guide/README.md

@@ -18,7 +18,35 @@ npm install --save-dev eslint eslint-plugin-json-schema-validator
 
 ### Configuration
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+#### New (ESLint>=v9) Config (Flat Config)
+
+Use `eslint.config.js` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/configuration-files-new>.
+
+Example **eslint.config.js**:
+
+```mjs
+import eslintPluginJsonSchemaValidator from 'eslint-plugin-json-schema-validator';
+export default [
+  // add more generic rule sets here, such as:
+  // js.configs.recommended,
+  ...eslintPluginJsonSchemaValidator.configs['flat/recommended'],
+  {
+    rules: {
+      // override/add rules settings here, such as:
+      // 'json-schema-validator/no-invalid': 'warn'
+    }
+  }
+];
+```
+
+This plugin provides configs:
+
+- `*.configs['flat/base']` ... Configuration to enable correct JSON, YAML and TOML parsing.
+- `*.configs['flat/recommended']` ... Above, plus rule to validate with JSON Schema.
+
+#### Legacy Config (ESLint<v9)
+
+Use `.eslintrc.*` file to configure rules. See also: <https://eslint.org/docs/latest/use/configure/>.
 
 Example **.eslintrc.js**:
 

src/configs/flat/base.ts

@@ -0,0 +1,57 @@
+import type { ESLint } from "eslint";
+import * as jsoncParser from "jsonc-eslint-parser";
+import * as yamlParser from "yaml-eslint-parser";
+import * as tomlParser from "toml-eslint-parser";
+export default [
+  {
+    plugins: {
+      // eslint-disable-next-line @typescript-eslint/naming-convention -- plugin name
+      get "json-schema-validator"(): ESLint.Plugin {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports -- ignore
+        return require("../../index");
+      },
+    },
+  },
+  {
+    files: [
+      "*.json",
+      "**/*.json",
+      "*.json5",
+      "**/*.json5",
+      "*.jsonc",
+      "**/*.jsonc",
+    ],
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    rules: {
+      // ESLint core rules known to cause problems with JSON.
+      strict: "off",
+      "no-unused-expressions": "off",
+      "no-unused-vars": "off",
+    },
+  },
+  {
+    files: ["*.yaml", "**/*.yaml", "*.yml", "**/*.yml"],
+    languageOptions: {
+      parser: yamlParser,
+    },
+    rules: {
+      // ESLint core rules known to cause problems with YAML.
+      "no-irregular-whitespace": "off",
+      "no-unused-vars": "off",
+      "spaced-comment": "off",
+    },
+  },
+  {
+    files: ["*.toml", "**/*.toml"],
+    languageOptions: {
+      parser: tomlParser,
+    },
+    rules: {
+      // ESLint core rules known to cause problems with TOML.
+      "no-irregular-whitespace": "off",
+      "spaced-comment": "off",
+    },
+  },
+];

src/configs/flat/recommended.ts

@@ -0,0 +1,10 @@
+import base from "./base";
+export default [
+  ...base,
+  {
+    rules: {
+      // eslint-plugin-json-schema-validator rules
+      "json-schema-validator/no-invalid": "warn",
+    },
+  },
+];

src/index.ts

@@ -2,11 +2,15 @@ import type { RuleModule } from "./types";
 import { rules as ruleList } from "./utils/rules";
 import base from "./configs/base";
 import recommended from "./configs/recommended";
+import flatBase from "./configs/flat/base";
+import flatRecommended from "./configs/flat/recommended";
 import * as meta from "./meta";
 
 const configs = {
   base,
   recommended,
+  "flat/base": flatBase,
+  "flat/recommended": flatRecommended,
 };
 
 const rules = ruleList.reduce(