Skip to content

Commit aeefa78

Browse files
committed
docs: more consistent wording and better examples
1 parent 1ff7de3 commit aeefa78

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# @vue/eslint-config-typescript
22

3-
> eslint-config-typescript for vue-cli
3+
> eslint-config-typescript for Vue
44
55
See [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/rules/) for available rules.
66

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
88
and is not meant for outside use (it can be used but some adaptations
99
on the user side might be needed - for details see the config file).
1010

1111
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
1313
extended in the same resulting config.
1414

1515
## Installation
1616

1717
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:
1818

1919
```sh
20-
npm install --dev @vue/eslint-config-typescript @rushstack/eslint-patch
20+
npm add --dev @vue/eslint-config-typescript @rushstack/eslint-patch
2121
```
2222

2323
## Usage
@@ -33,12 +33,13 @@ So when used alongside other sharable configs, this config should be placed at t
3333
An example `.eslintrc.cjs`:
3434

3535
```js
36+
/* eslint-env node */
3637
require("@rushstack/eslint-patch/modern-module-resolution")
3738

3839
module.exports = {
3940
extends: [
40-
'plugin:vue/essential',
4141
'eslint:recommended',
42+
'plugin:vue/vue3-essential',
4243
'@vue/eslint-config-typescript'
4344
]
4445
}
@@ -50,24 +51,25 @@ This is extended from the `@typescript-eslint/recommended` ruleset, which is an
5051
See the [original documentation](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin/src/configs#recommended) for more information.
5152

5253
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.
5455

5556
An example `.eslintrc.cjs`:
5657

5758
```js
59+
/* eslint-env node */
5860
require("@rushstack/eslint-patch/modern-module-resolution")
5961

6062
module.exports = {
6163
extends: [
62-
'plugin:vue/essential',
64+
'plugin:vue/vue3-essential',
6365
'@vue/eslint-config-typescript/recommended',
64-
65-
'plugin:prettier/recommended'
66+
'@vue/eslint-config-prettier'
6667
]
6768
}
6869
```
6970

7071
### With Other Community Configs
7172

72-
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.~~

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
},
2020
"keywords": [
2121
"vue",
22-
"cli"
22+
"cli",
23+
"eslint",
24+
"typescript"
2325
],
2426
"author": "Evan You",
2527
"license": "MIT",

0 commit comments

Comments
 (0)