@aiou/eslint-config 2.2.0 → 3.0.1

package/dist/index.mjs

@@ -10,7 +10,6 @@ import pluginN from 'eslint-plugin-n';
 import pluginPromise from 'eslint-plugin-promise';
 import globals from 'globals';
 import pluginJsonc from 'eslint-plugin-jsonc';
-import jsoncParser from 'jsonc-eslint-parser';
 import pluginMarkdown from '@eslint/markdown';
 import pluginNext from '@next/eslint-plugin-next';
 import pluginProgress from '@aiou/eslint-plugin-progress';
@@ -20,12 +19,12 @@ import pluginReactRefresh from 'eslint-plugin-react-refresh';
 import { configs } from 'eslint-plugin-regexp';
 import pluginStylistic from '@stylistic/eslint-plugin';
 import { createRequire } from 'node:module';
+import pluginToml from 'eslint-plugin-toml';
 import pluginTypeScript from '@typescript-eslint/eslint-plugin';
 import tsParser from '@typescript-eslint/parser';
 import pluginETC from 'eslint-plugin-etc';
 import pluginUnicorn from 'eslint-plugin-unicorn';
-import pluginYaml from 'eslint-plugin-yml';
-import yamlParser from 'yaml-eslint-parser';
+import pluginYml from 'eslint-plugin-yml';
 
 const comments = () => {
   const config = [
@@ -506,23 +505,11 @@ const javascript = () => {
 
 const jsonc = () => {
   const config = [
-    {
-      files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
-      ignores: [GLOB_CLAUDE_JSON],
-      name: "jsonc/setup",
-      languageOptions: {
-        parser: jsoncParser
-      },
-      plugins: {
-        jsonc: pluginJsonc
-      }
-    },
+    ...pluginJsonc.configs["recommended-with-jsonc"],
     {
       files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
       ignores: [GLOB_CLAUDE_JSON],
       rules: {
-        ...pluginJsonc.configs["recommended-with-jsonc"].rules,
-        // refs: https://ota-meshi.github.io/eslint-plugin-jsonc/rules/indent.html
         "jsonc/array-bracket-newline": [
           "error",
           {
@@ -601,8 +588,6 @@ const jsonc = () => {
           },
           {
             pathPattern: "^exports.*$",
-            // According to webpack, default condition should be last item
-            // Typescript bugs: types should be first one
             order: ["types", "import", "require", "node", "browser", "default"]
           },
           {
@@ -616,7 +601,6 @@ const jsonc = () => {
         ]
       }
     },
-    // refs: https://github.com/sxzz/eslint-config/blob/main/src/configs/sort.ts
     {
       files: ["**/tsconfig.json", "**/tsconfig.*.json"],
       rules: {
@@ -743,14 +727,10 @@ const jsonc = () => {
 
 const markdown = () => {
   const config = [
-    ...pluginMarkdown.configs.processor.map((config2) => ({
-      ...config2
-    })),
+    ...pluginMarkdown.configs.processor,
     {
-      // Code blocks in markdown file
       files: [`${GLOB_MARKDOWN}/*.${GLOB_SCRIPT_EXT}`],
       rules: {
-        // https://eslint-react.xyz/docs/migration
         "react/no-missing-component-display-name": "off",
         "@typescript-eslint/no-redeclare": "off",
         "@typescript-eslint/no-unused-vars": "off",
@@ -768,7 +748,6 @@ const markdown = () => {
         "no-undef": "off",
         "no-unused-expressions": "off",
         "no-unused-vars": "off",
-        // Off imports
         "import/no-extraneous-dependencies": "off",
         "import/no-default-export": "off",
         "import/no-anonymous-default-export": "off",
@@ -788,7 +767,6 @@ const next = () => {
         "@next/next": pluginNext
       },
       rules: {
-        // Enable rules for next project
         ...pluginNext.configs.recommended.rules
       }
     }
@@ -824,7 +802,6 @@ function renameRules(rules, map) {
 }
 
 const react = () => {
-  const plugins = pluginReact.configs.all.plugins;
   const config = [
     {
       files: [GLOB_JSX, GLOB_TSX],
@@ -837,34 +814,29 @@ const react = () => {
         sourceType: "module"
       },
       settings: {
-        react: {
-          // 'detect' will throw warn on monorepo
+        "react-x": {
           version: "18.0"
         }
       },
       plugins: {
-        react: plugins["@eslint-react"],
-        "react-dom": plugins["@eslint-react/dom"],
+        react: pluginReact,
+        "react-dom": pluginReact,
         "react-hooks": pluginReactHooks,
-        "react-hooks-extra": plugins["@eslint-react/hooks-extra"],
-        "react-naming-convention": plugins["@eslint-react/naming-convention"],
+        "react-hooks-extra": pluginReact,
+        "react-naming-convention": pluginReact,
         "react-refresh": pluginReactRefresh,
-        "react-web-api": plugins["@eslint-react/web-api"]
+        "react-web-api": pluginReact
       },
       rules: {
-        ...renameRules(plugins["@eslint-react"].configs["recommended-typescript"].rules, { "react-x": "react" }),
-        ...renameRules(plugins["@eslint-react/dom"].configs.recommended.rules, { "@eslint-react": "react-dom" }),
-        ...renameRules(pluginReactHooks.configs.recommended.rules, { "@eslint-react": "react-hooks" }),
-        ...renameRules(plugins["@eslint-react/hooks-extra"].configs.recommended.rules, { "@eslint-react": "react-hooks-extra" }),
-        ...renameRules(plugins["@eslint-react/naming-convention"].configs.recommended.rules, { "@eslint-react": "react-naming-convention" }),
-        ...renameRules(plugins["@eslint-react/web-api"].configs.recommended.rules, { "@eslint-react": "react-web-api" }),
-        "react/no-prop-types": "error",
+        ...renameRules(pluginReact.configs["recommended-typescript"].rules, { "@eslint-react": "react" }),
+        ...renameRules(pluginReact.configs["dom"].rules, { "@eslint-react": "react-dom" }),
+        ...renameRules(pluginReact.configs["x"].rules, { "@eslint-react": "react-hooks-extra" }),
+        ...renameRules(pluginReact.configs["x"].rules, { "@eslint-react": "react-naming-convention" }),
+        ...renameRules(pluginReact.configs["web-api"].rules, { "@eslint-react": "react-web-api" }),
+        ...pluginReactHooks.configs.flat.recommended.rules,
         "react/no-nested-component-definitions": "warn",
         "react-dom/no-unknown-property": "off",
-        "react/avoid-shorthand-boolean": ["error"],
-        // https://github.com/ArnaudBarre/eslint-plugin-react-refresh
-        "react-refresh/only-export-components": "warn",
-        "react-hooks-extra/no-direct-set-state-in-use-effect": "off"
+        "react-refresh/only-export-components": "warn"
       }
     },
     {
@@ -885,9 +857,6 @@ const react = () => {
         `**/*{-entry,entry.}*.${GLOB_SCRIPT_EXT}`,
         GLOB_TEST_SCRIPT,
         GLOB_TEST_DIRS,
-        // With next.js pages will export getStaticProps funcs
-        // There are some bad cases for not all files are route files
-        // RECOMMEND: pages/routes should only contain page files
         GLOB_PAGES_DIRS
       ],
       ignores: [
@@ -913,8 +882,7 @@ const ssrReact = () => {
         sourceType: "module"
       },
       settings: {
-        react: {
-          // 'detect' will throw warn on monorepo
+        "react-x": {
           version: "18.0"
         }
       },
@@ -936,7 +904,7 @@ const ssrReact = () => {
             selector: "Identifier[name='window']:not(UnaryExpression[operator='typeof'] > Identifier)",
             message: `Direct window access not allowed. Use 'typeof window !== "undefined"' check first`
           },
-          // Document 对象
+          // Document
           {
             selector: "MemberExpression[object.name='document']:not(LogicalExpression[right=MemberExpression] > MemberExpression[object.name='document'])",
             message: `Use 'typeof document !== "undefined" && document.xxx' for safe DOM access`
@@ -945,27 +913,26 @@ const ssrReact = () => {
             selector: "Identifier[name='document']:not(UnaryExpression[operator='typeof'] > Identifier)",
             message: `Direct document access not allowed. Use 'typeof document !== "undefined"' check first`
           },
-          // Navigator 对象
+          // Navigator
           {
             selector: "MemberExpression[object.name='navigator']:not(LogicalExpression[right=MemberExpression] > MemberExpression[object.name='navigator'])",
             message: `Use 'typeof navigator !== "undefined" && navigator.xxx' for safe DOM access`
           },
-          // Location 对象
+          // Location
           {
             selector: "MemberExpression[object.name='location']:not(LogicalExpression[right=MemberExpression] > MemberExpression[object.name='location'])",
             message: `Use 'typeof location !== "undefined" && location.xxx' for safe DOM access`
           },
-          // History 对象
+          // History
           {
             selector: "MemberExpression[object.name='history']:not(LogicalExpression[right=MemberExpression] > MemberExpression[object.name='history'])",
             message: `Use 'typeof history !== "undefined" && history.xxx' for safe DOM access`
           },
-          // Storage 对象们
+          // Storage
           {
             selector: "MemberExpression[object.name='localStorage']:not(LogicalExpression[right=MemberExpression] > MemberExpression[object.name='localStorage'])",
             message: `Use 'typeof localStorage !== "undefined" && localStorage.xxx' for safe DOM access`
           },
-          // Fork from enum
           {
             selector: "TSEnumDeclaration",
             message: "Don't declare enums"
@@ -976,7 +943,6 @@ const ssrReact = () => {
     {
       files: [
         `**/*config*.${GLOB_SCRIPT_EXT}`,
-        // Client entry files not need to be SSR friendly
         `**/*{client-entry,entry.client}*.${GLOB_SCRIPT_EXT}`,
         GLOB_TEST_SCRIPT,
         GLOB_TEST_DIRS
@@ -1001,7 +967,7 @@ const ssrReact = () => {
 const regexp = () => {
   const config = [
     {
-      ...configs["flat/recommended"]
+      ...configs.recommended
     }
   ];
   return config;
@@ -1009,16 +975,19 @@ const regexp = () => {
 
 const stylistic = () => {
   const config = pluginStylistic.configs.customize({
-    flat: true,
     indent: 2,
     jsx: true,
     quotes: "single",
     semi: false
   });
   const off = {};
-  Object.keys(config.rules ?? {}).forEach((key) => {
-    off[key.replace("@stylistic/", "")] = "off";
-  });
+  for (const key of Object.keys(config.rules ?? {})) {
+    const bare = key.replace("@stylistic/", "");
+    if (bare === "function-call-spacing") {
+      continue;
+    }
+    off[bare] = "off";
+  }
   const configs = [
     {
       files: [GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX],
@@ -1031,7 +1000,6 @@ const stylistic = () => {
         "@stylistic/quotes": ["error", "single", { avoidEscape: true }],
         "@stylistic/quote-props": ["error", "as-needed"],
         "@stylistic/array-bracket-spacing": ["error", "never"],
-        // https://eslint.org/docs/latest/rules/brace-style#1tbs
         "@stylistic/brace-style": ["error", "1tbs"],
         "@stylistic/block-spacing": ["error", "always"],
         "@stylistic/comma-spacing": ["error", { before: false, after: true }],
@@ -1085,8 +1053,7 @@ const stylistic = () => {
         "@stylistic/operator-linebreak": ["error", "before"],
         "@stylistic/member-delimiter-style": ["error", { multiline: { delimiter: "none" } }],
         "@stylistic/type-annotation-spacing": ["error", {}],
-        // no-spaced-func alert -- https://eslint.org/docs/latest/rules/no-spaced-func
-        "@stylistic/func-call-spacing": ["error", "never"],
+        "@stylistic/function-call-spacing": ["error", "never"],
         "@stylistic/semi": ["error", "never"],
         "@stylistic/space-before-blocks": ["error", "always"],
         "@stylistic/space-before-function-paren": [
@@ -1106,8 +1073,6 @@ const stylistic = () => {
           { exceptAfterSingleLine: true }
         ],
         "@stylistic/jsx-quotes": ["error", "prefer-double"],
-        // React
-        // Enforce new line when declare jsx element e.g. const element = (\newline<div
         "@stylistic/jsx-wrap-multilines": [
           "warn",
           {
@@ -1121,15 +1086,10 @@ const stylistic = () => {
           }
         ],
         "@stylistic/jsx-closing-tag-location": "error",
-        // Enforce disallow </ div>
         "@stylistic/jsx-tag-spacing": ["error", { closingSlash: "never", beforeSelfClosing: "always", afterOpening: "never", beforeClosing: "allow" }],
         "@stylistic/jsx-max-props-per-line": ["warn", { maximum: 1, when: "multiline" }],
-        // indentLogicalExpressions will fix && element
-        "@stylistic/jsx-indent": ["warn", 2, { indentLogicalExpressions: true }],
         "@stylistic/jsx-indent-props": ["warn", 2],
-        // < and > should be on the same line(y-axis) if jsx is multiline
         "@stylistic/jsx-closing-bracket-location": ["warn", "tag-aligned"],
-        // Enforce new line when multiline props jsx
         "@stylistic/jsx-first-prop-new-line": ["warn", "multiline-multiprop"],
         "@stylistic/jsx-one-expression-per-line": "off"
       }
@@ -1153,6 +1113,35 @@ const tailwindcss = () => {
   return config;
 };
 
+const toml = () => {
+  const config = [
+    ...pluginToml.configs.recommended,
+    {
+      rules: {
+        "toml/comma-style": "error",
+        "toml/keys-order": "error",
+        "toml/no-space-dots": "error",
+        "toml/no-unreadable-number-separator": "error",
+        "toml/precision-of-fractional-seconds": "error",
+        "toml/precision-of-integer": "error",
+        "toml/tables-order": "error",
+        "toml/array-bracket-newline": "error",
+        "toml/array-bracket-spacing": "error",
+        "toml/array-element-newline": "error",
+        "toml/indent": ["error", 4],
+        "toml/inline-table-curly-spacing": "error",
+        "toml/key-spacing": "error",
+        "toml/padding-line-between-pairs": "error",
+        "toml/padding-line-between-tables": "error",
+        "toml/quoted-keys": "error",
+        "toml/spaced-comment": "error",
+        "toml/table-bracket-spacing": "error"
+      }
+    }
+  ];
+  return config;
+};
+
 const typescript = () => {
   const config = [
     {
@@ -1286,6 +1275,7 @@ const unicorn = () => {
         unicorn: pluginUnicorn
       },
       rules: {
+        ...pluginUnicorn.configs.recommended.rules,
         "unicorn/consistent-empty-array-spread": "error",
         "unicorn/error-message": "error",
         "unicorn/escape-case": "error",
@@ -1309,17 +1299,10 @@ const unicorn = () => {
 
 const yml = () => {
   const config = [
+    ...pluginYml.configs.standard,
     {
       files: [GLOB_YAML],
-      languageOptions: {
-        parser: yamlParser
-      },
-      plugins: {
-        yml: pluginYaml
-      },
       rules: {
-        ...pluginYaml.configs.standard.rules,
-        // yml
         "spaced-comment": "off",
         "yml/quotes": ["error", { prefer: "double", avoidEscape: false }],
         "yml/no-empty-document": "off"
@@ -1328,12 +1311,6 @@ const yml = () => {
     {
       files: [GLOB_WORKFLOW_YAML],
       rules: {
-        /**
-         * on:
-         *  push:
-         *  pull_request:
-         *   branches: []
-         */
         "yml/no-empty-mapping-value": "off"
       }
     }
@@ -1355,7 +1332,8 @@ const presetTypescript = [
 const presetLangsExtensions = [
   ...yml(),
   ...markdown(),
-  ...jsonc()
+  ...jsonc(),
+  ...toml()
 ];
 const presetDefault = [
   ...presetTypescript,

package/dts/configs/toml.d.ts

@@ -0,0 +1,2 @@
+import type { Config } from '../type';
+export declare const toml: () => Config[];

package/dts/globs.d.ts

@@ -6,6 +6,7 @@ export declare const GLOB_PAGES_COMPONENTS_DIRS = "**/{pages,routes}/components/
 export declare const GLOB_DTS = "**/*.d.ts";
 export declare const GLOB_TS = "**/*.?([cm])ts";
 export declare const GLOB_TSX = "**/*.?([cm])tsx";
+export declare const GLOB_TOML = "**/*.toml";
 export declare const GLOB_JS = "**/*.?([cm])js";
 export declare const GLOB_JSX = "**/*.?([cm])jsx";
 export declare const GLOB_JSON = "**/*.json";

package/dts/index.d.ts

@@ -1,5 +1,6 @@
-import { type Arrayable, type Awaitable, FlatConfigComposer } from 'eslint-flat-config-utils';
+import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import type { Linter } from 'eslint';
+import type { Arrayable, Awaitable } from 'eslint-flat-config-utils';
 import type { Config } from './type';
 import type { ConfigNames } from './typegen';
 export declare const all: Config[];