@w5s/eslint-config 3.2.1 → 3.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/eslint-config",
-  "version": "3.2.1",
+  "version": "3.3.1",
   "description": "ESLint configuration presets",
   "keywords": [
     "eslint",
@@ -21,10 +21,6 @@
   "type": "module",
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      },
       "import": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
@@ -42,26 +38,55 @@
     "!**/__tests__/**"
   ],
   "scripts": {
-    "postpack": "npx clean-package restore"
+    "build": "npx run-p \"build:*\"",
+    "build:tsc": "node --experimental-strip-types scripts/typegen.ts && tsup",
+    "clean": "npx run-p \"clean:*\"",
+    "clean:tsc": "rm -rf dist",
+    "docs": "node ../../markdown.mjs",
+    "format": "npx run-p \"format:*\"",
+    "format:src": "eslint . --fix",
+    "lint": "npx run-p \"lint:*\"",
+    "lint:src": "eslint .",
+    "postpack": "npx clean-package restore",
+    "prepack": "npx clean-package",
+    "prepare": "npx run-p \"prepare:*\"",
+    "prepare:empty": ":",
+    "prepublishOnly": "npm run clean;npm run build",
+    "spellcheck": "cspell --no-progress '**'",
+    "test": "npx run-p \"test:*\"",
+    "test:script": "scripts/test",
+    "test_:rule-coverage": "eslint-find-rules --unused"
   },
   "dependencies": {
     "@stylistic/eslint-plugin": "^5.0.0",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",
     "@vitest/eslint-plugin": "^1.0.0",
-    "@w5s/dev": "^3.1.2",
-    "@w5s/prettier-config": "^3.0.3",
+    "@w5s/dev": "^3.1.3",
+    "@w5s/prettier-config": "^3.0.5",
     "eslint-plugin-import": "^2.25.0",
-    "eslint-plugin-jsdoc": "^61.0.0",
+    "eslint-plugin-jsdoc": "^62.0.0",
     "eslint-plugin-jsonc": "^2.4.0",
     "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-unicorn": "^62.0.0",
-    "eslint-plugin-yml": "^1.1.0",
+    "eslint-plugin-yml": "^2.0.0",
     "find-up": "^8.0.0",
     "globals": "^17.0.0",
     "jsonc-eslint-parser": "^2.0.0",
     "parse-gitignore": "^2.0.0",
-    "yaml-eslint-parser": "^1.0.0"
+    "yaml-eslint-parser": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/eslint": "9.6.1",
+    "@types/parse-gitignore": "1.0.2",
+    "@types/react": "19.2.14",
+    "@typescript-eslint/parser": "8.56.0",
+    "eslint": "9.39.2",
+    "eslint-find-rules": "5.0.0",
+    "eslint-typegen": "2.3.0",
+    "react": "19.2.4",
+    "vite": "7.3.1",
+    "vitest": "4.0.18"
   },
   "peerDependencies": {
     "eslint": "9.x",
@@ -75,6 +100,7 @@
       "optional": true
     }
   },
+  "clean-package": "../../clean-package.config.mjs",
   "engines": {
     "node": ">=20.0.0"
   },
@@ -82,5 +108,5 @@
     "access": "public"
   },
   "sideEffect": false,
-  "gitHead": "648be101c2d4f915b97ed7e318da47a6ac19eb5c"
+  "gitHead": "550810ad9a8d35378bb00361cd0080bd67058fc5"
 }

package/src/config/es.ts

@@ -3,14 +3,11 @@ import eslintConfig from '@eslint/js';
 import { Project } from '@w5s/dev';
 import { type PluginOptionsBase, type Config } from '../type.js';
 import type { RuleOptions } from '../typegen/jsonc.js';
-import { createRules } from './createRules.js';
 import { esRules } from '../rules/esRules.js';
 
 const defaultFiles = [`**/${Project.extensionsToGlob(Project.queryExtensions(['javascript', 'javascriptreact']))}`];
 
