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

Commit 66e3c89

Browse files
committed
Update readme
1 parent 784f56f commit 66e3c89

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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 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.
5+
**Important:** This parser is not fully compatible 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

@@ -24,6 +24,8 @@ The following ESLint rules will fail on acceptable code:
2424

2525
The follow ESLint plugins have issues when used with this parser:
2626
- eslint-plugin-react [#213](https://github.com/eslint/typescript-eslint-parser/issues/213)
27+
- eslint-plugin-import
28+
- prefer-default-export - Will fail exports inside of Namespaces or Modules
2729

2830
The following TypeScript syntax will cause rules to fail or ESLint v3 to crash:
2931
- Empty body functions
@@ -51,7 +53,7 @@ If you're familiar with TypeScript and ESLint, and you'd like to see this projec
5153

5254
## Reporting Bugs
5355

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:
56+
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 environment as possible. This includes:
5557
- ESLint Version
5658
- TypeScript version
5759
- TypeScript parser version

0 commit comments

Comments
 (0)