Yaml grammar not applied to derivative language

[Ultra-Code]

Summary

Adding grammar = "yaml" or defining the [[grammar]] under the language doesn't cause the grammer to be applied to the language type

Reproduction Steps

I tried this:

[[language]]
name = "docker-compose"
scope = "source.yaml.docker-compose"
file-types = ["docker-compose.yaml", "docker-compose.yml"]
comment-token = "#"
indent = { tab-width = 2, unit = "  " }
roots = ["docker-compose.yaml", "docker-compose.yml"]
language-servers = [ "docker-compose-lsp" ]
grammar = "yaml"

[language-server.docker-compose-lsp]
command = "docker-compose-langserver"
args = ["--stdio"]

I expected the yaml syntax highlighing with the docker-compose name (note here name is yaml):

Instead, this happened:

Helix log

~/.cache/helix/helix.log

A copy of `~/.cache/helix/helix.log`

2024-02-04T02:05:57.223 helix_lsp::transport [INFO] docker-compose-lsp -> {"jsonrpc":"2.0","method":"shutdown","id":1}
2024-02-04T02:05:57.227 helix_lsp::transport [INFO] docker-compose-lsp <- {"jsonrpc":"2.0","id":1,"result":null}
2024-02-04T02:05:57.227 helix_lsp::transport [INFO] docker-compose-lsp <- null
2024-02-04T02:05:57.227 helix_lsp::transport [INFO] docker-compose-lsp -> {"jsonrpc":"2.0","method":"exit"}
2024-02-04T02:05:58.373 helix_lsp::transport [INFO] docker-compose-lsp -> {"jsonrpc":"2.0","method":"initialize","params":{"capabilities":{"general":{"positionEncodings":["utf-8","utf-32","utf-16"]},"textDocument":{"codeAction":{"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["","quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}},"dataSupport":true,"disabledSupport":true,"isPreferredSupport":true,"resolveSupport":{"properties":["edit","command"]}},"completion":{"completionItem":{"deprecatedSupport":true,"insertReplaceSupport":true,"resolveSupport":{"properties":["documentation","detail","additionalTextEdits"]},"snippetSupport":true,"tagSupport":{"valueSet":[1]}},"completionItemKind":{}},"hover":{"contentFormat":["markdown"]},"inlayHint":{"dynamicRegistration":false},"publishDiagnostics":{"versionSupport":true},"rename":{"dynamicRegistration":false,"honorsChangeAnnotations":false,"prepareSupport":true},"signatureHelp":{"signatureInformation":{"activeParameterSupport":true,"documentationFormat":["markdown"],"parameterInformation":{"labelOffsetSupport":true}}}},"window":{"workDoneProgress":true},"workspace":{"applyEdit":true,"configuration":true,"didChangeConfiguration":{"dynamicRegistration":false},"didChangeWatchedFiles":{"dynamicRegistration":true,"relativePatternSupport":false},"executeCommand":{"dynamicRegistration":false},"inlayHint":{"refreshSupport":false},"symbol":{"dynamicRegistration":false},"workspaceEdit":{"documentChanges":true,"failureHandling":"abort","normalizesLineEndings":false,"resourceOperations":["create","rename","delete"]},"workspaceFolders":true}},"clientInfo":{"name":"helix","version":"23.10"},"processId":75672,"rootPath":"/firefox/home/files/repos/php/php_playground/docker","rootUri":"file:///firefox/home/files/repos/php/php_playground/docker","workspaceFolders":[{"name":"docker","uri":"file:///firefox/home/files/repos/php/php_playground/docker"}]},"id":0}
2024-02-04T02:05:58.511 helix_lsp::transport [INFO] docker-compose-lsp <- {"jsonrpc":"2.0","id":0,"result":{"capabilities":{"textDocumentSync":{"openClose":true,"change":2,"willSave":false,"willSaveWaitUntil":false,"save":false},"completionProvider":{"triggerCharacters":["-",":"," ","\""],"resolveProvider":false},"hoverProvider":true,"documentLinkProvider":{"resolveProvider":false},"documentFormattingProvider":true,"workspace":{"workspaceFolders":{"supported":true}}},"serverInfo":{"name":"Docker Compose Language Server"}}}
2024-02-04T02:05:58.511 helix_lsp::transport [INFO] docker-compose-lsp <- {"capabilities":{"completionProvider":{"resolveProvider":false,"triggerCharacters":["-",":"," ","\""]},"documentFormattingProvider":true,"documentLinkProvider":{"resolveProvider":false},"hoverProvider":true,"textDocumentSync":{"change":2,"openClose":true,"save":false,"willSave":false,"willSaveWaitUntil":false},"workspace":{"workspaceFolders":{"supported":true}}},"serverInfo":{"name":"Docker Compose Language Server"}}
2024-02-04T02:05:58.512 helix_lsp::transport [INFO] docker-compose-lsp -> {"jsonrpc":"2.0","method":"initialized","params":{}}
2024-02-04T02:05:58.512 helix_lsp::transport [INFO] docker-compose-lsp -> {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"yaml","text":"services:\n  app:\n    build:\n      context: ./\n      dockerfile: Dockerfile\n    container_name: programwithgio-app\n    restart: always\n    working_dir: /var/www/\n    volumes:\n      - ../src:/var/www\n  nginx:\n    image: nginx:1.25.3-alpine\n    container_name: programwithgio-nginx\n    restart: always\n    ports:\n      - 8000:80\n    volumes:\n      - ../src:/var/www\n      - ./nginx:/etc/nginx/conf.d\n","uri":"file:///firefox/home/files/repos/php/php_playground/docker/docker-compose.yml","version":0}}}
2024-02-04T02:05:59.552 helix_lsp::transport [INFO] docker-compose-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"uri":"file:///firefox/home/files/repos/php/php_playground/docker/docker-compose.yml","diagnostics":[]}}

Platform

ArchLinux

Terminal Emulator

kitty 0.31.0

Installation Method

pacman extra repository

Helix Version

helix 23.10

[the-mikedavis]

You can re-use the tree-sitter parser with grammar = "<existing grammar>" but you also need to define queries for the new language under runtime/queries/docker-compose/. You can re-use the queries from yaml by using ; inherits: yaml. For example see racket's queries https://github.com/helix-editor/helix/blob/master/runtime/queries/racket/highlights.scm

[Ultra-Code]

Thanks @the-mikedavis that works.

[AlexNomadrg]

Hey, I can't find docker-compose-langserver binary anywhere. Is it just a placeholder or is there a package that provides it?

[AlexNomadrg]

I found this repo but I can't install it properly. I've tried npm install -g @microsoft/compose-language-service it installed but there's still no docker-compose-langserver binary

[AlexNomadrg]

I figured it out. Installed it with npm install @microsoft/compose-language-service then the binary could be found at ~/node_modules/@microsoft/compose-language-service/bin/docker-compose-langserver