@slashnephy/eslint-config 2.3.203 → 3.0.1

package/src/base/javascript.ts

@@ -1,187 +1,225 @@
-import standard from 'eslint-config-standard'
+import eslint from '@eslint/js'
+// @ts-expect-error 型定義ファイルがない
+import eslintCommentsConfig from '@eslint-community/eslint-plugin-eslint-comments/configs'
+import importXPlugin from 'eslint-plugin-import-x'
+// @ts-expect-error 型定義ファイルがない
+import promisePlugin from 'eslint-plugin-promise'
+import unusedImportsPlugin from 'eslint-plugin-unused-imports'
+import tseslint, { config } from 'typescript-eslint'
 
-import type { Linter } from 'eslint'
-
-/**
- * JavaScript 関連の eslint プリセット
- */
-module.exports = {
-  extends: [
-    'plugin:eslint-comments/recommended',
-    'plugin:node/recommended',
-    'plugin:import/recommended',
-    'plugin:xss/recommended',
-  ],
-  plugins: ['import', 'promise', 'n', 'unused-imports'],
-  env: {
-    node: true,
-    es2022: true,
+export const javaScript = config(
+  {
+    files: ['**/*.cjs'],
+    languageOptions: {
+      sourceType: 'commonjs',
+    },
+  },
+  {
+    files: ['**/*.{js,mjs,jsx}'],
+    languageOptions: {
+      sourceType: 'module',
+    },
   },
-  parserOptions: {
-    ecmaVersion: 'latest',
+
+  {
+    name: '@eslint/js',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    extends: [eslint.configs.recommended],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      parser: tseslint.parser,
+    },
+    rules: {
+      // アロー関数を優先
+      'prefer-arrow-callback': 'error',
+      // 関数宣言は function xxx() {} にする
+      'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
+      // 中括弧の省略を禁止
+      'curly': 'error',
+      // テンプレート文字列を優先
+      'prefer-template': 'error',
+      // == 比較 👉 === 比較
+      'eqeqeq': 'error',
+      // *.js で 'use strict'; を強制
+      'strict': ['error', 'global'],
+      // 特定の構文を禁止
+      'no-restricted-syntax': [
+        'error',
+        // 数値リテラル以外での Array#at() の使用を禁止
+        // https://qiita.com/printf_moriken/items/da03f55cb626617c1958
+        {
+          selector:
+            // eslint-disable-next-line @stylistic/quotes -- prettier と競合している
+            "CallExpression[callee.property.name='at']:not([arguments.0.type='Literal'],[arguments.0.type='UnaryExpression'][arguments.0.argument.type='Literal'])",
+          message: 'at method accepts only a literal argument',
+        },
+      ],
+      // foo["bar"] 👉 foo.bar
+      'dot-notation': 'error',
+      // {foo: foo} 👉 {foo}
+      'object-shorthand': ['error', 'always'],
+      // Array 系メソッドで return を強制
+      'array-callback-return': ['error'],
+      // ループ内では await を禁止
+      'no-await-in-loop': 'error',
+      // 操作が値に影響しない式を禁止
+      'no-constant-binary-expression': 'error',
+      // コンストラクター内で return を禁止
+      'no-constructor-return': 'error',
+      // 関数の返り値としての Promise executor を禁止
+      'no-promise-executor-return': 'error',
+      // 自身との比較 (e.g. foo === foo) を禁止
+      'no-self-compare': 'error',
+      // 非テンプレート文字列で ${foo} を禁止
+      // "Hello, ${name}" 👉 `Hello, ${name}`
+      'no-template-curly-in-string': 'error',
+      // 更新されないループ条件を禁止
+      'no-unmodified-loop-condition': 'error',
+      // 到達できないループを禁止
+      'no-unreachable-loop': 'error',
+      // 未使用の private メンバーを禁止
+      'no-unused-private-class-members': 'error',
+      // スレッドセーフで安全に更新されないコードを禁止
+      'require-atomic-updates': 'error',
+      // func () 👉 func()
+      'func-call-spacing': ['error', 'never'],
+      // ペアになっていない setter を禁止
+      'accessor-pairs': 'error',
+      // キャメルケースに強制しない
+      'camelcase': 'off',
+      // switch 文で default を強制しない
+      'default-case': 'off',
+      // continue 文を許可
+      'no-continue': 'off',
+      // _ で始まるメンバー名を許可
+      'no-underscore-dangle': 'off',
+      // 自身より後に宣言されたメンバーの使用を許可
+      'no-use-before-define': 'off',
+      // console.* の使用を許可
+      'no-console': 'off',
+      // 深い三項演算子を許可
+      'no-nested-ternary': 'off',
+      // i++ インクリメントを許可
+      'no-plusplus': 'off',
+      // return の省略などを許可
+      'consistent-return': 'off',
+      // 空行を挟む
+      'padding-line-between-statements': [
+        'warn',
+        // return 前に空行
+        { blankLine: 'always', prev: '*', next: 'return' },
+        // ディレクティブ後に空行
+        { blankLine: 'always', prev: 'directive', next: '*' },
+        { blankLine: 'any', prev: 'directive', next: 'directive' },
+      ],
+      // void Promise を許可
+      'no-void': 'off',
+      // 1 <= x < 10 を許可
+      'yoda': [
+        'error',
+        'never',
+        {
+          exceptRange: true,
+        },
+      ],
+    },
   },
-  globals: {
-    document: 'readonly',
-    navigator: 'readonly',
-    window: 'readonly',
+  {
+    name: '@eslint-community/eslint-plugin-eslint-comments',
+    extends: [eslintCommentsConfig.recommended],
   },
-  rules: {
-    ...standard.rules,
-    // 不要なルール無効化コメントを報告
-    'eslint-comments/no-unused-disable': 'error',
-    // default export を禁止
-    'import/no-default-export': 'error',
-    // アロー関数を優先
-    'prefer-arrow-callback': 'error',
-    // 関数宣言は function xxx() {} にする
-    'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-    // 中括弧の省略を禁止
-    curly: 'error',
-    // テンプレート文字列を優先
-    'prefer-template': 'error',
-    // == 比較 👉 === 比較
-    eqeqeq: 'error',
-    // *.js で 'use strict'; を強制
-    strict: ['error', 'global'],
-    // import 順を並び替える
-    'import/order': [
-      'warn',
-      {
-        // 組み込み → 外部依存 → 内部依存 → object → type の順にする
-        groups: [
-          'builtin',
-          'external',
-          ['parent', 'sibling', 'index'],
-          'object',
-          'type',
-          'unknown',
-        ],
-        // カテゴリー間に改行を入れる
-        'newlines-between': 'always',
-        // 大文字小文字区別なしで ABC 順にする
-        alphabetize: {
-          order: 'asc',
-          caseInsensitive: true,
+  {
+    name: 'eslint-plugin-import-x',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    extends: [importXPlugin.flatConfigs.recommended],
+    settings: {
+      'import-x/resolver': {
+        node: {
+          extensions: ['.js', '.cjs', '.mjs', '.jsx', '.ts', '.cts', '.mts', '.tsx', '.json'],
+        },
+        typescript: {
+          alwaysTryTypes: true,
         },
-        pathGroups: [
-          // **.css は最後に配置する
-          {
-            pattern: '**.css',
-            group: 'type',
-            position: 'after',
-          },
-        ],
-        // **.css が import 順最後ではないときに警告
-        warnOnUnassignedImports: true,
-      },
-    ],
-    // 不要 import 文を禁止
-    'unused-imports/no-unused-imports': 'error',
-    // 特定の構文を禁止
-    'no-restricted-syntax': [
-      'error',
-      // 数値リテラル以外での Array#at() の使用を禁止
-      // https://qiita.com/printf_moriken/items/da03f55cb626617c1958
-      {
-        selector:
-          // eslint-disable-next-line @stylistic/quotes -- prettier と競合している
-          "CallExpression[callee.property.name='at']:not([arguments.0.type='Literal'],[arguments.0.type='UnaryExpression'][arguments.0.argument.type='Literal'])",
-        message: 'at method accepts only a literal argument',
-      },
-    ],
-    // 非同期メソッドを優先
-    'node/prefer-promises/dns': 'error',
-    'node/prefer-promises/fs': 'error',
-    // 構文のバージョンチェックを無効化
-    'node/no-unsupported-features/es-syntax': 'off',
-    // 不正確な import チェックを無効化
-    'node/no-missing-import': 'off',
-    'node/no-extraneous-import': 'off',
-    'node/no-unpublished-import': 'off',
-    'import/no-import-module-exports': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    // foo["bar"] 👉 foo.bar
-    'dot-notation': 'error',
-    // {foo: foo} 👉 {foo}
-    'object-shorthand': ['error', 'always'],
-    // Array 系メソッドで return を強制
-    'array-callback-return': ['error'],
-    // ループ内では await を禁止
-    'no-await-in-loop': 'error',
-    // 操作が値に影響しない式を禁止
-    'no-constant-binary-expression': 'error',
-    // コンストラクター内で return を禁止
-    'no-constructor-return': 'error',
-    // 関数の返り値としての Promise executor を禁止
-    'no-promise-executor-return': 'error',
-    // 自身との比較 (e.g. foo === foo) を禁止
-    'no-self-compare': 'error',
-    // 非テンプレート文字列で ${foo} を禁止
-    // "Hello, ${name}" 👉 `Hello, ${name}`
-    'no-template-curly-in-string': 'error',
-    // 更新されないループ条件を禁止
-    'no-unmodified-loop-condition': 'error',
-    // 到達できないループを禁止
-    'no-unreachable-loop': 'error',
-    // 未使用の private メンバーを禁止
-    'no-unused-private-class-members': 'error',
-    // スレッドセーフで安全に更新されないコードを禁止
-    'require-atomic-updates': 'error',
-    // func () 👉 func()
-    'func-call-spacing': ['error', 'never'],
-    // ペアになっていない setter を禁止
-    'accessor-pairs': 'error',
-    // キャメルケースに強制しない
-    camelcase: 'off',
-    // switch 文で default を強制しない
-    'default-case': 'off',
-    // default export を優先しない
-    'import/prefer-default-export': 'off',
-    // 循環 import を禁止
-    'import/no-cycle': 'error',
-    // continue 文を許可
-    'no-continue': 'off',
-    // _ で始まるメンバー名を許可
-    'no-underscore-dangle': 'off',
-    // 自身より後に宣言されたメンバーの使用を許可
-    'no-use-before-define': 'off',
-    // console.* の使用を許可
-    'no-console': 'off',
-    // 深い三項演算子を許可
-    'no-nested-ternary': 'off',
-    // i++ インクリメントを許可
-    'no-plusplus': 'off',
-    // return の省略などを許可
-    'consistent-return': 'off',
-    // 空行を挟む
-    'padding-line-between-statements': [
-      'warn',
-      // return 前に空行
-      { blankLine: 'always', prev: '*', next: 'return' },
-      // ディレクティブ後に空行
-      { blankLine: 'always', prev: 'directive', next: '*' },
-      { blankLine: 'any', prev: 'directive', next: 'directive' },
-    ],
-    // void Promise を許可
-    'no-void': 'off',
-    // 1 <= x < 10 を許可
-    yoda: [
-      'error',
-      'never',
-      {
-        exceptRange: true,
-      },
-    ],
-    // 不要な変数を禁止
-    'unused-imports/no-unused-vars': [
-      'warn',
-      // '_' で始まる変数を許可
-      {
-        vars: 'all',
-        varsIgnorePattern: '^_',
-        args: 'after-used',
-        argsIgnorePattern: '^_',
       },
-    ],
+    },
+    rules: {
+      'import-x/no-import-module-exports': 'off',
+      'import-x/no-extraneous-dependencies': 'off',
+      // 循環 import を禁止
+      'import-x/no-cycle': 'error',
+      // default export を優先しない
+      'import-x/prefer-default-export': 'off',
+      // default export を禁止
+      'import-x/no-default-export': 'error',
+      // import 順を並び替える
+      'import-x/order': [
+        'warn',
+        {
+          // 組み込み → 外部依存 → 内部依存 → object → type の順にする
+          'groups': [
+            'builtin',
+            'external',
+            ['parent', 'sibling', 'index'],
+            'object',
+            'type',
+            'unknown',
+          ],
+          // カテゴリー間に改行を入れる
+          'newlines-between': 'always',
+          // 大文字小文字区別なしで ABC 順にする
+          'alphabetize': {
+            order: 'asc',
+            caseInsensitive: true,
+          },
+          'pathGroups': [
+            // **.css は最後に配置する
+            {
+              pattern: '**.css',
+              group: 'type',
+              position: 'after',
+            },
+          ],
+          // **.css が import 順最後ではないときに警告
+          'warnOnUnassignedImports': true,
+        },
+      ],
+    },
+  },
+  {
+    name: 'eslint-plugin-unused-imports',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    plugins: {
+      'unused-imports': unusedImportsPlugin,
+    },
+    rules: {
+      // 不要 import 文を禁止
+      'unused-imports/no-unused-imports': 'error',
+      // 不要な変数を禁止
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      'unused-imports/no-unused-vars': [
+        'warn',
+        // '_' で始まる変数を許可
+        {
+          vars: 'all',
+          varsIgnorePattern: '^_',
+          args: 'after-used',
+          argsIgnorePattern: '^_',
+        },
+      ],
+    },
+  },
+  {
+    name: 'eslint-plugin-promise',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    extends: [promisePlugin.configs['flat/recommended']],
+  },
+  {
+    name: 'eslint-plugin-xss',
+    files: ['**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+    // TODO: eslint-plugin-xss が Flat Configs に対応したら移行する
+    // https://github.com/Rantanen/eslint-plugin-xss/issues/15
+    // extends: ['plugin:xss/recommended'],
+    extends: [],
   },
-} satisfies Linter.Config
+)

package/src/base/package.json.js

@@ -0,0 +1,15 @@
+import packageJsonPlugin from 'eslint-plugin-package-json';
+import { config } from 'typescript-eslint';
+export const packageJson = config({
+    name: 'eslint-plugin-package-json',
+    files: ['**/package.json'],
+    extends: [packageJsonPlugin.configs.recommended],
+    rules: {
+        'package-json/order-properties': [
+            'error',
+            {
+                order: 'sort-package-json',
+            },
+        ],
+    },
+});

package/src/base/package.json.ts

@@ -0,0 +1,16 @@
+import packageJsonPlugin from 'eslint-plugin-package-json'
+import { config } from 'typescript-eslint'
+
+export const packageJson = config({
+  name: 'eslint-plugin-package-json',
+  files: ['**/package.json'],
+  extends: [packageJsonPlugin.configs.recommended],
+  rules: {
+    'package-json/order-properties': [
+      'error',
+      {
+        order: 'sort-package-json',
+      },
+    ],
+  },
+})

package/src/base/typescript.js

@@ -1,79 +1,85 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-module.exports = {
+import safeTypeScriptPlugin from '@susisu/eslint-plugin-safe-typescript';
+import importXPlugin from 'eslint-plugin-import-x';
+import tsdocPlugin from 'eslint-plugin-tsdoc';
+import tseslint, { config } from 'typescript-eslint';
+export const typeScript = config({
+    files: ['**/*.cts'],
+    languageOptions: {
+        sourceType: 'commonjs',
+    },
+}, {
+    files: ['**/*.{ts,mts,tsx}'],
+    languageOptions: {
+        sourceType: 'module',
+    },
+}, {
+    name: 'typescript-eslint',
+    files: ['**/*.{ts,cts,mts,tsx}'],
     extends: [
-        'plugin:@typescript-eslint/strict-type-checked',
-        'plugin:@typescript-eslint/stylistic-type-checked',
-        'plugin:@susisu/safe-typescript/recommended',
-        'plugin:import/typescript',
-        'plugin:no-void-return-type/recommended',
-        'plugin:storybook/recommended',
-    ],
-    plugins: [
-        '@typescript-eslint',
-        '@susisu/safe-typescript',
-        'tsdoc',
-        'deprecation',
+        tseslint.configs.recommendedTypeChecked,
+        tseslint.configs.stylisticTypeChecked,
     ],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        sourceType: 'module',
+    languageOptions: {
         ecmaVersion: 'latest',
-        lib: ['esnext'],
-        project: './tsconfig.json',
-        warnOnUnsupportedTypeScriptVersion: true,
-    },
-    settings: {
-        'import/parsers': {
-            '@typescript-eslint/parser': ['.ts', '.mts', '.cts', '.tsx', '.d.ts'],
-        },
-        'import/resolver': {
-            node: {
-                extensions: ['.js', '.jsx', '.ts', '.tsx'],
-            },
-            typescript: {
-                alwaysTryTypes: true,
-            },
+        parser: tseslint.parser,
+        parserOptions: {
+            projectService: true,
+            // tsconfigRootDir は利用側で定義する必要がある
+            // tsconfigRootDir: import.meta.dirname,
         },
     },
     rules: {
+        /**
+         * Automatically fixable は error にする
+         */
+        // interface 👉 type
         '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+        // export type を優先
         '@typescript-eslint/consistent-type-exports': [
             'error',
             {
                 fixMixedExportsWithInlineTypeSpecifier: true,
             },
         ],
+        // import type を優先
         '@typescript-eslint/consistent-type-imports': 'error',
+        // クラスのアクセス修飾子を強制
         '@typescript-eslint/explicit-member-accessibility': 'error',
+        // export されているメンバーや public メンバーは型を明示させる
         '@typescript-eslint/explicit-module-boundary-types': 'warn',
-        '@typescript-eslint/member-delimiter-style': 'error',
         '@typescript-eslint/member-ordering': 'warn',
         '@typescript-eslint/method-signature-style': ['warn', 'method'],
+        // 命名規則を強制
         '@typescript-eslint/naming-convention': [
             'warn',
+            // デフォルトは camelCase
             {
                 selector: ['default'],
                 format: ['strictCamelCase'],
             },
+            // 型名 / 列挙型のメンバーは PascalCase
             {
                 selector: ['typeLike', 'enumMember'],
                 format: ['StrictPascalCase'],
             },
+            // 変数名は camelCase
             {
                 selector: ['variableLike'],
                 format: ['strictCamelCase', 'StrictPascalCase'],
                 leadingUnderscore: 'allow',
             },
+            // インポート名は camelCase / PascalCase
             {
                 selector: ['import'],
                 format: ['camelCase', 'PascalCase'],
             },
+            // export された定数は UPPER_CASE を許容
             {
                 selector: ['variable'],
                 modifiers: ['const', 'global', 'exported'],
                 format: ['strictCamelCase', 'StrictPascalCase', 'UPPER_CASE'],
             },
+            // プロパティーに snake_case / UPPER_CASE を許容
             {
                 selector: ['property'],
                 format: [
@@ -83,6 +89,7 @@ module.exports = {
                     'StrictPascalCase',
                 ],
             },
+            // Boolean は特定のプレフィックスを強制
             {
                 selector: ['variable'],
                 types: ['boolean'],
@@ -104,28 +111,36 @@ module.exports = {
                     'hide',
                 ],
             },
+            // プライベートメンバーは _ で始める
             {
                 selector: ['memberLike'],
                 modifiers: ['private'],
                 format: ['strictCamelCase'],
                 leadingUnderscore: 'require',
             },
+            // deconstruct で宣言された変数は許容
             {
                 selector: ['variableLike'],
                 modifiers: ['destructured'],
                 format: null,
             },
+            // オブジェクトのキーなど '' 付きの宣言は許容
             {
                 selector: ['memberLike', 'property'],
                 modifiers: ['requiresQuotes'],
                 format: null,
             },
         ],
+        // void を式の値として禁止
         '@typescript-eslint/no-confusing-void-expression': 'error',
+        // 重複した型定義を禁止
+        // boolean | false 👉 boolean
         '@typescript-eslint/no-redundant-type-constituents': 'warn',
+        // require() を禁止
         '@typescript-eslint/no-require-imports': 'warn',
         '@typescript-eslint/no-unnecessary-qualifier': 'error',
         '@typescript-eslint/no-useless-empty-export': 'error',
+        // パラメーターでのプロパティ宣言を強制
         '@typescript-eslint/parameter-properties': [
             'warn',
             {
@@ -144,11 +159,11 @@ module.exports = {
         '@typescript-eslint/prefer-enum-initializers': 'warn',
         '@typescript-eslint/prefer-readonly': 'error',
         '@typescript-eslint/prefer-regexp-exec': 'error',
+        // Promise<T> を返す関数では async のマークを強制
         '@typescript-eslint/promise-function-async': 'error',
         '@typescript-eslint/switch-exhaustiveness-check': 'error',
-        '@typescript-eslint/type-annotation-spacing': 'error',
         '@typescript-eslint/unbound-method': 'off',
-        '@typescript-eslint/no-unused-vars': 'off',
+        // 過激なルールを無効化
         '@typescript-eslint/no-unsafe-assignment': 'off',
         '@typescript-eslint/no-unsafe-call': 'off',
         '@typescript-eslint/no-unsafe-member-access': 'off',
@@ -157,27 +172,56 @@ module.exports = {
         '@typescript-eslint/no-unsafe-enum-comparison': 'off',
         '@typescript-eslint/restrict-template-expressions': 'off',
         '@typescript-eslint/strict-boolean-expressions': 'off',
-        'import/extensions': [
-            'warn',
-            'always',
-            {
-                ignorePackages: true,
-            },
-        ],
-        'tsdoc/syntax': 'warn',
+        // enum のメンバーでビット演算を許可する
         '@typescript-eslint/prefer-literal-enum-member': [
             'error',
             {
                 allowBitwiseExpressions: true,
             },
         ],
-        'deprecation/deprecation': 'error',
+        // '1' + 2 を禁止
         '@typescript-eslint/restrict-plus-operands': 'error',
+        // 数値型の配列の sort() を禁止
         '@typescript-eslint/require-array-sort-compare': [
             'error',
             {
                 ignoreStringArrays: true,
             },
         ],
+        // Deprecated されたコードの使用を禁止
+        '@typescript-eslint/no-deprecated': 'error',
+        // 関数の返り値としての void 以外を禁止
+        '@typescript-eslint/no-invalid-void-type': 'error',
+    },
+}, {
+    name: 'eslint-plugin-import-x',
+    files: ['**/*.{ts,cts,mts,tsx}'],
+    extends: [importXPlugin.flatConfigs.typescript],
+    rules: {
+        // import に拡張子を推奨
+        'import-x/extensions': [
+            'warn',
+            'always',
+            {
+                ignorePackages: true,
+            },
+        ],
+    },
+}, {
+    name: '@susisu/eslint-plugin-safe-typescript',
+    files: ['**/*.{ts,cts,mts,tsx}'],
+    plugins: {
+        '@susisu/safe-typescript': safeTypeScriptPlugin,
+    },
+    rules: safeTypeScriptPlugin.configs.recommended.rules,
+}, {
+    name: 'eslint-plugin-tsdoc',
+    files: ['**/*.{ts,cts,mts,tsx}'],
+    plugins: {
+        tsdoc: tsdocPlugin,
+    },
+    rules: {
+        // TSDoc
+        'tsdoc/syntax': 'warn',
     },
-};
+});