mirror of
https://github.com/zed-industries/zed.git
synced 2026-06-01 03:14:56 +07:00
docs: Add Vue language server configuration (#51356)
Follow-up to https://github.com/zed-extensions/vue/pull/87. Release Notes: - N/A
This commit is contained in:
parent
4842e095d9
commit
edc8255da6
2 changed files with 56 additions and 2 deletions
|
|
@ -8,7 +8,59 @@ description: "Configure Vue language support in Zed, including language servers,
|
|||
Vue support is available through the [Vue extension](https://github.com/zed-extensions/vue).
|
||||
|
||||
- Tree-sitter: [tree-sitter-grammars/tree-sitter-vue](https://github.com/tree-sitter-grammars/tree-sitter-vue)
|
||||
- Language Server: [vuejs/language-tools/](https://github.com/vuejs/language-tools/)
|
||||
- Language Server: [vuejs/language-tools](https://github.com/vuejs/language-tools)
|
||||
|
||||
## Initialization Options
|
||||
|
||||
### Specifying location of TypeScript SDK
|
||||
|
||||
By default, this extension assumes that you are working in a project with a `node_modules` directory, and searches for
|
||||
the TypeScript SDK inside that directory.
|
||||
|
||||
This may not always be true; for example, when working in a project that uses Yarn PnP, there is no `node_modules`. For
|
||||
editor support, the [documented](https://yarnpkg.com/getting-started/editor-sdks) approach is to run something like
|
||||
`yarn dlx @yarnpkg/sdks`. In that case, you can provide the following initialization options in your Zed settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"lsp": {
|
||||
"vue": {
|
||||
"initialization_options": {
|
||||
"typescript": {
|
||||
"tsdk": ".yarn/sdks/typescript/lib"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Settings Options
|
||||
|
||||
`lsp.vue.settings` is passed through to the Vue language server (Volar / [`vuejs/language-tools`](https://github.com/vuejs/language-tools)). The following settings are enabled by default:
|
||||
|
||||
```json
|
||||
{
|
||||
"lsp": {
|
||||
"vue": {
|
||||
"settings": {
|
||||
// Display inlay hints for the `$event` parameter in inline event handlers.
|
||||
"vue.inlayHints.inlineHandlerLeading": true,
|
||||
// Display hints when required component props are missing in templates.
|
||||
"vue.inlayHints.missingProps": true,
|
||||
// Display inlay hints for patterns that wrap component options.
|
||||
"vue.inlayHints.optionsWrapper": true,
|
||||
// Display inlay hints related to `v-bind` shorthand (`:`).
|
||||
"vue.inlayHints.vBindShorthand": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can find the upstream settings configuration schema [`here`](https://github.com/vuejs/language-tools/blob/ee5041d27940cf6f9a5150635d3b13140a9dff54/extensions/vscode/package.json#L252).
|
||||
|
||||
> Note: Some settings (e.g. `vue.editor.focusMode`) may not take effect.
|
||||
|
||||
## Using the Tailwind CSS Language Server with Vue
|
||||
|
||||
|
|
|
|||
|
|
@ -92,6 +92,8 @@ extend-ignore-re = [
|
|||
# AMD GPU Services
|
||||
"ags",
|
||||
# AMD GPU Services
|
||||
"AGS"
|
||||
"AGS",
|
||||
# Yarn Plug'n'Play
|
||||
"PnP"
|
||||
]
|
||||
check-filename = true
|
||||
|
|
|
|||
Loading…
Reference in a new issue