summaryrefslogtreecommitdiff
path: root/nvim/lsp/yamlls.lua
diff options
context:
space:
mode:
authoranand <anand.panchdhari@gmail.com>2025-12-17 15:57:55 +0530
committeranand <anand.panchdhari@gmail.com>2025-12-17 15:57:55 +0530
commitb7ef29a8886a57aadb787807a7c6cf74c1f0ed3a (patch)
tree366a68240fbc9da6b1d567bd6c46d1350ad814de /nvim/lsp/yamlls.lua
Nixos
Diffstat (limited to 'nvim/lsp/yamlls.lua')
-rwxr-xr-xnvim/lsp/yamlls.lua69
1 files changed, 69 insertions, 0 deletions
diff --git a/nvim/lsp/yamlls.lua b/nvim/lsp/yamlls.lua
new file mode 100755
index 0000000..4d2ebca
--- /dev/null
+++ b/nvim/lsp/yamlls.lua
@@ -0,0 +1,69 @@
+---@brief
+---
+--- https://github.com/redhat-developer/yaml-language-server
+---
+--- `yaml-language-server` can be installed via `yarn`:
+--- ```sh
+--- yarn global add yaml-language-server
+--- ```
+---
+--- To use a schema for validation, there are two options:
+---
+--- 1. Add a modeline to the file. A modeline is a comment of the form:
+---
+--- ```
+--- # yaml-language-server: $schema=<urlToTheSchema|relativeFilePath|absoluteFilePath}>
+--- ```
+---
+--- where the relative filepath is the path relative to the open yaml file, and the absolute filepath
+--- is the filepath relative to the filesystem root ('/' on unix systems)
+---
+--- 2. Associated a schema url, relative , or absolute (to root of project, not to filesystem root) path to
+--- the a glob pattern relative to the detected project root. Check `:checkhealth vim.lsp` to determine the resolved project
+--- root.
+---
+--- ```lua
+--- vim.lsp.config('yamlls', {
+--- ...
+--- settings = {
+--- yaml = {
+--- ... -- other settings. note this overrides the lspconfig defaults.
+--- schemas = {
+--- ["https://json.schemastore.org/github-workflow.json"] = "/.github/workflows/*",
+--- ["../path/relative/to/file.yml"] = "/.github/workflows/*",
+--- ["/path/from/root/of/project"] = "/.github/workflows/*",
+--- },
+--- },
+--- }
+--- })
+--- ```
+---
+--- Currently, kubernetes is special-cased in yammls, see the following upstream issues:
+--- * [#211](https://github.com/redhat-developer/yaml-language-server/issues/211).
+--- * [#307](https://github.com/redhat-developer/yaml-language-server/issues/307).
+---
+--- To override a schema to use a specific k8s schema version (for example, to use 1.18):
+---
+--- ```lua
+--- vim.lsp.config('yamlls', {
+--- ...
+--- settings = {
+--- yaml = {
+--- ... -- other settings. note this overrides the lspconfig defaults.
+--- schemas = {
+--- ["https://raw.githubusercontent.com/yannh/kubernetes-json-schema/refs/heads/master/v1.32.1-standalone-strict/all.json"] = "/*.k8s.yaml",
+--- ... -- other schemas
+--- },
+--- },
+--- }
+--- })
+--- ```
+return {
+ cmd = { 'yaml-language-server', '--stdio' },
+ filetypes = { 'yaml', 'yaml.docker-compose', 'yaml.gitlab', 'yaml.helm-values' },
+ root_markers = { '.git' },
+ settings = {
+ -- https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting
+ redhat = { telemetry = { enabled = false } },
+ },
+}