Skip to content

Commit db7c65e

Browse files
committed
docs: update installation instruction to use the eslint patch
1 parent 286de5a commit db7c65e

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
See [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/eslint-plugin) for available rules.
66

7-
This config is specifically designed to be used by Vue CLI 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

@@ -14,10 +14,10 @@ extended in the same resulting config.
1414

1515
## Installation
1616

17-
This config requires several peer dependencies. So it's recommended to use the `install-peerdeps` command:
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`:
1818

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

2323
## Usage
@@ -30,9 +30,11 @@ This ruleset is the base configuration for Vue-TypeScript projects.
3030
Besides setting the parser and plugin options, it also turns off several conflicting rules in the `eslint:recommended` ruleset.
3131
So when used alongside other sharable configs, this config should be placed at the end of the `extends` array.
3232

33-
An example `.eslintrc.js`:
33+
An example `.eslintrc.cjs`:
3434

3535
```js
36+
require("@rushstack/eslint-patch/modern-module-resolution")
37+
3638
module.exports = {
3739
extends: [
3840
'plugin:vue/essential',
@@ -50,9 +52,11 @@ See the [original documentation](https://github.com/typescript-eslint/typescript
5052
Some of its rules, however, might conflict with `prettier`.
5153
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.
5254

53-
An example `.eslintrc.js`:
55+
An example `.eslintrc.cjs`:
5456

5557
```js
58+
require("@rushstack/eslint-patch/modern-module-resolution")
59+
5660
module.exports = {
5761
extends: [
5862
'plugin:vue/essential',

0 commit comments

Comments
 (0)