Flat config support (#223)

Author: takurinton

.eslintignore

@@ -11,7 +11,7 @@ This plugin depends on TypeScript to check whether the component is a Chakra com
 
 TypeScript 4.4 or higher is supported. We don't test 4.3 or below but it probably works.
 
-typescript-eslint v6 or higher is supported. **v5 or below is NOT supported**.
+typescript-eslint v8 or higher is supported. **v7 or below is NOT supported**.
 
 ## Installation
 
@@ -27,23 +27,30 @@ Next, install `eslint-plugin-chakra-ui`, `@typescript-eslint/parser`.
 npm install eslint-plugin-chakra-ui @typescript-eslint/parser --save-dev
 ```
 
-Then set the `parser` property and add `chakra-ui` to the `plugins` property of your `.eslintrc.js` configuration file. You also need to set `project` and `tsconfigRootDir` in `parserOptions` to [enable TypeScript information](https://typescript-eslint.io/linting/typed-linting).
+Then set the `parser` property and add `chakra-ui` to the `plugins` property of your `eslint.congig.{js,mjs,cjs}` configuration file. You also need to set `project` and `tsconfigRootDir` in `parserOptions` to [enable TypeScript information](https://typescript-eslint.io/getting-started/typed-linting/).
 
 ```js
-module.exports = {
-  parser: "@typescript-eslint/parser",
-  plugins: ["chakra-ui"],
-  parserOptions: {
-    project: true,
-    tsconfigRootDir: __dirname,
+import parser from "@typescript-eslint/parser";
+import chakraUiPlugin from "eslint-plugin-chakra-ui";
+
+export default {
+  plugins: {
+    "chakra-ui": chakraUiPlugin,
+  },
+  languageOptions: {
+    parserOptions: {
+      parser,
+      project: ["./tsconfig.json"],
+      tsconfigRootDir: __dirname, // or import.meta.dirname
+    },
   },
 };
 ```
 
 Now you can add chakra-ui rules:
 
 ```js
-module.exports = {
+export default {
   // ...
   rules: {
     "chakra-ui/props-order": "error",
@@ -53,6 +60,17 @@ module.exports = {
 };
 ```
 
+You can also load rules in bulk by accessing recommended:
+
+```js
+export default {
+  // ...
+  rules: {
+    ...chakraUiPlugin.configs.recommended,
+  },
+};
+```
+
 ## Supported Rules
 
 Every rule is fixable with `eslint --fix`.

.eslintrc.js

@@ -0,0 +1,45 @@
+import js from "@eslint/js";
+import tseslint from "typescript-eslint";
+import parser from "@typescript-eslint/parser";
+import plugins from "@typescript-eslint/eslint-plugin";
+import unusedImports from "eslint-plugin-unused-imports";
+import globals from "globals";
+
+export default tseslint.config(
+  { ignores: ["dist"] },
+  {
+    languageOptions: {
+      parserOptions: {
+        parser,
+        ecmaVersion: 12,
+        sourceType: "module",
+        project: ["./tsconfig.json"],
+        tsconfigRootDir: import.meta.dirname,
+        globals: globals.node,
+      },
+    },
+  },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ["**/*.ts"],
+    plugins: {
+      "unused-imports": unusedImports,
+    },
+    rules: {
+      "@typescript-eslint/no-unused-vars": "off",
+      "unused-imports/no-unused-imports": "error",
+      "unused-imports/no-unused-vars": [
+        "warn",
+        { vars: "all", varsIgnorePattern: "^_", args: "after-used", argsIgnorePattern: "^_" },
+      ],
+    },
+  },
+  {
+    files: ["__tests__/**/*.js", "__tests__/**/*.{ts,tsx}"],
+    languageOptions: {
+      parserOptions: {
+        globals: globals.mocha,
+      },
+    },
+  },
+);

README.md

@@ -17,7 +17,7 @@
   "main": "dist/index.js",
   "scripts": {
     "lint": "run-p lint:*",
-    "lint:eslint": "eslint --ext .ts,.tsx ./src",
+    "lint:eslint": "eslint ./src",
     "lint:tsc": "tsc --noEmit",
     "lint:prettier": "prettier --check ./src",
     "fix:prettier": "prettier --write ./src",
@@ -27,22 +27,24 @@
     "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^6.21.0"
+    "@typescript-eslint/utils": "^8.19.1"
   },
   "devDependencies": {
     "@swc/cli": "^0.1.62",
     "@swc/core": "^1.4.1",
     "@types/node": "^18.19.67",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "@typescript-eslint/rule-tester": "^6.21.0",
-    "@typescript-eslint/types": "^6.21.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-eslint-plugin": "^5.3.0",
-    "eslint-plugin-unused-imports": "^3.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
+    "@typescript-eslint/rule-tester": "^8.19.1",
+    "@typescript-eslint/types": "^8.19.1",
+    "eslint": "^9.18.0",
+    "eslint-plugin-eslint-plugin": "^6.4.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "15.14.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.2.5",
     "typescript": "^5.3.3",
+    "typescript-eslint": "8.19.1",
     "vite": "^4.5.2",
     "vitest": "^0.34.6",
     "watchlist": "^0.3.1"