mirror of
https://github.com/posva/vim-vue.git
synced 2025-12-08 10:24:45 +08:00
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
# vim-vue
|
|
|
|
Vim syntax highlighting for [Vue
|
|
components](https://vuejs.org/v2/guide/single-file-components.html).
|
|
|
|
This was initially forked from
|
|
[darthmall/vim-vue](https://github.com/darthmall/vim-vue). I already have an
|
|
implementation for this but found his code much cleaner. That's why I created a
|
|
new version instead of a PR.
|
|
|
|
## Installation
|
|
|
|
### Install with [Vundle](https://github.com/VundleVim/Vundle.vim)
|
|
|
|
```viml
|
|
Plugin 'posva/vim-vue'
|
|
```
|
|
|
|
### Install with [Pathogen](https://github.com/tpope/vim-pathogen)
|
|
|
|
```bash
|
|
cd ~/.vim/bundle && \
|
|
git clone https://github.com/posva/vim-vue.git
|
|
```
|
|
|
|
### Install without a plugin manager (Vim 8)
|
|
|
|
```bash
|
|
git clone https://github.com/posva/vim-vue.git ~/.vim/pack/plugins/start
|
|
```
|
|
|
|
### Integration with [Syntastic](https://github.com/scrooloose/syntastic)
|
|
|
|
Currently only `eslint` is available. Please make sure `eslint` and
|
|
`eslint-plugin-vue` are installed:
|
|
|
|
```bash
|
|
npm i -g eslint eslint-plugin-vue
|
|
```
|
|
|
|
## Typescript support
|
|
|
|
You can use typescript by adding one of the following attributes/values to
|
|
your component's script tag:
|
|
|
|
```html
|
|
<script ts></script>
|
|
<script lang="ts"></script>
|
|
<script lang="typescript"></script>
|
|
```
|
|
|
|
Choose one that works with your module bundler
|
|
|
|
|
|
## Contributing
|
|
|
|
If your language is not getting highlighted open an issue or a PR with the fix.
|
|
You only need to add some lines to the `syntax/vue.vim` file.
|
|
|
|
## FAQ
|
|
|
|
Where is Jade?
|
|
|
|
[Jade has been renamed to pug](https://github.com/pugjs/jade/issues/2184).
|
|
Therefore you have to replace all your `jade` occurrences with `pug`. The new
|
|
plugin for `pug` can be found on [the same repository](https://github.com/digitaltoad/vim-pug) (the name has already been updated).
|