refactor!: rename defineConfig to defineConfigWithVueTs; `configs…

…` to `vueTsConfigs`
vuejs · Dec 27, 2024 · e33db0b · e33db0b
1 parent de86921
commit e33db0b
Show file tree

Hide file tree

Showing 17 changed files with 75 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -29,8 +29,8 @@ Because of the complexity of this config, it is exported as a factory function t
 
 This package exports:
 
-- `defineConfig`, a utility function whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config).
-- `configs`, contains all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs) (in camelCase, e.g. `configs.recommendedTypeChecked`).
+- `defineConfigWithVueTs`, a utility function whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config), but will modify the given config to work with Vue.js + TypeScript.
+- `vueTsConfigs`, contains all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs) (in camelCase, e.g. `configs.recommendedTypeChecked`).
 - a Vue-specific config factory: `configureVueProject({ scriptLangs, rootDir })`. More info below.
 
 ### Minimal Setup
@@ -39,13 +39,13 @@ This package exports:
 // eslint.config.mjs
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
-  configs,
+  defineConfigWithVueTs,
+  vueTsConfigs,
 } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 )
 ```
 
@@ -59,9 +59,9 @@ All the `<script>` blocks in `.vue` files *MUST* be written in TypeScript (shoul
 // eslint.config.mjs
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
+  defineConfigWithVueTs,
+  vueTsConfigs,
   configureVueProject,
-  configs,
 } from '@vue/eslint-config-typescript'
 
 configureVueProject({
@@ -97,13 +97,13 @@ configureVueProject({
   rootDir: import.meta.dirname,
 })
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   pluginVue.configs["flat/essential"],
 
   // We STRONGLY RECOMMEND you to start with `recommended` or `recommendedTypeChecked`.
   // But if you are determined to configure all rules by yourself,
   // you can start with `base`, and then turn on/off the rules you need.
-  configs.base,
+  vueTsConfigs.base,
 )
 ```
 
@@ -120,13 +120,13 @@ Instead, you can start by extending from the `recommendedTypeChecked` configurat
 // eslint.config.mjs
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
-  configs,
+  defineConfigWithVueTs,
+  vueTsConfigs,
 } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   pluginVue.configs['flat/essential'],
