@ocavue/eslint-config 2.21.0 → 3.0.1

package/dist/index.d.ts

@@ -1,10 +1,4 @@
 import { type ESLintConfigOptions } from './options.js';
 import type { Config } from './types.js';
-export * from './basic.js';
-export * from './markdown.js';
-export * from './prettier.js';
-export * from './react.js';
-export * from './typescript.js';
-export * from './vue.js';
 export type { Config, ESLintConfigOptions };
 export declare function defineESLintConfig(options?: ESLintConfigOptions, ...userConfigs: Config[]): Promise<Config[]>;

package/dist/index.js

@@ -1,11 +1,6 @@
 import { defineConfig } from 'eslint/config';
 import { resolveOptions } from './options.js';
-export * from './basic.js';
-export * from './markdown.js';
-export * from './prettier.js';
-export * from './react.js';
-export * from './typescript.js';
-export * from './vue.js';
+import { trueToUndefined } from './shared.js';
 export async function defineESLintConfig(options, ...userConfigs) {
     const resolvedOptions = resolveOptions(options);
     const configs = [];
@@ -68,6 +63,3 @@ export async function defineESLintConfig(options, ...userConfigs) {
     configs.push(...userConfigs);
     return defineConfig(configs);
 }
-function trueToUndefined(value) {
-    return value === true ? undefined : value;
-}

package/dist/markdown.js

@@ -1,41 +1,27 @@
 import markdownPlugin from '@eslint/markdown';
+import tseslint from 'typescript-eslint';
 import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js';
 export function markdown() {
-    const recommended = markdownPlugin.configs.processor;
-    const extra = {
+    const processor = markdownPlugin.configs.processor;
+    // @ts-expect-error: unmatched type: https://github.com/typescript-eslint/typescript-eslint/issues/10899
+    const disableTypeCheckedBase = tseslint.configs.disableTypeChecked;
+    const disableTypeChecked = {
+        ...disableTypeCheckedBase,
+        name: 'ocavue/markdown/disable-type-checked',
+        files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, `${GLOB_MARKDOWN}/${GLOB_VUE}`],
+    };
+    const disableExtra = {
+        name: 'ocavue/markdown/disable-rules',
         files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, `${GLOB_MARKDOWN}/${GLOB_VUE}`],
-        languageOptions: {
-            parserOptions: {
-                projectService: null,
-            },
-        },
         rules: {
-            // Disable type-aware TypeScript rules, because the code blocks are not
-            // part of a compilable `tsconfig.json` project.
-            '@typescript-eslint/no-redeclare': 'off',
-            '@typescript-eslint/no-unused-vars': 'off',
-            '@typescript-eslint/no-use-before-define': 'off',
-            '@typescript-eslint/no-var-requires': 'off',
-            '@typescript-eslint/restrict-plus-operands': 'off',
-            '@typescript-eslint/no-unsafe-call': 'off',
-            '@typescript-eslint/no-unsafe-return': 'off',
-            '@typescript-eslint/no-unsafe-argument': 'off',
-            '@typescript-eslint/no-unsafe-member-access': 'off',
-            '@typescript-eslint/no-unsafe-assignment': 'off',
-            '@typescript-eslint/no-floating-promises': 'off',
-            '@typescript-eslint/no-misused-promises': 'off',
-            '@typescript-eslint/await-thenable': 'off',
-            '@typescript-eslint/unbound-method': 'off',
-            '@typescript-eslint/require-await': 'off',
-            '@typescript-eslint/no-unnecessary-type-assertion': 'off',
             // Disable some import rules because they are not working well with
             // twoslash ---cut--- imports.
             'import/first': 'off',
             'import/order': 'off',
             'no-alert': 'off',
             'no-console': 'off',
-            'no-restricted-imports': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
         },
     };
-    return [...recommended, extra];
+    return [...processor, disableTypeChecked, disableExtra];
 }

package/dist/shared.d.ts

