feat: add name for each config item

Author: coderwyd

README.md

@@ -26,13 +26,24 @@ pnpm i -D eslint @coderwyd/eslint-config
 
 ### Create config file
 
+With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+
 ```js
 // eslint.config.js
 import coderwyd from '@coderwyd/eslint-config'
 
 export default coderwyd()
 ```
 
+With CJS:
+
+```js
+// eslint.config.js
+const coderwyd = require('@coderwyd/eslint-config').default
+
+module.exports = coderwyd()
+```
+
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
 
 ### Add script for package.json

package.json

@@ -71,6 +71,7 @@
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
+    "@types/eslint": "^8.44.3",
     "@types/node": "^20.8.2",
     "@types/react": "^18.2.25",
     "bumpp": "^9.2.0",

pnpm-lock.yaml

@@ -1,16 +1,10 @@
-import { type FlatESLintConfigItem } from 'eslint-define-config'
-import { GLOB_ASTRO } from 'src/globs'
+import { GLOB_ASTRO } from '../globs'
 import { parserAstro, parserTs, pluginAstro } from '../plugins'
-import type { OptionsHasTypeScript, OptionsOverrides } from '../types'
+import type { FlatESLintConfigItem, OptionsHasTypeScript, OptionsOverrides } from '../types'
 
 export function astro(options: OptionsHasTypeScript & OptionsOverrides = {}): FlatESLintConfigItem[] {
   const { overrides = {} } = options
   return [
-    {
-      plugins: {
-        astro: pluginAstro,
-      },
-    },
     {
       files: [GLOB_ASTRO],
       languageOptions: {
@@ -20,6 +14,10 @@ export function astro(options: OptionsHasTypeScript & OptionsOverrides = {}): Fl
           parser: options.typescript ? (parserTs as any) : null,
         },
       },
+      name: 'coderwyd:astro',
+      plugins: {
+        astro: pluginAstro,
+      },
       rules: {
         ...(pluginAstro.configs.recommended.rules as any),
 

src/configs/astro.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: 'coderwyd:eslint-comments',
       plugins: {
         'eslint-comments': pluginComments,
       },

src/configs/comments.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: 'coderwyd:ignores:basic',
+    },
   ]
 }

src/configs/ignores.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: 'coderwyd:imports',
       plugins: {
         antfu: pluginAntfu,
         import: pluginImport,

src/configs/imports.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[] {
@@ -12,12 +11,6 @@ export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}):
   } = options
 
   return [
-    {
-      plugins: {
-        'antfu': pluginAntfu,
-        'unused-imports': pluginUnusedImports,
-      },
-    },
     {
       languageOptions: {
         ecmaVersion: 2022,
@@ -38,6 +31,11 @@ export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}):
         },
         sourceType: 'module',
       },
+      name: 'coderwyd:javascript',
+      plugins: {
+        'antfu': pluginAntfu,
+        'unused-imports': pluginUnusedImports,
+      },
 
       rules: {
         'accessor-pairs': ['error', { enforceForClassMembers: true, setWithoutGet: true }],
@@ -235,6 +233,7 @@ export function javascript(options: OptionsIsInEditor & OptionsOverrides = {}):
     },
     {
       files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
+      name: 'coderwyd:scripts-overrides',
       rules: {
         'no-console': OFF,
       },

src/configs/javascript.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,11 +8,10 @@ export function jsdoc(options: OptionsStylistic = {}): FlatESLintConfigItem[] {
 
   return [
     {
+      name: 'coderwyd:jsdoc',
       plugins: {
         jsdoc: pluginJsdoc,
       },
-    },
-    {
       rules: {
         'jsdoc/check-access': 'warn',
         'jsdoc/check-param-names': 'warn',
@@ -30,7 +28,6 @@ export function jsdoc(options: OptionsStylistic = {}): FlatESLintConfigItem[] {
         'jsdoc/require-returns-check': 'warn',
         'jsdoc/require-returns-description': 'warn',
         'jsdoc/require-yields-check': 'warn',
-        'jsdoc/valid-types': 'warn',
 
         ...stylistic
           ? {

src/configs/jsdoc.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 {
@@ -10,6 +9,7 @@ export function jsonc(options: OptionsStylistic & OptionsOverrides = {}): FlatES
   } = options
   return [
     {
+      name: 'coderwyd:jsonc:setup',
       plugins: {
         jsonc: pluginJsonc as any,
       },
@@ -19,6 +19,7 @@ export function jsonc(options: OptionsStylistic & OptionsOverrides = {}): FlatES
       languageOptions: {
         parser: parserJsonc,
       },
+      name: 'coderwyd:jsonc:rules',
       rules: {
         'jsonc/no-bigint-literals': 'error',
         'jsonc/no-binary-expression': 'error',