Merge pull request #48 from grafana/jh/fix-flat-config

fix composable flat configs

Author: joshhunt

README.md

@@ -30,18 +30,6 @@ npx install-peerdeps --dev @grafana/eslint-config
 
 If using a different package manager, run `npm info "@grafana/eslint-config@latest" peerDependencies` to list the peer dependencies and versions. Then run `yarn add --dev <dependency1>@<version> <dependency2>@<version> <dependency3>@<version>` for the listed peer dependencies.
 
-## Configuration (legacy: .eslintrc\*)
-
-Extend our configuration to get reasonable defaults:
-
-```json
-{
-  "extends": ["@grafana/eslint-config"]
-}
-```
-
-It will automatically handle `*.(js|ts|tsx)` files.
-
 ## Configuration (new: eslint.config.js)
 
 From v8.21.0, Eslint introduced a new flat config system where `eslint.config.js` replaces `.eslintrc*` as the default config file name. Eslint@8.x supports both systems, while Eslint@9.x only supports the new flat config.
@@ -63,9 +51,8 @@ const grafanaConfig = require("@grafana/eslint-config/flat");
  * @type {Array<import('eslint').Linter.Config>}
  */
 module.exports = [
-  {
-    grafanaConfig,
-  },
+  ...grafanaConfig,
+  … /* rest of your config */
 ];
 ```
 
@@ -83,7 +70,7 @@ module.exports = [
   {
     ignores: [".github", ".yarn", "**/build/", "**/compiled/", "**/dist/"],
   },
-  grafanaConfig,
+  ...grafanaConfig,
   {
     name: "myproject/defaults",
     files: ["**/*.{ts,tsx,js,jsx}"],
@@ -93,3 +80,15 @@ module.exports = [
   },
 ];
 ```
+
+## Configuration (legacy: .eslintrc\*)
+
+Extend our configuration to get reasonable defaults:
+
+```json
+{
+  "extends": ["@grafana/eslint-config"]
+}
+```
+
+It will automatically handle `*.(js|ts|tsx)` files.

flat.js

@@ -8,26 +8,24 @@ const stylisticTs = require("@stylistic/eslint-plugin-ts");
 
 const baseConfig = require("./base");
 
-/**
- * @type {Array<import('eslint').Linter.Config>}
- */
-module.exports = {
-  name: "@grafana/eslint-config/flat",
-  ...reactHooksPlugin.configs.recommended,
-  ...reactPlugin.configs.flat.recommended,
-  ...prettierConfig,
-  settings: baseConfig.settings,
-  plugins: {
-    jsdoc,
-    "@typescript-eslint": tsPlugin,
-    "react-hooks": reactHooksPlugin,
-    "@stylistic/ts": stylisticTs,
+module.exports = [
+  reactHooksPlugin.configs["recommended-latest"],
+  reactPlugin.configs.flat.recommended,
+  prettierConfig,
+  {
+    name: "@grafana/eslint-config/flat",
+    settings: baseConfig.settings,
+    plugins: {
+      jsdoc,
+      "@typescript-eslint": tsPlugin,
+      "@stylistic/ts": stylisticTs,
+    },
+    languageOptions: {
+      parser: typescriptParser,
+      ecmaVersion: baseConfig.ecmaVersion,
+      sourceType: baseConfig.sourceType,
+      parserOptions: baseConfig.parserOptions,
+    },
+    rules: baseConfig.rules,
   },
-  languageOptions: {
-    parser: typescriptParser,
-    ecmaVersion: baseConfig.ecmaVersion,
-    sourceType: baseConfig.sourceType,
-    parserOptions: baseConfig.parserOptions,
-  },
-  rules: baseConfig.rules,
-};
+];

package.json

@@ -3,7 +3,7 @@
   "license": "Apache-2.0",
   "name": "@grafana/eslint-config",
   "main": "index.js",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Grafana's ESLint config",
   "keywords": [
     "grafana",