1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 10:40:03 +08:00
SpaceVim/bundle/vim-teal/README.md
2022-04-23 17:28:53 +08:00

33 lines
999 B
Markdown

# vim-teal
This plugin provides [Teal](https://github.com/teal-language/tl) language support for Vim.
![](media/fizzbuzz.gif)
## Features
- Syntax highlighting
- Automatic indentation
- Linting (requires [ALE](https://github.com/dense-analysis/ale))
- Automatic insertion of `end` tokens (requires [vim-endwise](https://github.com/tpope/vim-endwise))
- `:compiler` support
## Install
Using [vim-plug](https://github.com/junegunn/vim-plug):
```vim
" Teal language support
Plug 'teal-language/vim-teal'
" Optional dependencies; will be loaded on-demand when editing Teal files
Plug 'dense-analysis/ale', { 'for': 'teal' }
Plug 'tpope/vim-endwise', { 'for': 'teal' }
```
You should also make sure that the Teal compiler [is available in your PATH:](https://github.com/teal-language/tl#installing)
```
luarocks install tl
```
## Contributors
Contributions are greatly appreciated! Feel free to fork [this repository](https://github.com/teal-language/vim-teal) and open a pull request on GitHub.