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
{{ message }}
This repository was archived by the owner on Jan 19, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+26-8
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# TypeScript ESLint Parser (Experimental)
2
2
3
-
A parser that converts TypeScript into an [ESTree](https://github.com/estree/estree)-compatible form so it can be used in ESLint. The goal is to allow TypeScript files to be parsed by ESLint (though not necessarily pass all ESLint rules).
3
+
A parser that converts TypeScript into an [ESTree](https://github.com/estree/estree)-compatible form so it can be used in ESLint.
4
4
5
-
**Important:** This parser is still in the very early stages and is considered experimental. There are likely a lot of bugs. You should not rely on this in a production environment yet.
5
+
**Important:** This parser is not fully compatbile with all ESLint rules and plugins. Some rules will improperly mark source code as failing or not find problems where it should.
6
6
7
7
## Supported TypeScript Version
8
8
@@ -14,6 +14,23 @@ If you use a non-supported version of TypeScript, the parser will log a warning
14
14
15
15
**Please ensure that you are using a supported version before submitting any issues/bug reports.**
16
16
17
+
## Known Issues
18
+
19
+
The following ESLint rules will fail on acceptable code:
The following TypeScript syntax will cause rules to fail or ESLint v3 to crash:
29
+
- Empty body functions
30
+
- Abstract methods
31
+
- Function overloading
32
+
- Declared functions
33
+
17
34
## Usage
18
35
19
36
Install:
@@ -34,12 +51,13 @@ If you're familiar with TypeScript and ESLint, and you'd like to see this projec
34
51
35
52
## Reporting Bugs
36
53
37
-
**Do not** file bugs about ESLint rule failures. This is expected because ESLint doesn't know anything about TypeScript syntax. It's likely that many ESLint rules will have failures as a result. Longer-term, it's likely we'll need to create a custom set of ESLint rules that are TypeScript-specific.
38
-
39
-
Bugs should be filed for:
40
-
41
-
1. TypeScript syntax that fails to parse.
42
-
1. TypeScript syntax that produces an unexpected AST.
54
+
Please check the current list of open and known issues and ensure the bug has not been reported before. When creating a new issue provide as much information about your enviroment as possible. This includes:
55
+
- ESLint Version
56
+
- TypeScript version
57
+
- TypeScript parser version
58
+
- ESLint config or rules and plugins currently enabled
59
+
60
+
As well include a small code sample that can be used to reproduce the issue.
0 commit comments