Add documentation on type checking. (#146)
This adds documentation to the README about how to perform type-checking, and also links to TypeScript's documentation on editor integrations.pull/139/merge
rodzic
f2553177a9
commit
4bdc1d9fc1
13
README.md
13
README.md
|
@ -29,6 +29,19 @@ To run tests interactively, run:
|
||||||
npm run test:watch
|
npm run test:watch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Type checking
|
||||||
|
|
||||||
|
To make sure that everything type-checks okay, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run typecheck
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that you may want to install a [TypeScript plugin for your favorite editor][ts-editor]. Aside from telling you what type errors you have in real-time, editor integration also provides code autocompletion and other affordances that can greatly improve your productivity. For more details, see Atul's [Fun with TypeScript][] series of videos.
|
||||||
|
|
||||||
|
[ts-editor]: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support
|
||||||
|
[Fun with TypeScript]: https://www.youtube.com/playlist?list=PL79r88piDzwZVwCI_26T3ZjC3xKvQLgjh
|
||||||
|
|
||||||
## Code style
|
## Code style
|
||||||
|
|
||||||
All code styling is managed by [Prettier][].
|
All code styling is managed by [Prettier][].
|
||||||
|
|
Ładowanie…
Reference in New Issue