-export async function es(
-  options: es.Options,
-) {
+export async function es(options: es.Options) {
   const { rules = {} } = options;
 
   return [
@@ -47,7 +44,6 @@ export async function es(
       files: defaultFiles,
       rules: {
         ...eslintConfig.configs.recommended.rules,
-        ...createRules(''),
         ...esRules(),
         ...rules,
       },

package/src/config/ts.ts

@@ -2,7 +2,7 @@
 import { ESLintConfig, interopDefault, Project } from '@w5s/dev';
 import { StylisticConfig, type PluginOptionsBase, type Config } from '../type.js';
 import type { RuleOptions } from '../typegen/ts.js';
-import { createRules } from './createRules.js';
+import { tsRules } from '../rules/tsRules.js';
 
 const defaultFiles = [`**/${Project.extensionsToGlob(Project.queryExtensions(['typescript', 'typescriptreact']))}`];
 
@@ -45,48 +45,26 @@ export async function ts(options: ts.Options = {}) {
       },
       name: 'w5s/ts/rules',
       rules: {
-        ...ESLintConfig.renameRules(
-          tsRecommendedRules,
-          { '@typescript-eslint': 'ts' },
-        ),
-        ...ESLintConfig.renameRules(
-          tsStrictRules,
-          { '@typescript-eslint': 'ts' },
-        ),
-        'ts/ban-ts-comment': [
-          'warn',
-          {
-            'minimumDescriptionLength': 3,
-            'ts-check': false,
-            'ts-expect-error': 'allow-with-description',
-            'ts-ignore': 'allow-with-description',
-            'ts-nocheck': true,
-          },
-        ],
-        'ts/no-empty-object-type': 'off',
-        'ts/no-explicit-any': 'off', // if any is explicit then it's wanted
-        'ts/no-namespace': 'off', // We don't agree with community, namespaces are great and not deprecated
-        ...createRules('ts/'),
-        ...(stylisticEnabled
-          ? {}
-          : {}),
+        ...ESLintConfig.renameRules(tsRecommendedRules, { '@typescript-eslint': 'ts' }),
+        ...ESLintConfig.renameRules(tsStrictRules, { '@typescript-eslint': 'ts' }),
+        ...tsRules(),
+        ...(stylisticEnabled ? {} : {}),
         ...rules,
       },
     },
     ...(typeChecked
-      ? [{
-          files: defaultFiles,
-          // ignores: ignoresTypeAware,
-          name: 'w5s/ts/rules-type-checked',
-          rules: {
-            ...ESLintConfig.renameRules(
-              tsTypeCheckedRules,
-              { '@typescript-eslint': 'ts' },
-            ),
+      ? ([
+          {
+            files: defaultFiles,
+            // ignores: ignoresTypeAware,
+            name: 'w5s/ts/rules-type-checked',
+            rules: {
+              ...ESLintConfig.renameRules(tsTypeCheckedRules, { '@typescript-eslint': 'ts' }),
+            },
           },
-        }] as const
+        ] as const)
       : []),
-  ] as ([Config, Config] | [Config, Config, Config]) satisfies Array<Config>;
+  ] as [Config, Config] | [Config, Config, Config] satisfies Array<Config>;
 }
 export namespace ts {
   export type Rules = RuleOptions;

package/src/defineConfig.ts

@@ -14,9 +14,15 @@ export interface DefineConfigOptions extends ignores.Options {
 }
 
 export async function defineConfig(options: DefineConfigOptions = {}) {
-  const stylisticOptions = typeof options.stylistic === 'boolean' ? { enabled: options.stylistic } : { enabled: true, ...options.stylistic };
-  const withDefaultStylistic = <T>(options: T) => ({ stylistic: stylisticOptions, ...options });
-  const toOption = <T extends {}>(optionsOrBoolean: T | boolean | undefined) => withDefaultStylistic((typeof optionsOrBoolean === 'boolean' ? { enabled: optionsOrBoolean } : ({ enabled: true, ...optionsOrBoolean })) as T & { enabled: boolean });
+  const stylisticOptions =
+    typeof options.stylistic === 'boolean' ? { enabled: options.stylistic } : { enabled: true, ...options.stylistic };
+  const withDefaultStylistic = <T>(_options: T) => ({ stylistic: stylisticOptions, ..._options });
+  const toOption = <T extends {}>(optionsOrBoolean: T | boolean | undefined) =>
+    withDefaultStylistic(
+      (typeof optionsOrBoolean === 'boolean'
+        ? { enabled: optionsOrBoolean }
+        : { enabled: true, ...optionsOrBoolean }) as T & { enabled: boolean },
+    );
   const esOptions = toOption(options.es);
   const importOptions = toOption(options.import);
   const jsdocOptions = toOption(options.jsdoc);

package/src/rules/tsRules.ts

@@ -0,0 +1,132 @@
+import { ESLintConfig } from '@w5s/dev';
+import { esRules } from './esRules.js';
+
+export const tsRules = () => {
+  const baseRules = esRules();
+
+  return ESLintConfig.renameRules(
+    {
+      // '@typescript-eslint/comma-dangle': [
+      //   baseRules['comma-dangle'][0],
+      //   {
+      //     ...baseRules['comma-dangle'][1],
+      //     enums: baseRules['comma-dangle'][1].arrays,
+      //     generics: baseRules['comma-dangle'][1].arrays,
+      //     tuples: baseRules['comma-dangle'][1].arrays,
+      //   },
+      // ],
+      '@typescript-eslint/adjacent-overload-signatures': 'error',
+      '@typescript-eslint/ban-ts-comment': [
+        'warn',
+        {
+          'minimumDescriptionLength': 3,
+          'ts-check': false,
+          'ts-expect-error': 'allow-with-description',
+          'ts-ignore': 'allow-with-description',
+          'ts-nocheck': true,
+        },
+      ],
+      // '@typescript-eslint/brace-style': baseRules['brace-style'],
+      // '@typescript-eslint/comma-dangle': [
+      //   baseRules['comma-dangle'][0],
+      //   {
+      //     ...baseRules['comma-dangle'][1],
+      //     enums: baseRules['comma-dangle'][1].arrays,
+      //     generics: baseRules['comma-dangle'][1].arrays,
+      //     tuples: baseRules['comma-dangle'][1].arrays,
+      //   },
+      // ],
+      // '@typescript-eslint/comma-spacing': baseRules['comma-spacing'],
+      '@typescript-eslint/consistent-type-assertions': [
+        'error',
+        { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' },
+      ],
+      '@typescript-eslint/default-param-last': baseRules['default-param-last'],
+      // '@typescript-eslint/dot-notation': baseRules['dot-notation'], // TODO: Stylistic typechecked
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      // '@typescript-eslint/func-call-spacing': baseRules['func-call-spacing'],
+      // '@typescript-eslint/indent': baseRules.indent,
+      // '@typescript-eslint/keyword-spacing': baseRules['keyword-spacing'],
+      // '@typescript-eslint/lines-between-class-members': baseRules['lines-between-class-members'],
+      // '@typescript-eslint/member-delimiter-style': 'error', // TODO: @stylistic/member-delimiter-style
+      '@typescript-eslint/naming-convention': [
+        'error',
+        // {
+        //   format: ['PascalCase', 'camelCase'],
+        //   leadingUnderscore: 'allow',
+        //   selector: 'default',
+        //   trailingUnderscore: 'allow',
+        // },
+        {
+          format: ['PascalCase', 'camelCase', 'UPPER_CASE'],
+          leadingUnderscore: 'allow',
+          selector: 'variable',
+          trailingUnderscore: 'allow',
+        },
+        // {
+        //   format: ['PascalCase', 'camelCase', 'UPPER_CASE'],
+        //   leadingUnderscore: 'allowSingleOrDouble',
+        //   selector: 'memberLike',
+        //   trailingUnderscore: 'allowDouble',
+        // },
+        {
+          format: ['PascalCase'],
+          selector: 'typeLike',
+        },
+      ],
+      // '@typescript-eslint/no-array-constructor': baseRules['no-array-constructor'],
+      // '@typescript-eslint/no-base-to-string': 'error', // TODO: require type check
+      '@typescript-eslint/no-dupe-class-members': baseRules['no-dupe-class-members'],
+      '@typescript-eslint/no-empty-function': baseRules['no-empty-function'],
+      '@typescript-eslint/no-empty-interface': ['error', { allowSingleExtends: true }],
+      '@typescript-eslint/no-empty-object-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off', // if any is explicit then it's wanted
+      '@typescript-eslint/no-extra-parens': baseRules['no-extra-parens'],
+      // '@typescript-eslint/no-extra-semi': baseRules['no-extra-semi'], // TODO: @stylistic/no-extra-semi
+      '@typescript-eslint/no-inferrable-types': 'error',
+      '@typescript-eslint/no-loop-func': baseRules['no-loop-func'],
+      '@typescript-eslint/no-loss-of-precision': baseRules['no-loss-of-precision'],
+      '@typescript-eslint/no-magic-numbers': baseRules['no-magic-numbers'],
+      '@typescript-eslint/no-misused-new': 'error',
+      '@typescript-eslint/no-namespace': 'off', // We don't agree with community, namespaces are great and not deprecated
+      '@typescript-eslint/no-non-null-assertion': 'error',
+      '@typescript-eslint/no-redeclare': ESLintConfig.fixme(baseRules['no-redeclare']),
+      '@typescript-eslint/no-require-imports': 'error',
+      '@typescript-eslint/no-shadow': baseRules['no-shadow'],
+      '@typescript-eslint/no-this-alias': 'error',
+      // '@typescript-eslint/no-unnecessary-condition': 'error',// TODO: require type check
+      // '@typescript-eslint/no-unsafe-argument': 'error', // TODO: recommended type check
+      '@typescript-eslint/no-unused-expressions': baseRules['no-unused-expressions'],
+      '@typescript-eslint/no-unused-vars': baseRules['no-unused-vars'],
+      '@typescript-eslint/no-use-before-define': baseRules['no-use-before-define'],
+      '@typescript-eslint/no-useless-constructor': baseRules['no-useless-constructor'],
+      '@typescript-eslint/no-var-requires': 'error',
+      '@typescript-eslint/no-wrapper-object-types': 'error',
+      // '@typescript-eslint/object-curly-spacing': baseRules['object-curly-spacing'],
+      // '@typescript-eslint/only-throw-error': baseRules['no-throw-literal'], //TODO: Recommended type check
+      '@typescript-eslint/prefer-namespace-keyword': 'error',
+      // '@typescript-eslint/prefer-reduce-type-parameter': 'error', // TODO: strict type check
+      // '@typescript-eslint/quotes': baseRules.quotes,
+      '@typescript-eslint/require-await': baseRules['require-await'],
+      // '@typescript-eslint/return-await': baseRules['no-return-await'], // TODO: strict type check
+      // '@typescript-eslint/semi': baseRules.semi,
+      // '@typescript-eslint/space-before-function-paren': baseRules['space-before-function-paren'],
+      // '@typescript-eslint/space-infix-ops': baseRules['space-infix-ops'],
+      // '@typescript-eslint/strict-boolean-expressions': [
+      //   'error',
+      //   {
+      //     allowNullableObject: false,
+      //     allowNumber: false,
+      //     allowString: false,
+      //   },
+      // ], //TODO: require typing
+      // '@typescript-eslint/switch-exhaustiveness-check': 'error',//TODO: require type check
+      '@typescript-eslint/triple-slash-reference': 'error',
+      // '@typescript-eslint/type-annotation-spacing': 'error',// TODO: @stylistic/type-annotation-spacing
+    },
+    {
+      '@typescript-eslint': 'ts',
+    },
+  );
+};

package/src/typegen/jsdoc.d.ts

@@ -1156,6 +1156,8 @@ type JsdocTypeFormatting = []|[{
   
   objectFieldSeparatorTrailingPunctuation?: boolean
   
+  objectTypeBracketSpacing?: string
+  
   parameterDefaultValueSpacing?: string
   
   postMethodNameSpacing?: string
@@ -1166,6 +1168,8 @@ type JsdocTypeFormatting = []|[{
   
   stringQuotes?: ("double" | "single")
   
+  trailingPunctuationMultilineOnly?: boolean
+  
   typeBracketSpacing?: string
   
   unionSpacing?: string

package/src/typegen/node.d.ts

@@ -165,6 +165,11 @@ export interface RuleOptions {
    * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/console.md
    */
   'node/prefer-global/console'?: Linter.RuleEntry<NodePreferGlobalConsole>
+  /**
+   * enforce either `crypto` or `require("crypto").webcrypto`
+   * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/crypto.md
+   */
+  'node/prefer-global/crypto'?: Linter.RuleEntry<NodePreferGlobalCrypto>
   /**
    * enforce either `process` or `require("process")`
    * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/process.md
@@ -180,6 +185,11 @@ export interface RuleOptions {
    * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/text-encoder.md
    */
   'node/prefer-global/text-encoder'?: Linter.RuleEntry<NodePreferGlobalTextEncoder>
+  /**
+   * enforce either global timer functions or `require("timers")`
+   * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/timers.md
+   */
+  'node/prefer-global/timers'?: Linter.RuleEntry<NodePreferGlobalTimers>
   /**
    * enforce either `URL` or `require("url").URL`
    * @see https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/url.md
@@ -488,12 +498,16 @@ type NodeNoUnsupportedFeaturesNodeBuiltins = []|[{
 type NodePreferGlobalBuffer = []|[("always" | "never")]
 // ----- node/prefer-global/console -----
 type NodePreferGlobalConsole = []|[("always" | "never")]
+// ----- node/prefer-global/crypto -----
+type NodePreferGlobalCrypto = []|[("always" | "never")]
 // ----- node/prefer-global/process -----
 type NodePreferGlobalProcess = []|[("always" | "never")]
 // ----- node/prefer-global/text-decoder -----
 type NodePreferGlobalTextDecoder = []|[("always" | "never")]
 // ----- node/prefer-global/text-encoder -----
 type NodePreferGlobalTextEncoder = []|[("always" | "never")]
+// ----- node/prefer-global/timers -----
+type NodePreferGlobalTimers = []|[("always" | "never")]
 // ----- node/prefer-global/url -----
 type NodePreferGlobalUrl = []|[("always" | "never")]
 // ----- node/prefer-global/url-search-params -----

package/src/typegen/style.d.ts

@@ -79,6 +79,11 @@ export interface RuleOptions {
    * @see https://eslint.style/rules/eol-last
    */
   'style/eol-last'?: Linter.RuleEntry<StyleEolLast>
+  /**
+   * Enforce consistent line break styles for JSX props
+   * @see https://eslint.style/rules/jsx-props-style
+   */
+  'style/exp-jsx-props-style'?: Linter.RuleEntry<StyleExpJsxPropsStyle>
   /**
    * Enforce consistent spacing and line break styles inside brackets.
    * @see https://eslint.style/rules/list-style
@@ -676,15 +681,25 @@ type StyleCurlyNewline = []|[(("always" | "never") | {
 type StyleDotLocation = []|[("object" | "property")]
 // ----- style/eol-last -----
 type StyleEolLast = []|[("always" | "never" | "unix" | "windows")]
+// ----- style/exp-jsx-props-style -----
+type StyleExpJsxPropsStyle = []|[{
+  singleLine?: {
+    maxItems?: number
+  }
+  multiLine?: {
+    minItems?: number
+    maxItemsPerLine?: number
+  }
+}]
 // ----- style/exp-list-style -----
 type StyleExpListStyle = []|[{
   singleLine?: _StyleExpListStyle_SingleLineConfig
   multiLine?: _StyleExpListStyle_MultiLineConfig
   overrides?: {
+    "()"?: _StyleExpListStyle_BaseConfig
     "[]"?: _StyleExpListStyle_BaseConfig
     "{}"?: _StyleExpListStyle_BaseConfig
     "<>"?: _StyleExpListStyle_BaseConfig
-    "()"?: _StyleExpListStyle_BaseConfig
     ArrayExpression?: _StyleExpListStyle_BaseConfig
     ArrayPattern?: _StyleExpListStyle_BaseConfig
     ArrowFunctionExpression?: _StyleExpListStyle_BaseConfig
@@ -692,21 +707,22 @@ type StyleExpListStyle = []|[{
     ExportNamedDeclaration?: _StyleExpListStyle_BaseConfig
     FunctionDeclaration?: _StyleExpListStyle_BaseConfig
     FunctionExpression?: _StyleExpListStyle_BaseConfig
-    ImportDeclaration?: _StyleExpListStyle_BaseConfig
+    IfStatement?: _StyleExpListStyle_BaseConfig
     ImportAttributes?: _StyleExpListStyle_BaseConfig
+    ImportDeclaration?: _StyleExpListStyle_BaseConfig
+    JSONArrayExpression?: _StyleExpListStyle_BaseConfig
+    JSONObjectExpression?: _StyleExpListStyle_BaseConfig
     NewExpression?: _StyleExpListStyle_BaseConfig
     ObjectExpression?: _StyleExpListStyle_BaseConfig
     ObjectPattern?: _StyleExpListStyle_BaseConfig
     TSDeclareFunction?: _StyleExpListStyle_BaseConfig
+    TSEnumBody?: _StyleExpListStyle_BaseConfig
     TSFunctionType?: _StyleExpListStyle_BaseConfig
     TSInterfaceBody?: _StyleExpListStyle_BaseConfig
-    TSEnumBody?: _StyleExpListStyle_BaseConfig
     TSTupleType?: _StyleExpListStyle_BaseConfig
     TSTypeLiteral?: _StyleExpListStyle_BaseConfig
     TSTypeParameterDeclaration?: _StyleExpListStyle_BaseConfig
     TSTypeParameterInstantiation?: _StyleExpListStyle_BaseConfig
-    JSONArrayExpression?: _StyleExpListStyle_BaseConfig
-    JSONObjectExpression?: _StyleExpListStyle_BaseConfig
   }
 }]
 interface _StyleExpListStyle_SingleLineConfig {

package/src/typegen/ts.d.ts

@@ -476,7 +476,7 @@ export interface RuleOptions {
    * Disallow default values that will never be used
    * @see https://typescript-eslint.io/rules/no-useless-default-assignment
    */
-  'ts/no-useless-default-assignment'?: Linter.RuleEntry<[]>
+  'ts/no-useless-default-assignment'?: Linter.RuleEntry<TsNoUselessDefaultAssignment>
   /**
    * Disallow empty exports that don't change anything in a module file
    * @see https://typescript-eslint.io/rules/no-useless-empty-export
@@ -1583,6 +1583,11 @@ type TsNoUseBeforeDefine = []|[("nofunc" | {
   
   variables?: boolean
 })]
+// ----- ts/no-useless-default-assignment -----
+type TsNoUselessDefaultAssignment = []|[{
+  
+  allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing?: boolean
+}]
 // ----- ts/no-var-requires -----
 type TsNoVarRequires = []|[{
   

package/src/config/createRules.ts

@@ -1,9 +0,0 @@
-import { ESLintConfig } from '@w5s/dev';
-
-export function createRules(prefix: string) {
-  return ESLintConfig.renameRules({
-    'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-  }, {
-    '': prefix,
-  });
-}