@kikiutils/eslint-config 9.3.2 → 10.1.0

package/src/base.ts

@@ -2,10 +2,22 @@ import type {
     Rules,
     TypedFlatConfigItem,
 } from '@antfu/eslint-config';
+import {
+    GLOB_JS,
+    GLOB_JSX,
+    GLOB_TESTS,
+    GLOB_TS,
+    GLOB_TSX,
+} from '@antfu/eslint-config';
 // @ts-expect-error No declare file.
 import promise from 'eslint-plugin-promise';
 
+import {
+    jsdocSettings,
+    typescriptJsdocConfig,
+} from './_internals/jsdoc';
 import { customPlugins } from './_internals/plugins';
+import { createTypeAwareConfig } from './_internals/type-aware';
 
 // Constants/Variables
 const basePerfectionistSortOptions = {
@@ -13,6 +25,18 @@ const basePerfectionistSortOptions = {
     type: 'natural',
 } as const;
 
+const vscodeOrderSensitiveArrayProperties = [
+    'args',
+    'autoAttachSmartPattern',
+    'dependsOn',
+    'options',
+    'outFiles',
+    'problemMatcher',
+    'resolveSourceMapLocations',
+    'runtimeArgs',
+    'skipFiles',
+].join('|');
+
 // Functions
 export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFlatConfigItem[] {
     return [
@@ -21,19 +45,19 @@ export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFl
             rules: {
                 'e18e/ban-dependencies': [
                     'error',
-                    {
-                        allowed: [
-                            'axios',
-                            'rimraf',
-                        ],
-                    },
+                    { allowed: ['axios'] },
                 ],
-                'e18e/prefer-static-regex': ['off'],
+                'e18e/prefer-static-regex': 'off',
             },
         },
-        // JavaScript
+        // JavaScript and TypeScript
         {
-            files: ['**/*.{cjs,js,mjs}'],
+            files: [
+                GLOB_JS,
+                GLOB_JSX,
+                GLOB_TS,
+                GLOB_TSX,
+            ],
             plugins: {
                 kikiutils: customPlugins,
                 promise,
@@ -45,19 +69,19 @@ export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFl
                     'always',
                 ],
             },
+            settings: jsdocSettings,
         },
         // TypeScript
         {
-            files: ['**/*.{ts,tsx}'],
-            plugins: {
-                kikiutils: customPlugins,
-                promise,
-            },
+            files: [
+                GLOB_TS,
+                GLOB_TSX,
+            ],
             rules: {
-                ...createBaseRules(environment),
-                'node/prefer-global/process': [
+                ...typescriptJsdocConfig.rules,
+                'ts/array-type': [
                     'error',
-                    'always',
+                    { default: 'array-simple' },
                 ],
                 'ts/consistent-generic-constructors': [
                     'error',
@@ -65,8 +89,67 @@ export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFl
                 ],
                 'ts/no-redeclare': 'off',
             },
+            settings: typescriptJsdocConfig.settings,
+        },
+        // Type-aware TypeScript
+        {
+            ...createTypeAwareConfig(),
+            files: [
+                GLOB_TS,
+                GLOB_TSX,
+            ],
+            ignores: ['**/*.config.?([cm])ts'],
+        },
+        // Tests
+        {
+            files: GLOB_TESTS,
+            rules: {
+                'kikiutils/consistent-parameter-layout': [
+                    'error',
+                    { compactTestCalls: true },
+                ],
+                'no-restricted-imports': [
+                    'error',
+                    {
+                        paths: [
+                            {
+                                importNames: ['expect'],
+                                message: 'Use `expect` from the test context.',
+                                name: 'vitest',
+                            },
+                        ],
+                    },
+                ],
+                'test/consistent-each-for': [
+                    'error',
+                    {
+                        it: 'for',
+                        test: 'for',
+                    },
+                ],
+                'test/prefer-each': 'error',
+                'test/prefer-hooks-on-top': 'error',
+                'test/prefer-lowercase-title': [
+                    'error',
+                    {
+                        ignoreTopLevelDescribe: true,
+                        lowercaseFirstCharacterOnly: true,
+                    },
+                ],
+                'test/prefer-to-be': 'error',
+                'test/valid-describe-callback': 'error',
+                'test/valid-expect': 'error',
+                'test/valid-expect-in-promise': 'error',
+                'test/valid-title': [
+                    'error',
+                    {
+                        mustMatch: { it: '^should ' },
+                        mustNotMatch: { it: String.raw`\.$` },
+                    },
+                ],
+            },
         },
-        // VsCode jsonc
+        // VS Code JSONC
         {
             files: ['**/.vscode/*.json'],
             rules: {
@@ -77,7 +160,8 @@ export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFl
                             natural: true,
                             type: 'asc',
                         },
-                        pathPattern: '^.*$',
+                        // Preserve ordered fields and any argument or option arrays nested inside them.
+                        pathPattern: String.raw`^(?!.*(?:^|\.|\[")(?:${vscodeOrderSensitiveArrayProperties})(?:$|\.|\[|"\])).*`,
                     },
                 ],
                 'jsonc/sort-keys': [
@@ -90,6 +174,8 @@ export function createBaseConfigs(environment: 'bun' | 'node' = 'node'): TypedFl
                 ],
             },
         },
+        // Ignore all extracted Markdown code blocks, but keep linting Markdown itself.
+        { ignores: ['**/*.md/**'] },
     ];
 }
 
@@ -114,6 +200,27 @@ export function createBaseRules(environment: 'bun' | 'node' = 'node'): Rules {
             'error',
             'multi-line',
         ],
