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
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,23 +51,37 @@ The latest version under the `canary` tag **(latest commit to `main`)** is:
51
51
52
52
### Supported TypeScript Version
53
53
54
-
**The version range of TypeScript currently supported by this parser is `>=3.3.1 <5.0.0`.**
54
+
**The version range of TypeScript currently supported by this parser is `>=4.2.0 <5.0.0`.**
55
55
56
-
These versions are what we test against.
56
+
Note that we mirror [DefinitelyTyped's version support window](https://github.com/DefinitelyTyped/DefinitelyTyped/#support-window) - meaning we only support versions of TypeScript less than 2 years old.
57
57
58
-
We will always endeavor to support the latest stable version of TypeScript.
59
-
Sometimes, but not always, changes in TypeScript will not require breaking changes in this project, and so we are able to support more than one version of TypeScript.
60
-
In some cases, we may even be able to support additional pre-releases (i.e. betas and release candidates) of TypeScript, but only if doing so does not require us to compromise on support for the latest stable version.
58
+
You may find that our tooling works on older TypeScript versions however we provide no guarantees and **_we will not accept issues against unsupported versions_**.
59
+
60
+
#### Supporting New TypeScript Releases
61
+
62
+
With each new TypeScript release we file an issue to track the changes in the new version. The issue should always be pinned, and you can also [find the issues by searching for issues tagged with "New TypeScript Version"](https://github.com/typescript-eslint/typescript-eslint/issues?q=is%3Aissue+label%3A%22New+TypeScript+Version%22+sort%3Acreated-desc). If the issue is open, we do not have official support yet - please be patient.
63
+
64
+
In terms of what versions we support:
65
+
66
+
- We do not support the `beta` releases.
67
+
- We _generally_ do not officially support the `rc` releases.
68
+
- We endeavor to support the latest stable TypeScript versions as soon as possible after the release.
69
+
70
+
Generally we will begin working on supporting the next release when the `rc` version is released.
71
+
72
+
#### Version Warning Logs
61
73
62
74
Note that our packages have an open `peerDependency` requirement in order to allow for experimentation on newer/beta versions of TypeScript.
63
75
64
-
If you use a non-supported version of TypeScript, the parser will log a warning to the console.
76
+
However if you use a non-supported version of TypeScript, the parser will log a warning to the console.
65
77
If you want to disable this warning, you can configure this in your `parserOptions`. See: [`@typescript-eslint/parser`](./packages/parser/) and [`@typescript-eslint/typescript-estree`](./packages/typescript-estree/).
66
78
67
79
**Please ensure that you are using a supported version before submitting any issues/bug reports.**
68
80
69
81
### Supported ESLint Version
70
82
83
+
We endeavour to support the latest stable ESLint versions as soon as possible after the release.
84
+
71
85
See the value of `eslint` declared in `@typescript-eslint/eslint-plugin`'s [package.json](./packages/eslint-plugin/package.json).
0 commit comments