Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neoclide/coc-vetur
Vue language server extension for coc.nvim
https://github.com/neoclide/coc-vetur
neovim vim vue vue-language-server
Last synced: 5 days ago
JSON representation
Vue language server extension for coc.nvim
- Host: GitHub
- URL: https://github.com/neoclide/coc-vetur
- Owner: neoclide
- Created: 2018-09-06T10:25:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T12:31:43.000Z (over 3 years ago)
- Last Synced: 2024-08-01T16:55:54.849Z (3 months ago)
- Topics: neovim, vim, vue, vue-language-server
- Language: TypeScript
- Size: 1.03 MB
- Stars: 218
- Watchers: 4
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-vim-setting - neoclide/coc-vetur
README
# coc-vetur
Vue language server extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
Using [vue-language-server](https://www.npmjs.com/package/vls)
**Note:** latest vetur have changed filepath of server, make sure upgrade to
latest vetur if you're using `vetur.dev.vlsPath` configuration.
## Supporting
If you like my extension, consider supporting me on Patreon or PayPal:
## Install
In your vim/neovim, run command:
```
:CocInstall coc-vetur
```
**Note** you have to install `eslint` and `eslint-plugin-vue` by:
```
npm i eslint eslint-plugin-vue -D
```
in your project root for this extension to work.
Make sure your workspace root is correct by `:echo g:WorkspaceFolders`
## Features
Language server features provided by [vue-language-server](https://www.npmjs.com/package/vls).
## Configuration options
- `vetur.ignoreProjectWarning`: Vetur will warn about not setup correctly for the project. You can disable it., default: `false`
- `vetur.useWorkspaceDependencies`: Use dependencies from workspace. Currently only for TypeScript., default: `false`
- `vetur.completion.autoImport`: Include completion for module export and auto import them, default: `true`
- `vetur.completion.useScaffoldSnippets`: Enable/disable Vetur's built-in scaffolding snippets, default: `true`
- `vetur.completion.tagCasing`: Casing conversion for tag completion, default: `"kebab"`
Valid options: ["initial","kebab"]
- `vetur.grammar.customBlocks`: Mapping from custom block tag name to language name. Used for generating grammar to support syntax highlighting for custom blocks, default: `{"docs":"md","i18n":"json"}`
- `vetur.validation.template`: Validate vue-html in using eslint-plugin-vue, default: `true`
- `vetur.validation.templateProps`: Validate props usage in region. Show error/warning for not passing declared props to child components and show error for passing wrongly typed interpolation expressions, default: `false`
- `vetur.validation.interpolation`: Validate interpolations in region using TypeScript language service, default: `true`
- `vetur.validation.style`: Validate css/scss/less/postcss in , default: `true`
- `vetur.validation.script`: Validate js/ts in <script>, default: `true`
- `vetur.format.enable`: Enable/disable the Vetur document formatter., default: `true`
- `vetur.format.options.tabSize`: Number of spaces per indentation level. Inherited by all formatters., default: `2`
- `vetur.format.options.useTabs`: Use tabs for indentation. Inherited by all formatters., default: `false`
- `vetur.format.defaultFormatter.html`: Default formatter for <template> region, default: `"prettier"`
Valid options: ["none","prettyhtml","js-beautify-html","prettier"]
- `vetur.format.defaultFormatter.pug`: Default formatter for <template lang='pug'> region, default: `"prettier"`
Valid options: ["none","prettier"]
- `vetur.format.defaultFormatter.css`: Default formatter for <style> region, default: `"prettier"`
Valid options: ["none","prettier"]
- `vetur.format.defaultFormatter.postcss`: Default formatter for <style lang='postcss'> region, default: `"prettier"`
Valid options: ["none","prettier"]
- `vetur.format.defaultFormatter.scss`: Default formatter for <style lang='scss'> region, default: `"prettier"`
Valid options: ["none","prettier"]
- `vetur.format.defaultFormatter.sass`: Default formatter for <style lang='sass'> region, default: `"sass-formatter"`
Valid options: ["none","sass-formatter"]
- `vetur.format.defaultFormatter.less`: Default formatter for <style lang='less'> region, default: `"prettier"`
Valid options: ["none","prettier"]
- `vetur.format.defaultFormatter.stylus`: Default formatter for <style lang='stylus'> region, default: `"stylus-supremacy"`
Valid options: ["none","stylus-supremacy"]
- `vetur.format.defaultFormatter.js`: Default formatter for <script> region, default: `"prettier"`
Valid options: ["none","prettier","prettier-eslint","vscode-typescript"]
- `vetur.format.defaultFormatter.ts`: Default formatter for <script> region, default: `"prettier"`
Valid options: ["none","prettier","prettier-tslint","vscode-typescript"]
- `vetur.format.defaultFormatterOptions`: Options for all default formatters, default: `{"js-beautify-html":{"wrap_attributes":"force-expand-multiline"},"prettyhtml":{"printWidth":100,"singleQuote":false,"wrapAttributes":false,"sortAttributes":false}}`
- `vetur.format.styleInitialIndent`: Whether to have initial indent for <style> region, default: `false`
- `vetur.format.scriptInitialIndent`: Whether to have initial indent for <script> region, default: `false`
- `vetur.languageFeatures.codeActions`: Whether to enable codeActions, default: `true`
- `vetur.languageFeatures.updateImportOnFileMove`: Whether to automatic updating import path when rename or move a file, default: `true`
- `vetur.trace.server`: Traces the communication between VS Code and Vue Language Server., default: `"off"`
Valid options: ["off","messages","verbose"]
- `vetur.dev.vlsPath`: Path to VLS for Vetur developers. There are two ways of using it.
1. Clone vuejs/vetur from GitHub, build it and point it to the ABSOLUTE path of `/server`.
2. `yarn global add vue-language-server` and point Vetur to the installed location (`yarn global dir` + node_modules/vue-language-server)
- `vetur.dev.vlsPort`: The port that VLS listens to. Can be used for attaching to the VLS Node process for debugging / profiling, default: `-1`
- `vetur.dev.logLevel`: Log level for VLS, default: `"INFO"`
Valid options: ["INFO","DEBUG"]
- `vetur.experimental.templateInterpolationService`: Enable template interpolation service that offers diagnostics / hover / definition / references., default: `false`
- `vetur.underline.refValue`: Enable underline `.value` when using composition API., default: `true`
Trigger completion in `coc-settings.json` to get full list of options.
## Troubleshooting
- Add `"vetur.trace.server": "verbose"` to your `coc-settings.json` (opened by command
`:CocConfig`) for verbose messages.
`coc-settings.json`
- Restart coc server by command `:CocRestart`
- Make the issue happen.
- Open tsserver output channel by command `:CocCommand workspace.showOutput vetur`.
## License
MIT