-  configs.recommendedTypeChecked
+  vueTsConfigs.recommendedTypeChecked
 )
 ```
 

diff --git a/examples/allow-js/eslint.config.js b/examples/allow-js/eslint.config.js
@@ -1,13 +1,13 @@
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
+  defineConfigWithVueTs,
+  vueTsConfigs,
   configureVueProject,
-  configs,
 } from '@vue/eslint-config-typescript'
 
 configureVueProject({ scriptLangs: ['js', 'ts'] })
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.js', '**/*.mjs', '**/*.ts', '**/*.mts', '**/*.vue'],
@@ -19,5 +19,5 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 )
diff --git a/examples/minimal/eslint.config.js b/examples/minimal/eslint.config.js
@@ -1,7 +1,7 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -12,6 +12,6 @@ export default defineConfig(
     ignores: ['**/dist/**', '**/dist-ssr/**', '**/coverage/**'],
   },
 
-  ...pluginVue.configs['flat/essential'],
-  configs.recommended,
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
 )
diff --git a/examples/type-checked/eslint.config.js b/examples/type-checked/eslint.config.js
@@ -1,10 +1,10 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 import pluginVitest from '@vitest/eslint-plugin'
 import pluginCypress from 'eslint-plugin-cypress/flat'
 import skipFormatting from '@vue/eslint-config-prettier/skip-formatting'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.{ts,mts,tsx,vue}'],
@@ -16,7 +16,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommendedTypeChecked,
+  vueTsConfigs.recommendedTypeChecked,
 
   {
     ...pluginVitest.configs.recommended,

diff --git a/examples/with-cypress/eslint.config.js b/examples/with-cypress/eslint.config.js
@@ -1,8 +1,8 @@
 import pluginVue from 'eslint-plugin-vue'
 import pluginCypress from 'eslint-plugin-cypress/flat'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -14,7 +14,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 
   {
     ...pluginCypress.configs.recommended,

diff --git a/examples/with-jsx-in-vue/eslint.config.js b/examples/with-jsx-in-vue/eslint.config.js
@@ -1,13 +1,13 @@
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
+  defineConfigWithVueTs,
+  vueTsConfigs,
   configureVueProject,
-  configs,
 } from '@vue/eslint-config-typescript'
 
 configureVueProject({ scriptLangs: ['js', 'jsx', 'ts', 'tsx'] })
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: [
@@ -26,6 +26,6 @@ export default defineConfig(
     ignores: ['**/dist/**', '**/dist-ssr/**', '**/coverage/**'],
   },
 
-  ...pluginVue.configs['flat/essential'],
-  configs.recommended,
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
 )
diff --git a/examples/with-jsx/eslint.config.js b/examples/with-jsx/eslint.config.js
@@ -1,7 +1,7 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.js', '**/*.mjs', '**/*.jsx', '**/*.ts', '**/*.mts', '**/*.tsx', '**/*.vue'],
@@ -13,5 +13,5 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 )
diff --git a/examples/with-nightwatch/eslint.config.js b/examples/with-nightwatch/eslint.config.js
@@ -1,7 +1,7 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -13,7 +13,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 
   {
     // nightwatch specs

diff --git a/examples/with-playwright/eslint.config.js b/examples/with-playwright/eslint.config.js
@@ -1,8 +1,8 @@
 import pluginVue from 'eslint-plugin-vue'
 import pluginPlaywright from 'eslint-plugin-playwright'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -14,7 +14,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 
   {
     ...pluginPlaywright.configs['flat/recommended'],

diff --git a/examples/with-prettier/eslint.config.js b/examples/with-prettier/eslint.config.js
@@ -1,8 +1,8 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 import skipFormatting from '@vue/eslint-config-prettier/skip-formatting'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -14,7 +14,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 
   skipFormatting
 )
diff --git a/examples/with-tsx-in-vue/eslint.config.js b/examples/with-tsx-in-vue/eslint.config.js
@@ -1,13 +1,13 @@
 import pluginVue from 'eslint-plugin-vue'
 import {
-  defineConfig,
+  defineConfigWithVueTs,
+  vueTsConfigs,
   configureVueProject,
-  configs,
 } from '@vue/eslint-config-typescript'
 
 configureVueProject({ scriptLangs: ['ts', 'tsx'] })
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.tsx', '**/*.vue'],
@@ -18,6 +18,6 @@ export default defineConfig(
     ignores: ['**/dist/**', '**/dist-ssr/**', '**/coverage/**'],
   },
 
-  ...pluginVue.configs['flat/essential'],
-  configs.recommended,
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
 )
diff --git a/examples/with-tsx/eslint.config.js b/examples/with-tsx/eslint.config.js
@@ -1,7 +1,7 @@
 import pluginVue from 'eslint-plugin-vue'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.tsx', '**/*.vue'],
@@ -13,5 +13,5 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 )
diff --git a/examples/with-vitest/eslint.config.js b/examples/with-vitest/eslint.config.js
@@ -1,8 +1,8 @@
 import pluginVue from 'eslint-plugin-vue'
 import pluginVitest from '@vitest/eslint-plugin'
-import { defineConfig, configs } from '@vue/eslint-config-typescript'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 
-export default defineConfig(
+export default defineConfigWithVueTs(
   {
     name: 'app/files-to-lint',
     files: ['**/*.ts', '**/*.mts', '**/*.vue'],
@@ -14,7 +14,7 @@ export default defineConfig(
   },
 
   pluginVue.configs['flat/essential'],
-  configs.recommended,
+  vueTsConfigs.recommended,
 
   {
     ...pluginVitest.configs['recommended'],

diff --git a/src/configs.ts b/src/configs.ts
@@ -3,7 +3,7 @@ import tseslint from 'typescript-eslint'
 import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint'
 
 const PlaceholderPrefix =
-  'PLACEHOLDER_THAT_MUST_BE_WRAPPED_INSIDE_defineConfig_'
+  'PLACEHOLDER_THAT_MUST_BE_WRAPPED_INSIDE_defineConfigWithVueTs_'
 
 // Manually declare all the available configs as enums to make the auto-completion more user-friendly.
 // It's also a good way to avoid the placeholder strings to appear in the auto-completion.
@@ -26,7 +26,7 @@ export enum VueTsPreset {
 // `enum`s are just objects with reverse mapping during runtime.
 // We redefine the type here only to make the auto-completion more user-friendly.
 export type ExtendableConfigName = keyof typeof VueTsPreset
-export const configs = VueTsPreset as {
+export const vueTsConfigs = VueTsPreset as {
   [key in ExtendableConfigName]: VueTsPreset
 }
 

diff --git a/src/createConfig.ts b/src/createConfig.ts
@@ -6,17 +6,20 @@ import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint'
 
 import {
   configureVueProject,
-  defineConfig,
+  defineConfigWithVueTs,
   type ProjectOptions,
 } from './utilities'
-import { configs, type ExtendableConfigName } from './configs'
+import { vueTsConfigs, type ExtendableConfigName } from './configs'
 import type { ScriptLang } from './internals'
 
 type ConfigOptions = ProjectOptions & {
   extends?: Array<ExtendableConfigName>
   supportedScriptLangs?: Record<ScriptLang, boolean>
 }
 
+/**
+ * @deprecated Use `defineConfigWithVueTs` + `vueTsConfigs` instead.
+ */
 export default function createConfig({
   extends: configNamesToExtend = ['recommended'],
   supportedScriptLangs = { ts: true, tsx: false, js: false, jsx: false },
@@ -47,7 +50,7 @@ export default function createConfig({
     ) as ScriptLang[],
     rootDir,
   })
-  return defineConfig(
-    ...configNamesToExtend.map(name => configs[name as ExtendableConfigName]),
+  return defineConfigWithVueTs(
+    ...configNamesToExtend.map(name => vueTsConfigs[name as ExtendableConfigName]),
   )
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1,15 @@
 export {
-  defineConfig,
+  defineConfigWithVueTs,
   configureVueProject,
 } from './utilities'
-export { configs } from './configs'
+export { vueTsConfigs } from './configs'
 
 // Compatibility layer for the `createConfig` function in <= 14.2.0
 export { default as createConfig } from './createConfig'
 export { default } from './createConfig'
+
+import { defineConfigWithVueTs } from './utilities'
+/**
+ * @deprecated `defineConfig` is renamed to `defineConfigWithVueTs` in 14.3.0
+ */
+export const defineConfig = defineConfigWithVueTs