TypeScript layer
Table of ContentsClose
1 Description
This layer adds support for TypeScript and TSX editing.
This layer provides:
- Eldoc-mode
- Documentation at point
- Auto complete
- Flycheck with linter
- Jump to definition, Jump to type definition
- Find occurrences (Imenu-mode)
- Rename symbol
- tsx mode
- formatting
- TypeScript playground integration
2 Install
2.1 Pre-requisites
You will need node.js v0.12.0
or greater
If you want linting run: npm install -g typescript
npm install -g tslint
If you want to use typescript-formatter for formatting run: npm install -g typescript-formatter
For best results, make sure that the auto-completion
(company) and html
layers are enabled.
2.2 Layer
To use this configuration layer, add it to your ~/.spacemacs
. You will need to
add typescript
to the existing dotspacemacs-configuration-layers
list in this
file.
(setq-default dotspacemacs-configuration-layers '(typescript))
If you need formatting on save:
(setq-default dotspacemacs-configuration-layers '( (typescript :variables typescript-fmt-on-save t)))
You can choose formatting tool:
(setq-default dotspacemacs-configuration-layers '( (typescript :variables typescript-fmt-tool 'typescript-formatter)))
Default is 'tide .
2.3 Notes
This layer uses:
- tide
- flycheck-typescript-tslint
- typescript-formatter - optional.
The tools use configuration files. You can learn more in their documentation.
Make sure to add tsconfig.json in the project root folder.
tsserver mangles output sometimes issue - #2758, which will result in json parse error. Try node version 0.12.x if you get this error.
Send to playground requires browser.
Currently tsserver doesn't pickup tsconfig.json file changes. You might need to restart server after editing it.
3 Key bindings
3.1 Typescript Major Mode
Key Binding | Description |
---|---|
SPC m = |
reformat the buffer |
SPC m g b |
jump back |
SPC m g g |
jump to entity's definition |
SPC m g t |
jump to entity's type definition |
SPC m g u |
references |
SPC m h h |
documentation at point |
SPC m r r |
rename symbol |
SPC m s p |
send selected region or current buffer to the web playground |
SPC m S r |
restart server |