Skip to content

Commit d589460

Browse files
st-slothyyx990803
st-sloth
authored andcommitted
docs: add description to extendable eslint configs [ci skip] (#1862)
1 parent ab66dc1 commit d589460

File tree

5 files changed

+37
-1
lines changed

5 files changed

+37
-1
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# @vue/eslint-config-airbnb
22

33
> eslint-config-airbnb for vue-cli
4+
5+
This config is specifically designed to be used by `vue-cli` setups
6+
and is not meant for outside use (it can be used but some adaptations
7+
on the user side might be needed - for details see the config file).
8+
9+
A part of its design is that this config may implicitly depend on
10+
other parts of `vue-cli` setups, such as `eslint-plugin-vue` being
11+
extended in the same resulting config.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# @vue/eslint-config-prettier
22

33
> eslint-config-prettier for vue-cli
4+
5+
This config is specifically designed to be used by `vue-cli` setups
6+
and is not meant for outside use (it can be used but some adaptations
7+
on the user side might be needed - for details see the config file).
8+
9+
A part of its design is that this config may implicitly depend on
10+
other parts of `vue-cli` setups, such as `eslint-plugin-vue` being
11+
extended in the same resulting config.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# @vue/eslint-config-standard
22

33
> eslint-config-standard for vue-cli
4+
5+
This config is specifically designed to be used by `vue-cli` setups
6+
and is not meant for outside use (it can be used but some adaptations
7+
on the user side might be needed - for details see the config file).
8+
9+
A part of its design is that this config may implicitly depend on
10+
other parts of `vue-cli` setups, such as `eslint-plugin-vue` being
11+
extended in the same resulting config.
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# @vue/eslint-config-typescript
22

3-
> eslint-config-typescript for vue-cli
3+
> eslint-config-typescript for vue-cli
4+
5+
This config is specifically designed to be used by `vue-cli` setups
6+
and is not meant for outside use (it can be used but some adaptations
7+
on the user side might be needed - for details see the config file).
8+
9+
A part of its design is that this config may implicitly depend on
10+
other parts of `vue-cli` setups, such as `eslint-plugin-vue` being
11+
extended in the same resulting config.

packages/@vue/eslint-config-typescript/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
module.exports = {
22
plugins: ['typescript'],
3+
// Prerequisite `eslint-plugin-vue`, being extended, sets
4+
// root property `parser` to `'vue-eslint-parser'`, which, for code parsing,
5+
// in turn delegates to the parser, specified in `parserOptions.parser`:
6+
// https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error
37
parserOptions: {
48
parser: require.resolve('typescript-eslint-parser')
59
},

0 commit comments

Comments
 (0)