@yaegassy/coc-volar

yaegassy

Volar (Fast Vue Language Support) extension for coc.nvim

Installation CommandVim prompt

:CocInstall @yaegassy/coc-volar

GitHub owner

yaegassy

Version

v0.37.4

npm package

@yaegassy/coc-volar

Requirements

coc ^0.0.80

License

MIT

Repository

GitHub

npm latest published 2025-03-02Registry checked 2026-08-23Registry summary

Published Package Summary

coc-volar

fork from a vuejs/language-tools/extensions/vscode

Vue Language Features (Volar) extension for coc.nvim coc-volar-demo

Install

:CocInstall @yaegassy/coc-volar

scoped packages

Note

coc-volar version v0.35.0 and later uses vue-language-server version v2.x.x. If you have coc-typescript-vue-plugin installed, please uninstall it as it will cause conflicts and errors.
- :CocUninstall @yaegassy/coc-typescript-vue-plugin
To utilize various language features such as IntelliSense, Diagnostics, and more in the <script> blocks of Vue files, you need to install either coc-tsserver or coc-tsserver-dev.
- :CocInstall coc-tsserver or :CocInstall coc-tsserver-dev
- Note: coc-volar checks if coc-tsserver or coc-tsserver-dev are installed in the environment when opening a Vue file. If they are installed, coc-volar automatically starts tsserver.

[RECOMMENDED] Additional installation of "watchman"

In the @vue/language-server used by coc-volar, it utilizes the workspace/didChangeWatchedFiles notification to watch files within the project.

In coc.nvim, it is recommended to install watchman in order to utilize this feature.

See: https://github.com/neoclide/coc.nvim/wiki/Using-coc-extensions

If you have difficulty installing watchman, you can use coc-volar without watchman, but you may not be able to immediately use volar's IntelliSense with the newly added files.

In this case, please execute the command to restart the language server.

:CocRestart

workspaceFolders

Depending on the project like mono repo or how Vim/Neovim is started, workspaceFolders may not be recognized correctly.

If workspaceFolders are not recognized correctly, the language server may parse unnecessary project folders, etc., slowing down the operation. Or Language Server may not work properly.

The default configuration of coc.nvim resolves to the directory where the .git, .hg, or .projections.json files reside as the workspace root.

coc-volar has also already added vite.config.ts, vite.config.js, vue.config.js or nuxt.config.ts to the extension side to resolve workspace root.

If further customization is needed, set b:coc_root_patterns in ".vimrc/init.vim".

Example:

  au FileType vue let b:coc_root_patterns = ['.git', '.env', 'package.json', 'tsconfig.json', 'jsconfig.json', 'vite.config.ts', 'vite.config.js', 'vue.config.js', 'nuxt.config.ts']

For more information, check this coc.nvim's wiki.

https://github.com/neoclide/coc.nvim/wiki/Using-workspaceFolders

iskeyword

If the completion menu disappears when typing -, add the iskeyword setting to .vimrc / init.vim.

autocmd Filetype vue setlocal iskeyword+=-

More features

Other major LSP feature are of course supported as well.

completion, definition, typeDefinition, diagnostics, hover, signatureHelp, references, codeLens, formatting, rename and more...

Thanks

vuejs/language-tools

License

MIT

This extension is built with create-coc-extension

Read the complete README

Volar (Fast Vue Language Support) extension for coc.nvim

Activation Events

onLanguage:vue

Developer Resources

Want to build, test, or contribute to coc.nvim extensions? Explore our official SDK and testing toolkits.

Open Developer Guide

This published npm package does not include a history.md or changelog.md file. Browse its npm versions or repository releases for available release information.

All contributes.commands entries from the published package manifest for @yaegassy/coc-volar@0.37.4.

Command (:CocCommand)	Description
volar.action.doctor	Show Doctor info
vue.action.restartServer	Restart Vue server

All contributes.configuration entries from the published package manifest, including each raw property schema for coc-settings.json.

vetur.enableboolean

Enable coc-vetur extension.

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Enable coc-vetur extension."
}

volar.enableboolean

Enable coc-volar extension.

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Enable coc-volar extension."
}

volar.tsLocalestring

Sets the locale used to report diagnostics message from typescript.

Default: "en"

Raw JSON Schema

{
  "enum": [
    "cs",
    "de",
    "es",
    "fr",
    "it",
    "ja",
    "ko",
    "en",
    "pl",
    "pt-br",
    "ru",
    "tr",
    "zh-cn",
    "zh-tw"
  ],
  "type": "string",
  "default": "en",
  "description": "Sets the locale used to report diagnostics message from typescript."
}

vue.server.pathstring | null

Custom path to volar server module, ~ and $HOME can also be used. If there is no setting, the built-in module will be used.

Default: null

Raw JSON Schema

{
  "type": [
    "string",
    "null"
  ],
  "default": null,
  "description": "Custom path to volar server module, ~ and $HOME can also be used. If there is no setting, the built-in module will be used."
}

vue.trace.serverstring

Traces the communication between coc.nvim and the language server.

Default: "off"

Raw JSON Schema

{
  "enum": [
    "off",
    "messages",
    "verbose"
  ],
  "type": "string",
  "scope": "window",
  "default": "off",
  "description": "Traces the communication between coc.nvim and the language server."
}

