diff --git a/README.md b/README.md index 63cf9160..e190d76e 100644 --- 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 `