Skip to content

docs: add an example on how to use custom parser with flat config #2490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ota-meshi merged 4 commits into from
Jul 1, 2024
Merged

docs: add an example on how to use custom parser with flat config #2490

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ef29aa
docs: add an example on how to use custom parser with flat config
Lehoczky Jun 29, 2024
34f37e1
docs: do not use the term "Legacy config"
Lehoczky Jun 30, 2024
8ab1a7c
fix: add component ending tag
Lehoczky Jun 30, 2024
8f853a3
Update index.md
ota-meshi Jun 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions docs/user-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,48 @@ If you want to use custom parsers such as [@babel/eslint-parser](https://www.npm
}
```

Full example:

::: code-group

```json [.eslintrc]
{
"root": true,
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:vue/vue3-recommended"
],
"parser": "vue-eslint-parser",
"parserOptions": {
"parser": "@typescript-eslint/parser"
}
}
```

```js [eslint.config.js]
import js from '@eslint/js'
import eslintPluginVue from 'eslint-plugin-vue'
import ts from 'typescript-eslint'

export default ts.config(
js.configs.recommended,
...ts.configs.recommended,
...eslintPluginVue.configs['flat/recommended'],
{
files: ['*.vue', '**/*.vue'],
languageOptions: {
parserOptions: {
parser: '@typescript-eslint/parser'
}
}
}
)
```

:::

The `parserOptions.parser` option can also specify an object to specify multiple parsers. See [vue-eslint-parser README](https://github.com/vuejs/vue-eslint-parser#readme) for more details.

### How does ESLint detect components?
Expand Down Expand Up @@ -441,8 +483,7 @@ In [Nuxt 3](https://nuxt.com/) or with [`unplugin-auto-import`](https://github.c

::: code-group

```json [Legacy Config]
// .eslintrc
```json [.eslintrc]
{
"globals": {
"ref": "readonly",
Expand All @@ -454,8 +495,7 @@ In [Nuxt 3](https://nuxt.com/) or with [`unplugin-auto-import`](https://github.c
}
```

```js [Flat Config]
// eslint.config.js
```js [eslint.config.js]
export default [
{
languageOptions: {
Expand Down