+        'jsdoc/check-tag-names': 'error',
+        'jsdoc/multiline-blocks': [
+            'error',
+            {
+                noSingleLineBlocks: true,
+                singleLineTags: [
+                    'type',
+                    'import',
+                ],
+            },
+        ],
+        'jsdoc/no-blank-blocks': [
+            'error',
+            { enableFixer: true },
+        ],
+        'jsdoc/require-asterisk-prefix': 'error',
+        'jsdoc/require-hyphen-before-param-description': [
+            'error',
+            'always',
+            { tags: { typeParam: 'always' } },
+        ],
         'kikiutils/compact-iteration-layout': 'error',
         'kikiutils/consistent-condition-layout': 'error',
         'kikiutils/consistent-parameter-layout': 'error',
@@ -122,10 +229,12 @@ export function createBaseRules(environment: 'bun' | 'node' = 'node'): Rules {
             'error',
             1,
         ],
+        'no-constant-binary-expression': 'error',
         'no-promise-executor-return': [
             'error',
             { allowVoid: true },
         ],
+        'no-useless-assignment': 'error',
         'perfectionist/sort-array-includes': [
             'error',
             basePerfectionistSortOptions,
@@ -139,10 +248,7 @@ export function createBaseRules(environment: 'bun' | 'node' = 'node'): Rules {
         ],
         'perfectionist/sort-heritage-clauses': [
             'error',
-            {
-                ignoreCase: false,
-                type: 'natural',
-            },
+            basePerfectionistSortOptions,
         ],
         'perfectionist/sort-imports': [
             'error',
@@ -259,6 +365,7 @@ export function createBaseRules(environment: 'bun' | 'node' = 'node'): Rules {
             'error',
             basePerfectionistSortOptions,
         ],
+        'preserve-caught-error': 'error',
         'promise/no-multiple-resolved': 'error',
         'promise/no-return-in-finally': 'error',
         'promise/no-return-wrap': 'error',
@@ -299,6 +406,8 @@ export function createBaseRules(environment: 'bun' | 'node' = 'node'): Rules {
             {
                 code: 120,
                 comments: 120,
+                ignoreStrings: true,
+                ignoreTemplateLiterals: true,
             },
         ],
         'style/member-delimiter-style': [

package/src/style.ts

@@ -1,7 +1,7 @@
 import type { TypedFlatConfigItem } from '@antfu/eslint-config';
 import format from 'eslint-plugin-format';
 
-function createPrettierCssConfig(parser: 'css' | 'sass' | 'scss'): TypedFlatConfigItem {
+function createPrettierCssConfig(parser: 'css' | 'scss'): TypedFlatConfigItem {
     return {
         files: [`**/*.${parser}`],
         languageOptions: { parser: format.parserPlain },
@@ -23,7 +23,6 @@ function createPrettierCssConfig(parser: 'css' | 'sass' | 'scss'): TypedFlatConf
 export function createStyleFilesConfigs(): TypedFlatConfigItem[] {
     return [
         createPrettierCssConfig('css'),
-        createPrettierCssConfig('sass'),
         createPrettierCssConfig('scss'),
     ];
 }

package/src/vue.ts

@@ -1,23 +1,29 @@
 import type { TypedFlatConfigItem } from '@antfu/eslint-config';
 import kikiutilsEslintPluginVue from '@kikiutils/eslint-plugin-vue';
-import betteTailwindcss from 'eslint-plugin-better-tailwindcss';
+import betterTailwindcss from 'eslint-plugin-better-tailwindcss';
 // @ts-expect-error No declare file.
 import promise from 'eslint-plugin-promise';
 
+import { typescriptJsdocConfig } from './_internals/jsdoc';
 import { customPlugins } from './_internals/plugins';
+import { createTypeAwareConfig } from './_internals/type-aware';
 import { createBaseRules } from './base';
 
 export function createVueConfig(environment: 'bun' | 'node' = 'node'): TypedFlatConfigItem {
+    const typeAwareConfig = createTypeAwareConfig();
     return {
         files: ['**/*.vue'],
+        languageOptions: typeAwareConfig.languageOptions,
         plugins: {
             '@kikiutils/vue': kikiutilsEslintPluginVue,
-            'better-tailwindcss': betteTailwindcss,
+            'better-tailwindcss': betterTailwindcss,
             'kikiutils': customPlugins,
             promise,
         },
         rules: {
             ...createBaseRules(environment),
+            ...typescriptJsdocConfig.rules,
+            ...typeAwareConfig.rules,
             '@kikiutils/vue/attributes-order': [
                 'error',
                 {
@@ -35,6 +41,10 @@ export function createVueConfig(environment: 'bun' | 'node' = 'node'): TypedFlat
             'better-tailwindcss/no-duplicate-classes': 'error',
             'better-tailwindcss/no-unnecessary-whitespace': 'error',
             'style/max-len': 'off',
+            'ts/array-type': [
+                'error',
+                { default: 'array-simple' },
+            ],
             'vue/attribute-hyphenation': 'error',
             'vue/attributes-order': 'off',
             'vue/block-order': [
@@ -69,6 +79,8 @@ export function createVueConfig(environment: 'bun' | 'node' = 'node'): TypedFlat
                 {
                     code: 120,
                     comments: 120,
+                    ignoreStrings: true,
+                    ignoreTemplateLiterals: true,
                     template: 120,
                 },
             ],
@@ -80,9 +92,9 @@ export function createVueConfig(environment: 'bun' | 'node' = 'node'): TypedFlat
             'vue/no-template-target-blank': 'error',
             'vue/no-v-html': 'error',
             'vue/prefer-define-options': 'error',
-            'vue/prefer-separate-static-class': 'error',
             'vue/require-explicit-emits': 'error',
             'vue/require-typed-ref': 'error',
         },
+        settings: typescriptJsdocConfig.settings,
     };
 }