vim-vue-plugin

Vim syntax and indent plugin for .vue files. Mainly inspired by mxw/vim-jsx.

Install

Use VundleVim
```
  Plugin 'leafOfTree/vim-vue-plugin'
```

Use vim-pathogen

  cd ~/.vim/bundle && \
  git clone https://github.com/leafOfTree/vim-vue-plugin

Use vim-plug

  Plug 'leafOfTree/vim-vue-plugin'
  :PlugInstall

Or manually, clone this plugin, drop it in custom path/to/this_plugin, and add it to rtp in vimrc
```
  set rpt+=path/to/this_plugin
```

Plugin works if filetype is set to vue. Please stay up to date. Feel free to open an issue or a pull request.

Note: filetype used to be set to javascript.vue, which caused javascriptsyntax to be loaded multiple times and a significant delay. Now it is vue and autocmds for javascript have to be manually added for vue.

How it works

Since .vue is a combination of CSS, HTML and JavaScript, so is vim-vue-plugin. (Like XML and JavaScript for .jsx).

Supports

Pug with vim-pug (see Configuration).
Less with or without vim-less (see Configuration).
Sass/Scss (see Configuration).
.wpy files from WePY

Configuration

Set global variable to 1 to enable or 0 to disable.

Ex:

let g:vim_vue_plugin_load_full_syntax = 1

variable	description	default
`g:vim_vue_plugin_load_full_syntax`*	Enable: load all syntax files in `runtimepath` to enable related syntax plugins. Disable: only in `syntax`, `~/.vim/syntax` and `$VIM/vimfiles/syntax`	0
`g:vim_vue_plugin_use_pug`*	Enable `vim-pug` pug syntax for `<template lang="pug">`.	0
`g:vim_vue_plugin_use_less`	Enable less syntax for `<style lang="less">`.	0
`g:vim_vue_plugin_use_sass`	Enable sass/scss syntax for `<style lang="sass">`(or scss).	0
`g:vim_vue_plugin_debug`	Echo debug message in `messages` list. Useful to debug if unexpendted indents occur.	0
`g:vim_vue_plugin_has_init_indent`	Initially indent one tab inside `style/script` tags.	0 for `.vue`. 1 for `.wpy`

*: Vim may be slow if the feature is enabled. Find balance between syntax highlight and speed. By the way, custom syntax could be added in ~/.vim/syntax or $VIM/vimfiles/syntax.

Screenshot

Acknowledgments & Refs

mxw/vim-jsx

Single File Components

License

This plugin is under The Unlicense.

3.4 KiB Raw Blame History