@@ -84,6 +84,9 @@ If you want to write your own configuration, installing a QML grammar and the LS
84
84
85
85
Read the [ Usage Guide] ( /docs/guide ) after configuring your editor.
86
86
87
+ > [ !NOTE]
88
+ > Qmlls versions prior to 6.8.2 do not require ` -E `
89
+
87
90
### Emacs
88
91
Install the [ yuja/tree-sitter-qml] ( https://github.com/yuja/tree-sitter-qmljs ) tree-sitter grammar,
89
92
and the [ xhcoding/qml-ts-mode] ( https://github.com/xhcoding/qml-ts-mode ) mode.
@@ -107,26 +110,38 @@ The author's personal emacs config uses `lsp-mode` and `qml-ts-mode` as follows:
107
110
(lsp-deferred))))
108
111
```
109
112
110
- > [ !NOTE]
111
- > Qmlls versions prior to 6.8.2 do not require ` -E `
112
-
113
113
### Neovim
114
114
Neovim has built-in syntax highlighting for QML, however tree-sitter highlighting
115
115
may work better than the built-in highlighting. You can install the grammar
116
116
using ` :TSInstall qmljs ` .
117
117
118
118
To use the language server ([ caveats below] ( #language-server ) ),
119
119
install [ nvim-lspconfig] ( https://github.com/neovim/nvim-lspconfig )
120
- and the following snippet:
120
+ and the following snippet to your configuration :
121
121
122
122
``` lua
123
123
require (" lspconfig" ).qmlls .setup {
124
124
cmd = {" qmlls" , " -E" }
125
125
}
126
126
```
127
127
128
- > [ !NOTE]
129
- > Qmlls versions prior to 6.8.2 do not require ` -E `
128
+ ### Helix
129
+ Helix has built-in syntax highlighting for QML.
130
+
131
+ To use the language server, add the following snippet to your configuration:
132
+
133
+ ``` toml
134
+ [language-server .qmlls ]
135
+ args = [" -E" ]
136
+ command = " qmlls"
137
+ ```
138
+
139
+ ### Vscode
140
+ 1 . Install the [ Official QML Support extension]
141
+ 2 . Enable the ` qt-qml.qmlls.useQmlImportPathEnvVar ` setting.
142
+ ![ ] ( /assets/images/vscode-qml-env.png )
143
+
144
+ [ Official QML Support extension ] : https://marketplace.visualstudio.com/items?itemName=TheQtCompany.qt-qml
130
145
131
146
## Language Server
132
147
The QML language has an associated language server,
@@ -141,6 +156,7 @@ We are aware of the following issues:
141
156
- Qmlls cannot handle quickshell's singletons. This means you won't see
142
157
completions, and usages of singleton members may show a warning.
143
158
We're still investigating this problem and how to fix it.
159
+ - The LSP cannot provide any documentation for Quickshell types.
144
160
145
161
Keeping in mind the above caveats, qmlls should be able to guide you towards
146
162
more correct code should you chose to use it.
0 commit comments