Merge pull request #69 from phanect/doc-flatconfig-workaround

Add notice about Flat Config into README

Author: phanect

README.md

@@ -24,6 +24,13 @@ $ npm install --save-dev @typescript-eslint/eslint-plugin
 
 ## Usage
 
+### eslint.config.* (Flat Config)
+
+Unfortunately, eslint-plugin-editorconfig does not work properly with Flat Config for now, even if you use `@eslint/eslintrc` for compatibility.
+Please wait for the next version.
+
+### .eslintrc.*
+
 Like other ESLint plugins,
 
 - add rules in the `rules`

examples/flat-config/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

examples/flat-config/README.md

@@ -0,0 +1,4 @@
+# Configuration example for Flat Config
+
+This directory is an example of using eslint-plugin-editorconfig with Flat Config.
+Unfortunately, it does not work properly with Flat Config yet, even if you use `@eslint/eslintrc` for compatibility.

examples/flat-config/eslint.config.js

@@ -0,0 +1,21 @@
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  resolvePluginsRelativeTo: __dirname,
+});
+
+/** @type { import("eslint").Linter.FlatConfig[] } */
+export default [
+  ...compat.config({
+    extends: [ "plugin:editorconfig/all" ],
+    plugins: [ "editorconfig" ],
+  }).map(config => ({
+    ...config,
+    ignores: [ join(__dirname, "src/invalid.ts") ]
+  })),
+];

examples/flat-config/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "epe-flat-config-example",
+  "version": "0.0.0",
+  "license": "MIT",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.6",
+    "eslint": "^8.56.0",
+    "eslint-plugin-editorconfig": "^4.0.3",
+    "undici": "^6.2.1"
+  }
+}

examples/flat-config/src/invalid.ts

@@ -0,0 +1,11 @@
+import { fetch } from "undici";
+
+const res = await fetch("https://example.com");
+
+try {
+    const data = await res.json(); // This line should be warned by this plugin
+  console.log(data);
+} catch (err) {
+  console.error(err);
+  process.exit(1);
+}

examples/flat-config/src/valid.js

@@ -0,0 +1,11 @@
+import { fetch } from "undici";
+
+const res = await fetch("https://example.com");
+
+try {
+  const data = await res.json();
+  console.log(data);
+} catch (err) {
+  console.error(err);
+  process.exit(1);
+}

package.json

@@ -17,7 +17,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/phanect/eslint-plugin-editorconfig.git"
+    "url": "git+https://github.com/phanect/eslint-plugin-editorconfig.git"
   },
   "bugs": {
     "url": "https://github.com/phanect/eslint-plugin-editorconfig/issues"