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
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -34,24 +34,24 @@
34
34
35
35
## Getting Started
36
36
37
-
**[You can find our Getting Started docs here](./docs/getting-started/README.md)**
38
-
**[You can find our Linting FAQ / Troubleshooting docs here](./docs/getting-started/linting/FAQ.md)**
37
+
-**[You can find our Getting Started docs here](./docs/getting-started/README.md)**
38
+
-**[You can find our Linting FAQ / Troubleshooting docs here](./docs/getting-started/linting/FAQ.md)**
39
39
40
40
The documentation below will give you an overview of what this project is, why it exists and how it works at a high level.
41
41
42
-
**It is very important that you are familiar with these concepts before reporting issues**, so it is a good idea to read them before raising issues.
42
+
**It is crucial that you are familiar with these concepts before reporting issues**, so it is a good idea to read them before raising issues.
43
43
44
44
<br>
45
45
46
46
## What are ESLint and TypeScript, and how do they compare?
47
47
48
48
**ESLint** is an awesome linter for JavaScript code.
49
49
50
-
- Behind the scenes it uses a parser to turn your source code into a data format called an Abstract Syntax Tree (AST). This data format is then used by plugins to create assertions called lint rules around what your code should look or behave like.
50
+
- Behind the scenes, it uses a parser to turn your source code into a data format called an Abstract Syntax Tree (AST). This data format is then used by plugins to create assertions called lint rules around what your code should look or behave like.
51
51
52
52
**TypeScript** is an awesome static code analyzer for JavaScript code, and some additional syntax that it provides on top of the underlying JavaScript language.
53
53
54
-
- Behind the scenes it uses a parser to turn your source code into a data format called an Abstract Syntax Tree (AST). This data format is then used by other parts of the TypeScript Compiler to do things like give you feedback on issues, allow you to refactor easily etc.
54
+
- Behind the scenes, it uses a parser to turn your source code into a data format called an Abstract Syntax Tree (AST). This data format is then used by other parts of the TypeScript Compiler to do things like give you feedback on issues, allow you to refactor easily, etc.
55
55
56
56
They sound similar, right? They are! Both projects are ultimately striving to help you write the best JavaScript code you possibly can.
57
57
@@ -63,7 +63,7 @@ As covered by the previous section, both ESLint and TypeScript rely on turning y
63
63
64
64
However, it turns out that ESLint and TypeScript use _different_ ASTs to each other.
65
65
66
-
The reason for this difference is not so interesting or important, and is simply the result of different evolutions, priorities and timelines of the projects.
66
+
The reason for this difference is not so interesting or important and is simply the result of different evolutions, priorities, and timelines of the projects.
67
67
68
68
This project, `typescript-eslint`, exists primarily because of this major difference between the projects.
69
69
@@ -105,29 +105,29 @@ For example:
105
105
var x:number=1;
106
106
```
107
107
108
-
This is not valid JavaScript code, because it contains a so-called type annotation. When the TypeScript Compiler parses this code to produce a TypeScript AST, that`: number` syntax will be represented in the tree, and this is simply not something that ESLint can understand without additional help.
108
+
This is not valid JavaScript code, because it contains a so-called type annotation. When the TypeScript Compiler parses this code to produce a TypeScript AST, the`: number` syntax will be represented in the tree, and this is simply not something that ESLint can understand without additional help.
109
109
110
110
However, we can leverage the fact that ESLint has been designed with these use-cases in mind!
111
111
112
-
It turns out that ESLint is not just one library. Instead it is composed of a few important moving parts. One of those moving parts is **the parser**. ESLint ships with a parser built in (called [`espree`](https://github.com/eslint/espree)), and so if you only ever write standard JavaScript, you don't need to care about this implementation detail.
112
+
It turns out that ESLint is not just one library. Instead, it is composed of a few important moving parts. One of those moving parts is **the parser**. ESLint ships with a built-in parser (called [`espree`](https://github.com/eslint/espree)), and so if you only ever write standard JavaScript, you don't need to care about this implementation detail.
113
113
114
114
The great thing is, though, if we want to support non-standard JavaScript syntax, all we need to do is provide ESLint with an alternative parser to use - that is a first-class use-case offered by ESLint.
115
115
116
-
Knowing we can do this is just the start of course, we then need to set about creating a parser which is capable of parsing TypeScript source code, and delivering an AST which is compatible with the one ESLint expects (with some additions for things such as `: number` as mentioned above).
116
+
Knowing we can do this is just the start, of course, we then need to set about creating a parser which is capable of parsing TypeScript source code, and delivering an AST which is compatible with the one ESLint expects (with some additions for things such as `: number`, as mentioned above).
117
117
118
-
The [`@typescript-eslint/parser`](./packages/parser/) package in this monorepo is in fact the custom ESLint parser implementation we provide to ESLint in this scenario.
118
+
The [`@typescript-eslint/parser`](./packages/parser/) package in this monorepo is, in fact, the custom ESLint parser implementation we provide to ESLint in this scenario.
119
119
120
120
The flow and transformations that happen look a little something like this:
121
121
122
122
- ESLint invokes the `parser` specified in your ESLint config ([`@typescript-eslint/parser`](./packages/parser/))
123
123
124
-
-[`@typescript-eslint/parser`](./packages/parser/) deals with all the ESLint specific configuration, and then invokes [`@typescript-eslint/typescript-estree`](./packages/typescript-estree/), an agnostic package that is only concerned with taking TypeScript source code and producing an appropriate AST.
124
+
-[`@typescript-eslint/parser`](./packages/parser/) deals with all the ESLint specific configuration and then invokes [`@typescript-eslint/typescript-estree`](./packages/typescript-estree/), an agnostic package that is only concerned with taking TypeScript source code and producing an appropriate AST.
125
125
126
-
-[`@typescript-eslint/typescript-estree`](./packages/typescript-estree/) works by invoking the TypeScript Compiler on the given source code in order to produce a TypeScript AST, and then converting that AST into a format that ESLint expects.
126
+
-[`@typescript-eslint/typescript-estree`](./packages/typescript-estree/) works by invoking the TypeScript Compiler on the given source code in order to produce a TypeScript AST and then converting that AST into a format that ESLint expects.
127
127
128
-
**Note**: This AST format is actually more broadly used than just for ESLint. It even has its own spec and is known as **[ESTree](https://github.com/estree/estree)**, which is why our package is called `typescript-estree`.
128
+
**Note**: This AST format is more broadly used than just for ESLint. It even has its own spec and is known as **[ESTree](https://github.com/estree/estree)**, which is why our package is called `typescript-estree`.
129
129
130
-
> Because [`@typescript-eslint/typescript-estree`](./packages/typescript-estree/) has a very specific purpose, it is reusable for tools with similar requirements to ESLint. It is therefore also used to power the amazing opinionated code formatter [Prettier](https://prettier.io)'s own TypeScript use-case.
130
+
> Because [`@typescript-eslint/typescript-estree`](./packages/typescript-estree/) has a very specific purpose, it is reusable for tools with similar requirements to ESLint. It is therefore also used to power the amazing opinionated code formatter [Prettier](https://prettier.io)'s TypeScript use-case.
131
131
132
132
That just about covers the parsing piece! But what about the rules? This is where our plugins come into play.
133
133
@@ -139,14 +139,14 @@ The short answer is, no.
139
139
140
140
The great news is, **there are many, many rules which will "just work"** without you having to change anything about them or provide any custom alternatives.
141
141
142
-
However, it is super important to be mindful all of the things we have covered in this README so far.
142
+
However, it is super important to be mindful of all of the things we have covered in this README so far.
143
143
144
144
- TypeScript and ESLint have similar purposes
145
145
146
146
- This means that there will be cases where TypeScript actually solves a problem for us that we previously relied on ESLint for. These two solutions could have similar aims, but different results, or be incompatible in other ways. The best way to deal with situations like this is often to disable the relevant ESLint rule and go with the TypeScript Compiler.
147
147
148
148
- TypeScript is a superset of JavaScript
149
-
- Even with the AST conversion in place in the parser, there can be things in the final AST which ESLint does not natively understand. If ESLint rules have been written in such a way that they make particular assumptions about ASTs, this can sometimes result in rules crashing. This can be mitigated in a number of ways - we can work with rule authors to make their code more robust, or we can provide alternative rules via our own [`@typescript-eslint/eslint-plugin`](./packages/eslint-plugin/).
149
+
- Even with the AST conversion in place in the parser, there can be things in the final AST which ESLint does not natively understand. If ESLint rules have been written in such a way that they make particular assumptions about ASTs, this can sometimes result in rules crashing. This can be mitigated in several ways - we can work with rule authors to make their code more robust, or we can provide alternative rules via our own [`@typescript-eslint/eslint-plugin`](./packages/eslint-plugin/).
150
150
151
151
<br>
152
152
@@ -158,19 +158,19 @@ One of the huge benefits of using TypeScript is the fact that type information c
158
158
159
159
When the transformation steps outlined above take place, we keep references to the original TypeScript AST and associated parser services, and so ESLint rules authors can access them in their rules.
160
160
161
-
We already do this in numerous rules within [`@typescript-eslint/eslint-plugin`](./packages/eslint-plugin/), for example `no-unnecessary-type-assertion` and `no-inferrable-types`.
161
+
We already do this in numerous rules within [`@typescript-eslint/eslint-plugin`](./packages/eslint-plugin/), for example,`no-unnecessary-type-assertion` and `no-inferrable-types`.
162
162
163<
A3E2
/code>
163
<br>
164
164
165
165
## What about Babel and `babel-eslint`?
166
166
167
167
Babel does now support parsing (but not type-checking) TypeScript source code. This is as an alternative to using the TypeScript Compiler. It also supports many other syntaxes, via plugins, which are not supported by the TypeScript Compiler. As mentioned above, `typescript-eslint` is powered by the TypeScript Compiler, so we support whatever it does.
168
168
169
-
The key trade-off can be summarized as:`babel-eslint` supports additional syntax which TypeScript itself does not, but `typescript-eslint` supports creating rules based on type information, which is not available to babel because there is no type-checker.
169
+
The key trade-off can be summarized as `babel-eslint` supports additional syntax which TypeScript itself does not, but `typescript-eslint` supports creating rules based on type information, which is not available to babel because there is no type-checker.
170
170
171
171
Because they are separate projects powered by different underlying tooling, they are currently not intended to be used together.
172
172
173
-
Some of the people involved in `typescript-eslint` are also involved in Babel and `babel-eslint`, and in this project we are working hard to align on the AST format for non-standard JavaScript syntax. This is an ongoing effort.
173
+
Some of the people involved in `typescript-eslint` are also involved in Babel and `babel-eslint`, and in this project, we are working hard to align on the AST format for non-standard JavaScript syntax. This is an ongoing effort.
174
174
175
175
<br>
176
176
@@ -180,7 +180,7 @@ I'm so glad you asked!
180
180
181
181
As you can see at the [top of this repo](#typescript-eslint), these packages are already downloaded millions of times per month, and power high profile projects across our industry.
182
182
183
-
Nevertheless, this is a 100% communitydriven project. From the second you install one of the packages from this monorepo, you are a part of that community.
183
+
Nevertheless, this is a 100% community-driven project. From the second you install one of the packages from this monorepo, you are a part of that community.
184
184
185
185
Please be respectful and mindful of how many hours of unpaid work go into building out all of the functionality we have introduced (in brief detail) above.
186
186
@@ -208,7 +208,7 @@ Please follow the links below for the packages you care about.
208
208
209
209
-[`@typescript-eslint/eslint-plugin`](./packages/eslint-plugin/) - An ESLint-specific plugin which, when used in conjunction with `@typescript-eslint/parser`, allows for TypeScript-specific linting rules to run.
210
210
211
-
-[`@typescript-eslint/eslint-plugin-tslint`](./packages/eslint-plugin-tslint) - An ESLint-specific plugin which runs an instance of TSLint within your ESLint setup to allow for users to more easily migrate from TSLint to ESLint.
211
+
-[`@typescript-eslint/eslint-plugin-tslint`](./packages/eslint-plugin-tslint) - An ESLint-specific plugin that runs an instance of TSLint within your ESLint setup to allow for users to more easily migrate from TSLint to ESLint.
212
212
213
213
<br>
214
214
@@ -218,7 +218,7 @@ All of the packages are published with the same version number to make it easier
218
218
219
219
We publish a canary release on every successful merge to master, so **you never need to wait for a new stable version to make use of any updates**.
220
220
221
-
Additionally, we promote the to the `latest` tag on NPM once per week, **on Mondays at 1pm Eastern**.
221
+
Additionally, we promote the to the `latest` tag on NPM once per week, **on Mondays at 1 pm Eastern**.
222
222
223
223
The latest version under the `latest` tag is:
224
224
@@ -228,7 +228,7 @@ The latest version under the `canary` tag **(latest commit to master)** is:
(Note: The only exceptions to the automated publishes described above are when we are in the final phases of creating the next major version of the libraries - e.g. going from `1.x.x` to `2.x.x`. During these periods, we manually publish `canary` releases until we are happy with the release and promote it to `latest`.)
231
+
(Note: The only exception to the automated publishes described above is when we are in the final phases of creating the next major version of the libraries - e.g. going from `1.x.x` to `2.x.x`. During these periods, we manually publish `canary` releases until we are happy with the release and promote it to `latest`.)
232
232
233
233
<br>
234
234
@@ -272,7 +272,7 @@ This project exists thanks to every one of the awesome people who contribute cod
272
272
273
273
## Financial Contributors
274
274
275
-
In addition to submitting code and documentation updates, you can help us sustain our community by becoming a financial contributor [[Click here to contribute - every little helps!](https://opencollective.com/typescript-eslint/contribute)]
275
+
In addition to submitting code and documentation updates, you can help us sustain our community by becoming a financial contributor [[Click here to contribute - every little bit helps!](https://opencollective.com/typescript-eslint/contribute)]
276
276
277
277
<br>
278
278
@@ -282,7 +282,7 @@ In addition to submitting code and documentation updates, you can help us sustai
282
282
283
283
### Organizations
284
284
285
-
Support this project with your organization. Your logo will show up here with a link to your website. [[Click here to contribute - every little helps!](https://opencollective.com/typescript-eslint/contribute)]
285
+
Support this project with your organization. Your logo will show up here with a link to your website. [[Click here to contribute - every little bit helps!](https://opencollective.com/typescript-eslint/contribute)]
0 commit comments