You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
1
# @vue/eslint-config-typescript
2
2
3
-
> eslint-config-typescript for vue-cli
3
+
> eslint-config-typescript for Vue
4
4
5
5
See [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/rules/) for available rules.
6
6
7
-
This config is specifically designed to be used by Vue CLI & `create-vue` setups
7
+
This config is specifically designed to be used by `@vue/cli` & `create-vue` setups
8
8
and is not meant for outside use (it can be used but some adaptations
9
9
on the user side might be needed - for details see the config file).
10
10
11
11
A part of its design is that this config may implicitly depend on
12
-
other parts of Vue CLI setups, such as `eslint-plugin-vue` being
12
+
other parts of `@vue/cli`/`create-vue` setups, such as `eslint-plugin-vue` being
13
13
extended in the same resulting config.
14
14
15
15
## Installation
16
16
17
17
In order to work around [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458), we recommend you to use this package alongside `@rushstack/eslint-patch`, so that you don't have to install too many dependencies:
@@ -50,24 +51,25 @@ This is extended from the `@typescript-eslint/recommended` ruleset, which is an
50
51
See the [original documentation](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin/src/configs#recommended) for more information.
51
52
52
53
Some of its rules, however, might conflict with `prettier`.
53
-
So when used alongside other sharable configs, this config should be placed after all other configs except for the one from `eslint-plugin-prettier` in the `extends` array.
54
+
So when used alongside other sharable configs, this config should be placed after all other configs except for the one from `@vue/eslint-config-prettier` or `eslint-plugin-prettier` in the `extends` array.
If you are following the [`standard`](https://standardjs.com/) or [`airbnb`](https://github.com/airbnb/javascript/) style guides, don't manually extend from this package.
73
-
Please use `@vue/eslint-config-standard-with-typescript` or `@vue/eslint-config-airbnb-with-typescript` instead.
73
+
Work-In-Progress.
74
+
75
+
~~If you are following the [`standard`](https://standardjs.com/) or [`airbnb`](https://github.com/airbnb/javascript/) style guides, don't manually extend from this package. Please use `@vue/eslint-config-standard-with-typescript` or `@vue/eslint-config-airbnb-with-typescript` instead.~~
0 commit comments