Skip to content

Commit c7d08af

Browse files
committed
[doc] update eslint-patch README with v8 support
Updates the eslint-patch README to note that ESLint version 8 is supported. Also fixes an error in the URL for the CHANGELOG.
1 parent fdba1bf commit c7d08af

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@rushstack/eslint-patch",
5+
"comment": "[doc] update eslint-patch README with v8 support",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@rushstack/eslint-patch"
10+
}

eslint/eslint-patch/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ for additional technical background.
2222

2323
## Why it's a patch
2424

25-
ESLint's long awaited module resolver overhaul still has not materialized as of ESLint 7. As a stopgap,
25+
ESLint's long awaited module resolver overhaul still has not materialized as of ESLint 8. As a stopgap,
2626
we created a small **.eslintrc.js** patch that solves the problem adequately for most real world scenarios.
2727
This patch was proposed as an ESLint feature with [PR 12460](https://github.com/eslint/eslint/pull/12460), however
2828
the maintainers were not able to accept it unless it is reworked into a fully correct design. Such a requirement
@@ -52,7 +52,7 @@ Instead, the hypothetical `@your-company/eslint-config` NPM package would declar
5252
own dependencies.
5353

5454
This patch works by modifying the ESLint engine so that its module resolver will load relative to the folder of
55-
the referencing config file, rather than the project folder. The patch is compatible with ESLint 6 and 7.
55+
the referencing config file, rather than the project folder. The patch is compatible with ESLint 6, 7, and 8.
5656
It also works with any editor extensions that load ESLint as a library.
5757

5858
For an even leaner setup, `@your-company/eslint-config` can provide the patch as its own dependency. See
@@ -62,8 +62,7 @@ and recommended approach.
6262

6363
## Links
6464

65-
- [CHANGELOG.md](
66-
https://github.com/microsoft/rushstack/blob/main/stack/eslint-patch/CHANGELOG.md) - Find
65+
- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/eslint/eslint-patch/CHANGELOG.md) - Find
6766
out what's new in the latest version
6867

6968
`@rushstack/eslint-patch` is part of the [Rush Stack](https://rushstack.io/) family of projects.

0 commit comments

Comments
 (0)