eslint-config-matsuri 0.0.0 → 1.0.0

package/README.md

@@ -1 +1,35 @@
-# eslint-config-matsuri
+# eslint-config-matsuri
+
+React/TypeScriptを利用しているリポジトリで共通して使えるESLintのConfigです。
+
+当社以外での理由は想定していません。
+
+## Motivation
+
+- 各リポジトリでESLintの設定を更新しなくていいようにする。
+- 簡単に設定ができるようにする。
+- 頻出するwarningをerrorかoffに分類し、方針を明確にする
+
+## Installation
+
+ESLintを除く依存関係を別途インストールする必要はありません。既に入っている場合は、削除してください。
+
+```sh
+yarn add eslint eslint-config-matsuri
+```
+
+設定ファイルは次の記述のみで良くなります。他の記述は削除してください。
+
+```js
+/** @type {import('eslint').Linter.BaseConfig} */
+const config = {
+  extends: ["matsuri"],
+};
+
+module.exports = config;
+```
+
+## Contributing
+
+ルールの検証などを行いたい場合は、tests以下にファイルを配置してください。
+Errorが出てほしい記述には、`// eslint-disable-next-line`コメントを付けておくことで、`yarn test`コマンドで確認できるようになります。

package/index.js

@@ -24,7 +24,6 @@ const config = {
       extends: [
         "plugin:react/recommended",
         "plugin:react-hooks/recommended",
-        "plugin:import/recommended",
         "plugin:import/typescript",
         "plugin:react/jsx-runtime",
         "plugin:@typescript-eslint/recommended",
@@ -54,8 +53,12 @@ const config = {
             html: true,
           },
         ],
+        "react/prop-types": "off",
+        "react/display-name": "off",
+        "react-hooks/exhaustive-deps": "error",
 
         "jsx-a11y/click-events-have-key-events": "off",
+        "jsx-a11y/no-autofocus": "off",
       },
     },
   ],

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "eslint-config-matsuri",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "",
   "main": "index.js",
+  "files": [
+    "index.js"
+  ],
   "scripts": {
     "test": "eslint . --max-warnings 0"
   },
@@ -15,6 +18,7 @@
     "eslint": ">= 8"
   },
   "devDependencies": {
+    "@emotion/react": "^11.9.3",
     "@types/react": "^18.0.14",
     "eslint": "8.18.0",
     "react": "^18.2.0",
@@ -22,7 +26,7 @@
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "5.30.0",
-    "@typescript-eslint/parser": "5.30.0",
+    "@typescript-eslint/parser": "5.30.5",
     "eslint-config-prettier": "8.5.0",
     "eslint-import-resolver-typescript": "^3.2.4",
     "eslint-plugin-css-reorder": "0.5.1",

package/.eslintrc.js

@@ -1 +0,0 @@
-module.exports = require("./index");

package/.github/workflows/test.yml

@@ -1,37 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [16]
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.2
-        with:
-          version: 7
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Cache node_modules
-        id: node_modules_cache_id
-        uses: actions/cache@v2
-        with:
-          key: node-${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
-          path: |
-            node_modules
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-        env:
-          CI: true
-      - run: pnpm run test

package/tests/console.ts

@@ -1,4 +0,0 @@
-// eslint-disable-next-line no-console
-console.log("log");
-
-console.error("error");

package/tests/jsx-a11y-alt-text.tsx

@@ -1,4 +0,0 @@
-// eslint-disable-next-line jsx-a11y/alt-text
-export const Incorrect = () => <img src="hoge.png" />;
-
-export const Correct = () => <img src="hoge.png" alt="hoge" />;

package/tests/jsx-a11y-interactive-supports-focus.tsx

@@ -1,19 +0,0 @@
-export const Incorrect = () => (
-  // eslint-disable-next-line jsx-a11y/interactive-supports-focus
-  <div
-    onClick={(event) => {
-      window.alert(event.currentTarget);
-    }}
-    role="button"
-  />
-);
-
-export const Correct = () => (
-  <div
-    onClick={(event) => {
-      window.alert(event.currentTarget);
-    }}
-    role="button"
-    tabIndex={0}
-  />
-);

package/tests/mocks/deprecated-function.ts

@@ -1,6 +0,0 @@
-/**
- * @deprecated This is a deprecated function.
- */
-export const deprecated = () => {
-  return "deprecated";
-};

package/tests/no-deprecated.ts

@@ -1,5 +0,0 @@
-// eslint-disable-next-line import/no-deprecated
-import { deprecated } from "./mocks/deprecated-function";
-
-// eslint-disable-next-line import/no-deprecated
-deprecated();

package/tests/no-unused-vars.ts

@@ -1,31 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import React, { useState } from "react";
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const MyComponent = ({ hoge }) => {
-  return "Hello, World";
-};
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const MyComponent2 = ({ hoge, ...props }) => {
-  return props;
-};
-
-export const MyComponent3 = ({ hoge: _hoge, ...props }) => {
-  return props;
-};
-
-try {
-  1 + 1;
-} catch (error) {
-  1 + 1;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-(function (foo, bar, baz, qux) {
-  return bar;
-})();
-
-(function (foo, bar, baz, qux) {
-  return qux;
-})();

package/tests/react-self-closing-comp.tsx

@@ -1,19 +0,0 @@
-export const ImaginaryChild = () => <div />;
-
-export const IncorrectParentWithImaginaryChild = () => {
-  // eslint-disable-next-line react/self-closing-comp
-  return <ImaginaryChild></ImaginaryChild>;
-};
-
-export const NonImaginaryChild = ({ children }: { children?: string }) => (
-  <div>{children}</div>
-);
-
-export const CorrectParent = () => {
-  return <NonImaginaryChild>Hello</NonImaginaryChild>;
-};
-
-export const IncorrectParentWithNonImaginaryChild = () => {
-  // eslint-disable-next-line react/self-closing-comp
-  return <NonImaginaryChild></NonImaginaryChild>;
-};