craft-ls

Get on

craft-ls is a Language Server Protocol implementation for *craft¹ tools.

craft-ls enables editors that support the LSP to get quality of life improvements while working on *craft configuration files.

Features

Feature	Snapcraft	Rockcraft	Charmcraft1
Diagnostics	✅	✅	✅
Documentation on hover	✅	✅	✅
Symbols	✅	✅	✅
Autocompletion	✅	✅	✅

demo.mov

Usage

Installation

Using the snap

sudo snap install craft-ls --edge

Using a Nix flake

nix run github:Batalex/craft-ls

Using a Python environment

Using uv

uv tool install craft-ls

Using pipx

pipx install craft-ls

Setup

Helix

# languages.toml
[[language]]
name = "yaml"
language-servers = ["craft-ls"]

[language-server.craft-ls]
command = "craft-ls"

Visual Studio Code

The Visual Studio Code extension can be installed right from the editor. It requires a local craft-ls installation (see previous section). If not automatically picked, you may configure it using the following key:

{
  "craft-ls.serverPath": "/home/user/.local/bin/craft-ls"
}

Neovim

Add the following to your Neovim configuration (e.g., ~/.config/nvim/init.lua or a plugin file):

vim.lsp.config("craft_ls", {
  cmd = { "craft-ls" },
  filetypes = { "yaml" },
  root_markers = {
    "snapcraft.yaml",
    "rockcraft.yaml",
    "charmcraft.yaml",
    "snap",
    ".git",
  },
})
vim.lsp.enable("craft_ls")

Footnotes

1. snapcraft, rockcraft and partial support for charmcraft (all-in-one charmcraft.yaml only) ↩ ↩²