feat: add name for each config item

antfu · antfu · commit d4cfef8e1eb9 · 2023-09-29T10:26:21.000+08:00
diff --git a/package.json b/package.json
@@ -64,6 +64,7 @@
   "devDependencies": {
     "@antfu/eslint-config": "workspace:*",
     "@antfu/ni": "^0.21.8",
+    "@types/eslint": "^8.44.3",
     "@types/fs-extra": "^11.0.2",
     "@types/node": "^20.7.1",
     "bumpp": "^9.2.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/configs/comments.ts b/src/configs/comments.ts
@@ -1,9 +1,10 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 import { pluginComments } from '../plugins'
 
 export function comments(): FlatESLintConfigItem[] {
   return [
     {
+      name: 'antfu:eslint-comments',
       plugins: {
         'eslint-comments': pluginComments,
       },
diff --git a/src/configs/ignores.ts b/src/configs/ignores.ts
@@ -1,8 +1,11 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 import { GLOB_EXCLUDE } from '../globs'
 
 export function ignores(): FlatESLintConfigItem[] {
   return [
-    { ignores: GLOB_EXCLUDE },
+    {
+      ignores: GLOB_EXCLUDE,
+      name: 'antfu:ignores:basic',
+    },
   ]
 }
diff --git a/src/configs/imports.ts b/src/configs/imports.ts
@@ -1,6 +1,5 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsStylistic } from '../types'
 import { pluginAntfu, pluginImport } from '../plugins'
-import type { OptionsStylistic } from '../types'
 
 export function imports(options: OptionsStylistic = {}): FlatESLintConfigItem[] {
   const {
@@ -9,6 +8,7 @@ export function imports(options: OptionsStylistic = {}): FlatESLintConfigItem[]
 
   return [
     {
+      name: 'antfu:imports',
       plugins: {
         antfu: pluginAntfu,
         import: pluginImport,
diff --git a/src/configs/javascript.ts b/src/configs/javascript.ts
@@ -1,8 +1,7 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
 import globals from 'globals'
+import type { FlatESLintConfigItem, OptionsIsInEditor, OptionsOverrides } from '../types'
 import { pluginAntfu, pluginUnusedImports } from '../plugins'
 import { OFF } from '../flags'
-import type { OptionsIsInEditor, OptionsOverrides } from '../types'
 import { GLOB_SRC, GLOB_SRC_EXT } from '../globs'
 
 export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}): FlatESLintConfigItem[] {
@@ -32,6 +31,7 @@ export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}):
         },
         sourceType: 'module',
       },
+      name: 'antfu:javascript',
       plugins: {
         'antfu': pluginAntfu,
         'unused-imports': pluginUnusedImports,
@@ -231,6 +231,7 @@ export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}):
     },
     {
       files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
+      name: 'antfu:scripts-overrides',
       rules: {
         'no-console': OFF,
       },
diff --git a/src/configs/jsdoc.ts b/src/configs/jsdoc.ts
@@ -1,6 +1,5 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsStylistic } from '../types'
 import { pluginJsdoc } from '../plugins'
-import type { OptionsStylistic } from '../types'
 
 export function jsdoc(options: OptionsStylistic = {}): FlatESLintConfigItem[] {
   const {
@@ -9,6 +8,7 @@ export function jsdoc(options: OptionsStylistic = {}): FlatESLintConfigItem[] {
 
   return [
     {
+      name: 'antfu:jsdoc',
       plugins: {
         jsdoc: pluginJsdoc,
       },
diff --git a/src/configs/jsonc.ts b/src/configs/jsonc.ts
@@ -1,7 +1,6 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from '../globs'
 import { parserJsonc, pluginJsonc } from '../plugins'
-import type { OptionsOverrides, OptionsStylistic } from '../types'
 
 export function jsonc(options: OptionsStylistic & OptionsOverrides = {}): FlatESLintConfigItem[] {
   const {
@@ -11,6 +10,7 @@ export function jsonc(options: OptionsStylistic & OptionsOverrides = {}): FlatES
 
   return [
     {
+      name: 'antfu:jsonc:setup',
       plugins: {
         jsonc: pluginJsonc as any,
       },
@@ -20,8 +20,8 @@ export function jsonc(options: OptionsStylistic & OptionsOverrides = {}): FlatES
       languageOptions: {
         parser: parserJsonc,
       },
+      name: 'antfu:jsonc:rules',
       rules: {
-
         'jsonc/no-bigint-literals': 'error',
         'jsonc/no-binary-expression': 'error',
         'jsonc/no-binary-numeric-literals': 'error',
diff --git a/src/configs/markdown.ts b/src/configs/markdown.ts
@@ -1,8 +1,7 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsComponentExts, OptionsOverrides } from '../types'
 import { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE } from '../globs'
 import { pluginMarkdown } from '../plugins'
 import { OFF } from '../flags'
-import type { OptionsComponentExts, OptionsOverrides } from '../types'
 
 export function markdown(options: OptionsComponentExts & OptionsOverrides = {}): FlatESLintConfigItem[] {
   const {
@@ -12,12 +11,14 @@ export function markdown(options: OptionsComponentExts & OptionsOverrides = {}):
 
   return [
     {
+      name: 'antfu:markdown:setup',
       plugins: {
         markdown: pluginMarkdown,
       },
     },
     {
       files: [GLOB_MARKDOWN],
+      name: 'antfu:markdown:processor',
       processor: 'markdown/markdown',
     },
     {
@@ -32,6 +33,7 @@ export function markdown(options: OptionsComponentExts & OptionsOverrides = {}):
           },
         },
       },
+      name: 'antfu:markdown:rules',
       rules: {
         'antfu/no-cjs-exports': OFF,
         'antfu/no-ts-export-equal': OFF,
diff --git a/src/configs/node.ts b/src/configs/node.ts
@@ -1,9 +1,10 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 import { pluginNode } from '../plugins'
 
 export function node(): FlatESLintConfigItem[] {
   return [
     {
+      name: 'antfu:node',
       plugins: {
         node: pluginNode,
       },
diff --git a/src/configs/sort.ts b/src/configs/sort.ts
@@ -1,4 +1,4 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 
 /**
  * Sort package.json
@@ -9,6 +9,7 @@ export function sortPackageJson(): FlatESLintConfigItem[] {
   return [
     {
       files: ['**/package.json'],
+      name: 'antfu:sort-package-json',
       rules: {
         'jsonc/sort-array-values': [
           'error',
@@ -103,6 +104,7 @@ export function sortTsconfig(): FlatESLintConfigItem[] {
   return [
     {
       files: ['**/tsconfig.json', '**/tsconfig.*.json'],
+      name: 'antfu:sort-tsconfig',
       rules: {
         'jsonc/sort-keys': [
           'error',
diff --git a/src/configs/stylistic.ts b/src/configs/stylistic.ts
@@ -1,9 +1,10 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 import { pluginAntfu, pluginStylistic } from '../plugins'
 
 export function stylistic(): FlatESLintConfigItem[] {
   return [
     {
+      name: 'antfu:stylistic',
       plugins: {
         antfu: pluginAntfu,
         style: pluginStylistic,
diff --git a/src/configs/test.ts b/src/configs/test.ts
@@ -1,8 +1,7 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsIsInEditor, OptionsOverrides } from '../types'
 import { pluginNoOnlyTests, pluginVitest } from '../plugins'
 import { GLOB_TESTS } from '../globs'
 import { OFF } from '../flags'
-import type { OptionsIsInEditor, OptionsOverrides } from '../types'
 
 export function test(options: OptionsIsInEditor & OptionsOverrides = {}): FlatESLintConfigItem[] {
   const {
@@ -12,6 +11,7 @@ export function test(options: OptionsIsInEditor & OptionsOverrides = {}): FlatES
 
   return [
     {
+      name: 'antfu:test:setup',
       plugins: {
         test: {
           ...pluginVitest,
@@ -25,6 +25,7 @@ export function test(options: OptionsIsInEditor & OptionsOverrides = {}): FlatES
     },
     {
       files: GLOB_TESTS,
+      name: 'antfu:test:rules',
       rules: {
         'test/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
         'test/no-identical-title': 'error',
diff --git a/src/configs/typescript.ts b/src/configs/typescript.ts
@@ -1,9 +1,8 @@
 import process from 'node:process'
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsComponentExts, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes } from '../types'
 import { GLOB_SRC } from '../globs'
 import { parserTs, pluginAntfu, pluginImport, pluginTs } from '../plugins'
 import { OFF } from '../flags'
-import type { OptionsComponentExts, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes } from '../types'
 import { renameRules } from '../utils'
 
 export function typescript(
@@ -41,6 +40,7 @@ export function typescript(
   return [
     {
       // Install the plugins without globs, so they can be configured separately.
+      name: 'antfu:typescript:setup',
       plugins: {
         antfu: pluginAntfu,
         import: pluginImport,
@@ -65,6 +65,7 @@ export function typescript(
           ...parserOptions as any,
         },
       },
+      name: 'antfu:typescript:rules',
       rules: {
         ...renameRules(
           pluginTs.configs['eslint-recommended'].overrides![0].rules!,
@@ -118,6 +119,7 @@ export function typescript(
     },
     {
       files: ['**/*.d.ts'],
+      name: 'antfu:typescript:dts-overrides',
       rules: {
         'eslint-comments/no-unlimited-disable': OFF,
         'import/no-duplicates': OFF,
@@ -126,12 +128,14 @@ export function typescript(
     },
     {
       files: ['**/*.{test,spec}.ts?(x)'],
+      name: 'antfu:typescript:tests-overrides',
       rules: {
         'no-unused-expressions': OFF,
       },
     },
     {
       files: ['**/*.js', '**/*.cjs'],
+      name: 'antfu:typescript:javascript-overrides',
       rules: {
         'ts/no-require-imports': OFF,
         'ts/no-var-requires': OFF,
diff --git a/src/configs/unicorn.ts b/src/configs/unicorn.ts
@@ -1,9 +1,10 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem } from '../types'
 import { pluginUnicorn } from '../plugins'
 
 export function unicorn(): FlatESLintConfigItem[] {
   return [
     {
+      name: 'antfu:unicorn',
       plugins: {
         unicorn: pluginUnicorn,
       },
diff --git a/src/configs/vue.ts b/src/configs/vue.ts
@@ -1,8 +1,7 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_VUE } from '../globs'
 import { parserTs, parserVue, pluginVue } from '../plugins'
 import { OFF } from '../flags'
-import type { OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from '../types'
 
 export function vue(
   options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic = {},
@@ -14,6 +13,7 @@ export function vue(
 
   return [
     {
+      name: 'antfu:vue:setup',
       plugins: {
         vue: pluginVue,
       },
@@ -31,6 +31,7 @@ export function vue(
           sourceType: 'module',
         },
       },
+      name: 'antfu:vue:rules',
       processor: pluginVue.processors['.vue'],
       rules: {
         ...pluginVue.configs.base.rules as any,
diff --git a/src/configs/yaml.ts b/src/configs/yaml.ts
@@ -1,8 +1,7 @@
-import type { FlatESLintConfigItem } from 'eslint-define-config'
+import type { FlatESLintConfigItem, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_YAML } from '../globs'
 import { parserYaml, pluginYaml } from '../plugins'
 import { OFF } from '../flags'
-import type { OptionsOverrides, OptionsStylistic } from '../types'
 
 export function yaml(
   options: OptionsOverrides & OptionsStylistic = {},
@@ -14,6 +13,7 @@ export function yaml(
 
   return [
     {
+      name: 'antfu:yaml:setup',
       plugins: {
         yaml: pluginYaml as any,
       },
@@ -23,6 +23,7 @@ export function yaml(
       languageOptions: {
         parser: parserYaml,
       },
+      name: 'antfu:yaml:rules',
       rules: {
         'style/spaced-comment': OFF,
 
diff --git a/src/factory.ts b/src/factory.ts
diff --git a/src/globs.ts b/src/globs.ts
diff --git a/src/types.ts b/src/types.ts
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/test/fixtures.test.ts b/test/fixtures.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,11 @@`
`1`		`-import type { FlatESLintConfigItem } from 'eslint-define-config'`
	`1`	`+import type { FlatESLintConfigItem } from '../types'`
`2`	`2`	`import { GLOB_EXCLUDE } from '../globs'`
`3`	`3`
`4`	`4`	`export function ignores(): FlatESLintConfigItem[] {`
`5`	`5`	`return [`
`6`		`- { ignores: GLOB_EXCLUDE },`
	`6`	`+ {`
	`7`	`+ ignores: GLOB_EXCLUDE,`
	`8`	`+ name: 'antfu:ignores:basic',`
	`9`	`+ },`
`7`	`10`	`]`
`8`	`11`	`}`