vue.codeLens.enabledboolean

Enabled code lens.

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Enabled code lens."
}

vue.server.hybridModeboolean

Vue language server only handles CSS and HTML language support, and tsserver takes over TS language support via TS plugin.

Default: true

Raw JSON Schema

{
  "enum": [
    true,
    false
  ],
  "type": "boolean",
  "default": true,
  "description": "Vue language server only handles CSS and HTML language support, and tsserver takes over TS language support via TS plugin.",
  "enumDescriptions": [
    "Enable TypeScript Plugin/Hybrid Mode.",
    "Disable TypeScript Plugin/Hybrid Mode."
  ]
}

volar.useWorkspaceTsdkboolean

Use workspace (project) detected tsLibs in volar. if false, use coc-volar's built-in tsLibs.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Use workspace (project) detected tsLibs in volar. if false, use coc-volar's built-in tsLibs."
}

volar.disableCompletionboolean

Disable completion from Volar.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Disable completion from Volar."
}

volar.disableFormattingboolean

Disable formatting from Volar.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Disable formatting from Volar."
}

vue.codeActions.enabledboolean

Enabled code actions.

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Enabled code actions."
}

volar.disableDiagnosticsboolean

Disable diagnostics from Volar.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Disable diagnostics from Volar."
}

vue.complete.casing.tagsstring

Preferred tag name case.

Default: "autoPascal"

Raw JSON Schema

{
  "enum": [
    "autoKebab",
    "autoPascal",
    "kebab",
    "pascal"
  ],
  "type": "string",
  "default": "autoPascal",
  "description": "Preferred tag name case.",
  "enumDescriptions": [
    "Auto Detect from Content (Fallback to <kebab-case> if detect failed)",
    "Auto Detect from Content  (Fallback to <PascalCase> if detect failed)",
    "<kebab-case>",
    "<PascalCase>"
  ]
}

vue.complete.casing.propsstring

Preferred attr name case.

Default: "autoKebab"

Raw JSON Schema

{
  "enum": [
    "autoKebab",
    "autoCamel",
    "kebab",
    "camel"
  ],
  "type": "string",
  "default": "autoKebab",
  "description": "Preferred attr name case.",
  "enumDescriptions": [
    "Auto Detect from Content (Fallback to :kebab-case=\"...\" if detect failed)",
    "Auto Detect from Content (Fallback to :camelCase=\"...\" if detect failed)",
    ":kebab-case=\"...\"",
    ":camelCase=\"...\""
  ]
}

vue.server.maxOldSpaceSizenumber | null

Set --max-old-space-size option on server process. If you have problem on frequently "Request textDocument/** failed." error, try setting higher memory(MB) on it.

Default: null

Raw JSON Schema

{
  "type": [
    "number",
    "null"
  ],
  "default": null,
  "description": "Set --max-old-space-size option on server process. If you have problem on frequently \"Request textDocument/** failed.\" error, try setting higher memory(MB) on it."
}

vue.inlayHints.missingPropsboolean

Show inlay hints for missing required props.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Show inlay hints for missing required props."
}

vue.server.includeLanguagesarray

Default: ["vue"]

Raw JSON Schema

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "default": [
    "vue"
  ]
}

volar.scaffoldSnippets.enableboolean

Enable/disable scaffold snippets completion. Typing `vue` or `vuedc` will output completion suggestions. This snippets completion feature will only work on the first line of the file.

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Enable/disable scaffold snippets completion. Typing `vue` or `vuedc` will output completion suggestions. This snippets completion feature will only work on the first line of the file."
}

vue.complete.defineAssignmentboolean

Auto add `const props = ` before `defineProps` when selecting the completion item `props`. (also `emit` and `slots`)

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true,
  "description": "Auto add `const props = ` before `defineProps` when selecting the completion item `props`. (also `emit` and `slots`)"
}

vue.inlayHints.optionsWrapperboolean

Show inlay hints for component options wrapper for type support.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Show inlay hints for component options wrapper for type support."
}

vue.inlayHints.vBindShorthandboolean

Show inlay hints for v-bind shorthand.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Show inlay hints for v-bind shorthand."
}

vue.format.style.initialIndentboolean

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false
}

vue.format.script.initialIndentboolean

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false
}

vue.inlayHints.destructuredPropsboolean

Show inlay hints for destructured props.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Show inlay hints for destructured props."
}

vue.format.template.initialIndentboolean

Default: true

Raw JSON Schema

{
  "type": "boolean",
  "default": true
}

volar.disableProgressNotificationsboolean

Disable the initialization and workdone progress notifications.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Disable the initialization and workdone progress notifications."
}

vue.inlayHints.inlineHandlerLeadingboolean

Show inlay hints for event argument in inline handlers.

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Show inlay hints for event argument in inline handlers."
}

volar.middleware.provideCompletionItem.enableboolean

Enable fix patch for code action issue #226

Default: false

Raw JSON Schema

{
  "type": "boolean",
  "default": false,
  "description": "Enable fix patch for code action issue #226"
}

@yaegassy/coc-volar

Published Package Summary

coc-volar

Install

Note

[RECOMMENDED] Additional installation of "watchman"

workspaceFolders

iskeyword

More features

Thanks

License

Version History

Contributed Commands

Configuration Schema