@@ -21,3 +21,7 @@ export declare const GLOB_NODE_MODULES: "**/node_modules";
 export declare const GLOB_LOCKFILE: readonly ["**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml"];
 export declare const GLOB_EXCLUDE: readonly ["**/node_modules", "**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml", "**/fixtures", "**/.changeset", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__", "**/.tsup"];
 export declare const EXTENSIONS: string[];
+export declare function findConfigByName<T extends {
+    name?: string;
+}>(configs: T[], name: string): T | undefined;
+export declare function trueToUndefined<T>(value: T | true): T | undefined;

package/dist/shared.js

@@ -47,3 +47,13 @@ export const EXTENSIONS = ['ts', 'js']
     .flatMap((ext) => [ext, ext + 'x'])
     .flatMap((ext) => [ext, 'm' + ext, 'c' + ext])
     .flatMap((ext) => [ext, 'd.' + ext]);
+export function findConfigByName(configs, name) {
+    const config = configs.find((c) => c.name === name);
+    if (!config) {
+        console.error(`[@ocavue/eslint-config] Unable to find config with name ${name}`);
+    }
+    return config;
+}
+export function trueToUndefined(value) {
+    return value === true ? undefined : value;
+}

package/dist/types.d.ts

@@ -1,2 +1,3 @@
 import type { Linter } from 'eslint';
 export type Config = Linter.Config;
+export type Rules = Partial<Linter.RulesRecord>;

package/dist/typescript.js

@@ -1,112 +1,142 @@
-import eslint from '@eslint/js';
 import tseslint from 'typescript-eslint';
-import { GLOB_JS, GLOB_JSX, GLOB_TEST, GLOB_TS, GLOB_TSX } from './shared.js';
+import { findConfigByName, GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX, } from './shared.js';
 export { tseslint };
-export function typescript() {
-    const rules = [...tseslint.configs.recommended, ...tseslint.configs.stylistic]
-        .map((config) => config.rules || {})
-        .reduce((acc, cur) => ({ ...acc, ...cur }), {});
-    const config = [
-        eslint.configs.recommended,
-        {
-            name: 'typescript',
-            files: [GLOB_TS, GLOB_TSX, GLOB_JS, GLOB_JSX],
-            languageOptions: {
-                parser: tseslint.parser,
-                parserOptions: {
-                    projectService: true,
-                    sourceType: 'module',
-                    ecmaVersion: 'latest',
-                },
+function eslintRecommendedRules() {
+    return tseslint.configs.eslintRecommended.rules || {};
+}
+function recommendedRules() {
+    const configs = [...tseslint.configs.recommended];
+    const config = findConfigByName(configs, 'typescript-eslint/recommended');
+    // https://github.com/typescript-eslint/typescript-eslint/blob/v8.32.1/packages/eslint-plugin/src/configs/flat/recommended.ts#L25
+    const rules = config?.rules || {};
+    // @keep-sorted
+    return {
+        ...rules,
+        // `type T1 = T0` and `interface T2 extends T0 {}` have the same meaning
+        // but different behavior in TypeScript type checking. `T1` and `T0` are
+        // the same type, while `T2` is different than `T0`. We allow `interface
+        // T2 extends T0 {}` explicitly.
+        '@typescript-eslint/no-empty-object-type': [
+            'error',
+            {
+                allowInterfaces: 'with-single-extends',
             },
-            plugins: {
-                '@typescript-eslint': tseslint.plugin,
+        ],
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                argsIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+                caughtErrorsIgnorePattern: '^_',
             },
-            rules: {
-                ...rules,
-                '@typescript-eslint/consistent-type-definitions': 'off',
-                '@typescript-eslint/prefer-optional-chain': 'off',
-                '@typescript-eslint/prefer-nullish-coalescing': 'off',
-                '@typescript-eslint/consistent-indexed-object-style': 'off',
-                '@typescript-eslint/array-type': 'off',
-                '@typescript-eslint/dot-notation': 'off',
-                '@typescript-eslint/triple-slash-reference': 'off',
-                '@typescript-eslint/consistent-type-imports': [
-                    'warn',
-                    {
-                        // Allow type imports in type annotations (e.g. `type T = import('Foo').Foo`)
-                        disallowTypeAnnotations: false,
-                    },
-                ],
-                '@typescript-eslint/no-import-type-side-effects': 'warn',
-                '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
-                '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'warn',
-                '@typescript-eslint/restrict-plus-operands': 'warn',
-                '@typescript-eslint/no-unsafe-call': 'warn',
-                '@typescript-eslint/no-unsafe-return': 'warn',
-                '@typescript-eslint/no-unsafe-argument': 'warn',
-                '@typescript-eslint/no-unsafe-member-access': 'warn',
-                '@typescript-eslint/no-unsafe-assignment': 'warn',
-                '@typescript-eslint/no-floating-promises': 'warn',
-                '@typescript-eslint/no-explicit-any': 'warn',
-                '@typescript-eslint/explicit-module-boundary-types': 'off',
-                '@typescript-eslint/no-non-null-assertion': 'off',
-                '@typescript-eslint/restrict-template-expressions': 'off',
-                '@typescript-eslint/no-unused-vars': [
-                    'error',
-                    {
-                        argsIgnorePattern: '^_',
-                        varsIgnorePattern: '^_',
-                        caughtErrorsIgnorePattern: '^_',
-                    },
-                ],
-                '@typescript-eslint/no-extra-semi': 'off',
-                '@typescript-eslint/prefer-function-type': 'warn',
-                '@typescript-eslint/no-misused-promises': [
-                    'error',
-                    { checksVoidReturn: false },
-                ],
-                '@typescript-eslint/await-thenable': 'error',
-                '@typescript-eslint/unbound-method': 'error',
-                // `type T1 = T0` and `interface T2 extends T0 {}` have the same meaning
-                // but different behavior in TypeScript type checking. `T1` and `T0` are
-                // the same type, while `T2` is different than `T0`. We allow `interface
-                // T2 extends T0 {}` explicitly.
-                '@typescript-eslint/no-empty-object-type': [
-                    'error',
-                    {
-                        allowInterfaces: 'with-single-extends',
-                    },
-                ],
-                // Turn off this rule because it's incompatible with the `--isolatedDeclarations` compiler option.
-                '@typescript-eslint/no-inferrable-types': 'off',
-                // TODO: We should set the rule below to error in the future
-                '@typescript-eslint/require-await': 'warn',
+        ],
+        '@typescript-eslint/triple-slash-reference': 'off',
+    };
+}
+function recommendedTypeCheckedOnlyRules() {
+    const configs = [...tseslint.configs.recommendedTypeCheckedOnly];
+    const config = findConfigByName(configs, 'typescript-eslint/recommended-type-checked-only');
+    // https://github.com/typescript-eslint/typescript-eslint/blob/v8.32.1/packages/eslint-plugin/src/configs/flat/recommended-type-checked-only.ts#L25
+    const rules = config?.rules || {};
+    // @keep-sorted
+    return {
+        ...rules,
+        '@typescript-eslint/no-floating-promises': 'warn',
+        '@typescript-eslint/no-misused-promises': [
+            'error',
+            { checksVoidReturn: false },
+        ],
+        '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
+        '@typescript-eslint/no-unsafe-argument': 'warn',
+        '@typescript-eslint/no-unsafe-assignment': 'warn',
+        '@typescript-eslint/no-unsafe-call': 'warn',
+        '@typescript-eslint/no-unsafe-member-access': 'warn',
+        '@typescript-eslint/no-unsafe-return': 'warn',
+        '@typescript-eslint/restrict-template-expressions': 'off',
+    };
+}
+function stylisticRules() {
+    const configs = [...tseslint.configs.stylistic];
+    const config = findConfigByName(configs, 'typescript-eslint/stylistic');
+    // https://github.com/typescript-eslint/typescript-eslint/blob/v8.32.1/packages/eslint-plugin/src/configs/flat/stylistic.ts#L25
+    const rules = config?.rules || {};
+    // @keep-sorted
+    return {
+        ...rules,
+        '@typescript-eslint/array-type': 'off',
+        '@typescript-eslint/consistent-indexed-object-style': 'off',
+        '@typescript-eslint/consistent-type-definitions': 'off',
+        '@typescript-eslint/no-empty-function': 'off',
+        // Turn off this rule because it's incompatible with the `--isolatedDeclarations` compiler option.
+        '@typescript-eslint/no-inferrable-types': 'off',
+        '@typescript-eslint/prefer-for-of': 'off',
+        '@typescript-eslint/prefer-function-type': 'warn',
+    };
+}
+function commonRules() {
+    return {
+        ...eslintRecommendedRules,
+        ...recommendedRules(),
+    };
+}
+function tsOnlyRules() {
+    // @keep-sorted
+    return {
+        ...recommendedTypeCheckedOnlyRules(),
+        ...stylisticRules(),
+        '@typescript-eslint/consistent-type-imports': [
+            'warn',
+            {
+                // Allow type imports in type annotations (e.g. `type T = import('Foo').Foo`)
+                disallowTypeAnnotations: false,
             },
-        },
-        {
-            name: 'typescript-js',
-            files: [GLOB_JS, GLOB_JSX],
-            rules: {
-                '@typescript-eslint/no-require-imports': 'off',
-                '@typescript-eslint/no-var-requires': 'off',
+        ],
+        '@typescript-eslint/no-import-type-side-effects': 'warn',
+        '@typescript-eslint/no-mixed-enums': 'error',
+        '@typescript-eslint/no-unnecessary-parameter-property-assignment': 'warn',
+        '@typescript-eslint/return-await': ['error', 'always'],
+    };
+}
+function jsOnlyRules() {
+    // @keep-sorted
+    return {
+        '@typescript-eslint/no-require-imports': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+    };
+}
+export function typescript() {
+    const base = {
+        name: 'ocavue/typescript/base',
+        files: [GLOB_TS, GLOB_TSX, GLOB_JS, GLOB_JSX],
+        languageOptions: {
+            parser: tseslint.parser,
+            parserOptions: {
+                projectService: true,
+                warnOnUnsupportedTypeScriptVersion: false,
+                sourceType: 'module',
             },
         },
-        {
-            name: 'typescript-test',
-            files: [GLOB_TEST],
-            rules: {
-                '@typescript-eslint/no-unsafe-call': 'warn',
-                '@typescript-eslint/no-unsafe-return': 'warn',
-                '@typescript-eslint/no-unsafe-argument': 'warn',
-                '@typescript-eslint/no-unsafe-member-access': 'warn',
-                '@typescript-eslint/no-unsafe-assignment': 'warn',
-                '@typescript-eslint/no-explicit-any': 'off',
-                '@typescript-eslint/no-empty-function': 'off',
-            },
+        plugins: {
+            '@typescript-eslint': tseslint.plugin,
         },
-    ];
+    };
+    const common = {
+        name: 'ocavue/typescript/rules',
+        files: [GLOB_TS, GLOB_TSX, GLOB_JS, GLOB_JSX],
+        rules: commonRules(),
+    };
+    const ts = {
+        name: 'ocavue/typescript/ts-only-rules',
+        files: [GLOB_TS, GLOB_TSX],
+        rules: tsOnlyRules(),
+    };
+    const js = {
+        name: 'ocavue/typescript/js-only-rules',
+        files: [GLOB_JS, GLOB_JSX],
+        rules: jsOnlyRules(),
+    };
     // @ts-expect-error: unmatched type
-    const configTyped = config;
-    return configTyped;
+    const configs = [base, common, ts, js];
+    return configs;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "2.21.0",
+  "version": "3.0.1",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -28,7 +28,7 @@
     "dist"
   ],
   "dependencies": {
-    "@eslint/js": "^9.26.0",
+    "@eslint/js": "^9.27.0",
     "@eslint/markdown": "^6.4.0",
     "@unocss/eslint-config": "^66.1.2",
     "eslint-config-flat-gitignore": "^2.1.0",
@@ -51,7 +51,7 @@
     "@ocavue/tsconfig": "^0.3.7",
     "@types/node": "^20.17.9",
     "@typescript-eslint/utils": "^8.32.1",
-    "eslint": "^9.26.0",
+    "eslint": "^9.27.0",
     "jiti": "^2.4.2",
     "pkg-pr-new": "^0.0.50",
     "prettier": "^3.5.3",

package/dist/basic.d.ts

@@ -1,2 +0,0 @@
-import type { Linter } from 'eslint';
-export declare function basic(): Linter.Config[];

package/dist/basic.js

@@ -1,22 +0,0 @@
-import { antfu } from './antfu.js';
-import { ignores } from './ignores.js';
-import { imports } from './imports.js';
-import { noOnlyTests } from './no-only-tests.js';
-import { packageJson } from './package-json.js';
-import { prettier } from './prettier.js';
-import { typescript } from './typescript.js';
-import { unicorn } from './unicorn.js';
-import { gitignore } from './gitignore.js';
-export function basic() {
-    return [
-        ...ignores(),
-        ...gitignore(),
-        ...typescript(),
-        ...imports(),
-        ...packageJson(),
-        ...unicorn(),
-        ...antfu(),
-        ...noOnlyTests(),
-        ...prettier(),
-    ];
-}