eslint-config-matsuri 2.1.1-alpha-bd9aeba.0 → 3.1.0

package/README.md

@@ -18,20 +18,38 @@ ESLintを除く依存関係を別途インストールする必要はありま
 yarn add eslint eslint-config-matsuri
 ```
 
-設定ファイルは次の記述のみで良くなります。他の記述は削除してください。
+## Usage
+
+Flat configをv3からサポートしています。eslint.config.jsに次のように記述します。
+
+```js
+import config from "eslint-config-matsuri";
+
+export default config
+```
+
+拡張する場合は、次のようにしてください。
 
 ```js
-/** @type {import('eslint').Linter.BaseConfig} */
-const config = {
-  extends: ["matsuri"],
-  parserOptions: {
-    project: true,
-    tsconfigRootDir: __dirname,
+import config from "eslint-config-matsuri";
+
+export default [
+  ...config,
+  {
+    // ここに追加の設定を記述する
   }
-};
-module.exports = config;
+]
 ```
 
+VSCodeでFlag configを利用する場合は、`.vscode/settings.json`に次の設定を追加する必要があります。
+
+```json
+{
+  "eslint.experimental.useFlatConfig": true
+}
+```
+
+
 ## Contributing
 
 ルールの検証などを行いたい場合は、tests以下にファイルを配置してください。

package/index.d.ts

@@ -0,0 +1,5 @@
+import { Linter } from "eslint";
+
+declare const config: Linter.FlatConfig[];
+
+export default config;

package/index.js

@@ -1,3 +1,4 @@
+import { FlatCompat } from "@eslint/eslintrc";
 import globals from "globals";
 import js from "@eslint/js";
 import pluginCssReorder from "eslint-plugin-css-reorder";
@@ -5,19 +6,47 @@ import pluginJsxA11y from "eslint-plugin-jsx-a11y";
 import pluginPrettier from "eslint-config-prettier";
 import pluginReact from "eslint-plugin-react";
 import pluginReactHooks from "eslint-plugin-react-hooks";
+import pluginReactRefresh from "eslint-plugin-react-refresh";
 import pluginSortImports from "eslint-plugin-sort-imports-es6-autofix";
 import pluginUnusedImport from "eslint-plugin-unused-imports";
 import ts from "@typescript-eslint/eslint-plugin";
 import tsParser from "@typescript-eslint/parser";
 
+/**
+ * @see https://github.com/storybookjs/eslint-plugin-storybook/issues/135
+ */
+const compat = new FlatCompat();
+const pluginStorybookRecommended = compat.extends(
+  "plugin:storybook/recommended"
+);
+
 /** @type { import("eslint").Linter.FlatConfig[] } */
 const config = [
+  {
+    ignores: [
+      "**/node_modules",
+      "**/public",
+      // Webpack
+      "**/build",
+      // Vite
+      "**/dist",
+      // Next.js
+      "**/.next",
+      // Nuxt.js
+      "**/.nuxt",
+      // endpoints-sdk-cli
+      "**/endpoints",
+      // Storybook
+      "**/storybook-static",
+    ],
+  },
   {
     linterOptions: {
       reportUnusedDisableDirectives: true,
     },
     languageOptions: {
-      ecmaVersion: 12,
+      ecmaVersion: "latest",
+      sourceType: "module",
       globals: {
         ...globals.commonjs,
         ...globals.es2021,
@@ -29,7 +58,7 @@ const config = [
     },
     rules: {
       ...js.configs.recommended.rules,
-      "no-console": ["error", { allow: ["error"] }],
+      "no-console": ["error", { allow: ["error", "warn"] }],
       eqeqeq: ["error", "always"],
 
       /**
@@ -70,6 +99,7 @@ const config = [
       "jsx-a11y": pluginJsxA11y,
       react: pluginReact,
       "react-hooks": pluginReactHooks,
+      "react-refresh": pluginReactRefresh,
     },
     rules: {
       ...pluginReact.configs.recommended.rules,
@@ -162,8 +192,13 @@ const config = [
           argsIgnorePattern: "^_",
         },
       ],
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
     },
   },
+  ...pluginStorybookRecommended,
 ];
 
 export default config;

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "eslint-config-matsuri",
-  "version": "2.1.1-alpha-bd9aeba.0",
+  "version": "3.1.0",
   "type": "module",
   "description": "",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
     "test": "eslint . --max-warnings 0"
@@ -16,7 +18,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "peerDependencies": {
-    "eslint": "8.43.0"
+    "eslint": "^8.43.0"
   },
   "devDependencies": {
     "@emotion/react": "11.11.1",
@@ -34,7 +36,9 @@
     "eslint-plugin-jsx-a11y": "6.7.1",
     "eslint-plugin-react": "7.33.1",
     "eslint-plugin-react-hooks": "4.6.0",
+    "eslint-plugin-react-refresh": "0.4.4",
     "eslint-plugin-sort-imports-es6-autofix": "0.6.0",
+    "eslint-plugin-storybook": "0.6.15",
     "eslint-plugin-unused-imports": "2.0.0"
   }
 }