Skip to content
This repository was archived by the owner on Jan 19, 2019. It is now read-only.

Commit aade6bd

Browse files
soda0289JamesHenry
authored andcommitted
Chore: Update README with list of known issues (#247)
1 parent c8e881a commit aade6bd

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

+26-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# TypeScript ESLint Parser (Experimental)
22

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.
44

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.
66

77
## Supported TypeScript Version
88

@@ -14,6 +14,23 @@ If you use a non-supported version of TypeScript, the parser will log a warning
1414

1515
**Please ensure that you are using a supported version before submitting any issues/bug reports.**
1616

17+
## Known Issues
18+
19+
The following ESLint rules will fail on acceptable code:
20+
- no-undef [#77](https://github.com/eslint/typescript-eslint-parser/issues/77)
21+
- no-unused-vars [#77](https://github.com/eslint/typescript-eslint-parser/issues/77)
22+
- no-useless-constructor [#77](https://github.com/eslint/typescript-eslint-parser/issues/77)
23+
- space-infix-ops [#224](https://github.com/eslint/typescript-eslint-parser/issues/224)
24+
25+
The follow ESLint plugins have issues when used with this parser:
26+
- eslint-plugin-react [#213](https://github.com/eslint/typescript-eslint-parser/issues/213)
27+
28+
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+
1734
## Usage
1835

1936
Install:
@@ -34,12 +51,13 @@ If you're familiar with TypeScript and ESLint, and you'd like to see this projec
3451

3552
## Reporting Bugs
3653

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.
4361

4462
## Contributing
4563

0 commit comments

Comments
 (0)