Problems while configuring the luau language

[mxruben]

I have encountered a couple big issues while trying to configure the Luau language for helix. The first one is that the syntax highlighting does not work at all. I've verified that the library is built and in the ~/.config/helix/runtime/grammars folder. I've tried multiple different grammars with no luck. Syntax highlighting works fine for every other language though. The other issue is that I cannot configure luau-lsp. The config gets sent according to the logs, but it has no effect. I was not able to find anything suspicious in the (verbose) logs for either issue. I'm hoping that I'm just doing something wrong.

OS: Fedora 40
Installation: dnf package (I've tried building from source and had the same issues)
Helix version: 24.3 (2cadec0)

languages.toml:

[[language]]
name = "luau"
scope = "source.luau"
injection-regex = "^luau$"
file-types = ["luau", "server.luau", "client.luau"]
comment-token = "--"
indent = { tab-width = 2, unit = "  "}
language-servers = ["luau-lsp"]
#roots = [ "aftman.toml", "default.project.json", "wally.toml" ]

[language-server.luau-lsp]
command = "luau-lsp"
args = ["lsp"]

[language-server.luau-lsp.config]
sourcemap = {enabled = false}
completion = {autocompleteEnd = true}
types = {roblox = false}

[[grammar]]
name = "luau"
source = {git = "https://github.com/tree-sitter-grammars/tree-sitter-luau", rev = "5aa9b88a8e3327276ec6e72de997f04ac80b1ae4"}
#source = { git = "https://github.com/polychromatist/tree-sitter-luau", rev = "34937d73e58bac6aede975c1e30745e74e19feb4"}

hx --health luau output:

  ✓ luau-lsp: /usr/local/bin/luau-lsp
Configured debug adapter: None
Configured formatter: None
Highlight queries: ✘
Textobject queries: ✘
Indent queries: ✘

log:

2024-06-20T14:38:43.010 helix_lsp::transport [ERROR] err: <- Other(failed to send a message to server

Caused by:
    channel closed)
2024-06-20T14:38:43.010 helix_lsp::transport [ERROR] luau-lsp err: <- StreamClosed
2024-06-20T14:38:51.367 helix_lsp::client [INFO] Using custom LSP config: {"completion":{"autocompleteEnd":true},"sourcemap":{"enabled":false},"types":{"roblox":false}}
2024-06-20T14:38:51.368 helix_lsp::transport [INFO] luau-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":{"tagSupport":{"valueSet":[1,2]},"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},"fileOperations":{"didRename":true,"willRename":true},"inlayHint":{"refreshSupport":false},"symbol":{"dynamicRegistration":false},"workspaceEdit":{"documentChanges":true,"failureHandling":"abort","normalizesLineEndings":false,"resourceOperations":["create","rename","delete"]},"workspaceFolders":true}},"clientInfo":{"name":"helix","version":"24.3 (2cadec0b)"},"initializationOptions":{"completion":{"autocompleteEnd":true},"sourcemap":{"enabled":false},"types":{"roblox":false}},"processId":34635,"rootPath":"/home/mxruben/Projects/luau-bit64","rootUri":"file:///home/mxruben/Projects/luau-bit64","workspaceFolders":[{"name":"luau-bit64","uri":"file:///home/mxruben/Projects/luau-bit64"}]},"id":0}
2024-06-20T14:38:51.369 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"No documentation file given. Documentation will not be provided","type":2}}
2024-06-20T14:38:51.369 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"negotiated position encoding: \"utf-8\"","type":3}}
2024-06-20T14:38:51.369 helix_lsp::transport [INFO] luau-lsp <- {"id":0,"jsonrpc":"2.0","result":{"capabilities":{"callHierarchyProvider":true,"codeActionProvider":{"codeActionKinds":["source.organizeImports"],"resolveProvider":false},"colorProvider":true,"completionProvider":{"completionItem":{"labelDetailsSupport":true},"resolveProvider":false,"triggerCharacters":[".",":","'","\"","/","\n"]},"declarationProvider":false,"definitionProvider":true,"diagnosticProvider":{"identifier":"luau","interFileDependencies":true,"workspaceDiagnostics":true},"documentLinkProvider":{"resolveProvider":false},"documentSymbolProvider":true,"foldingRangeProvider":true,"hoverProvider":true,"implementationProvider":false,"inlayHintProvider":true,"positionEncoding":"utf-8","referencesProvider":true,"renameProvider":true,"semanticTokensProvider":{"full":true,"legend":{"tokenModifiers":["declaration","definition","readonly","static","deprecated","abstract","async","modification","documentation","defaultLibrary"],"tokenTypes":["namespace","type","class","enum","interface","struct","typeParameter","parameter","variable","property","enumMember","event","function","method","macro","keyword","modifier","comment","string","number","regexp","operator","decorator"]},"range":false},"signatureHelpProvider":{"triggerCharacters":["(",","]},"textDocumentSync":2,"typeDefinitionProvider":true,"workspace":{"workspaceFolders":{"changeNotifications":false,"supported":true}},"workspaceSymbolProvider":true}}}
2024-06-20T14:38:51.369 helix_lsp::transport [INFO] luau-lsp <- {"capabilities":{"callHierarchyProvider":true,"codeActionProvider":{"codeActionKinds":["source.organizeImports"],"resolveProvider":false},"colorProvider":true,"completionProvider":{"completionItem":{"labelDetailsSupport":true},"resolveProvider":false,"triggerCharacters":[".",":","'","\"","/","\n"]},"declarationProvider":false,"definitionProvider":true,"diagnosticProvider":{"identifier":"luau","interFileDependencies":true,"workspaceDiagnostics":true},"documentLinkProvider":{"resolveProvider":false},"documentSymbolProvider":true,"foldingRangeProvider":true,"hoverProvider":true,"implementationProvider":false,"inlayHintProvider":true,"positionEncoding":"utf-8","referencesProvider":true,"renameProvider":true,"semanticTokensProvider":{"full":true,"legend":{"tokenModifiers":["declaration","definition","readonly","static","deprecated","abstract","async","modification","documentation","defaultLibrary"],"tokenTypes":["namespace","type","class","enum","interface","struct","typeParameter","parameter","variable","property","enumMember","event","function","method","macro","keyword","modifier","comment","string","number","regexp","operator","decorator"]},"range":false},"signatureHelpProvider":{"triggerCharacters":["(",","]},"textDocumentSync":2,"typeDefinitionProvider":true,"workspace":{"workspaceFolders":{"changeNotifications":false,"supported":true}},"workspaceSymbolProvider":true}}
2024-06-20T14:38:51.369 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","method":"initialized","params":{}}
2024-06-20T14:38:51.370 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"server initialized!","type":3}}
2024-06-20T14:38:51.370 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"trace level: \"off\"","type":3}}
2024-06-20T14:38:51.370 helix_lsp::transport [INFO] luau-lsp <- {"id":0,"jsonrpc":"2.0","method":"workspace/configuration","params":{"items":[{"section":"luau-lsp"},{"scopeUri":"file:///home/mxruben/Projects/luau-bit64","section":"luau-lsp"}]}}
2024-06-20T14:38:51.370 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"registering didChangedWatchedFiles capability","type":3}}
2024-06-20T14:38:51.370 helix_lsp::transport [INFO] luau-lsp <- {"id":1,"jsonrpc":"2.0","method":"client/registerCapability","params":{"registrations":[{"id":"didChangedWatchedFilesCapability","method":"workspace/didChangeWatchedFiles","registerOptions":{"watchers":[{"globPattern":"**/.luaurc","kind":7},{"globPattern":"**/sourcemap.json","kind":7},{"globPattern":"**/*.{lua,luau}","kind":7}]}}]}}
2024-06-20T14:38:51.372 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"No definitions file provided by client","type":2}}
2024-06-20T14:38:51.375 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"No definitions file provided by client","type":2}}
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Warning, message: "No documentation file given. Documentation will not be provided" }
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "negotiated position encoding: \"utf-8\"" }
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "server initialized!" }
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "trace level: \"off\"" }
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"completion":{"autocompleteEnd":true},"sourcemap":{"enabled":false},"types":{"roblox":false}}}}
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "registering didChangedWatchedFiles capability" }
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"luau","text":"--[[\n    Luau bit manipulation for 64-bit numbers.\n    Adapted for luau from the lua-bit64 library by ManuelBlanc.\n\n    Copyright 2024 Maxwell Ruben\n    Copyright 2019 ManuelBlanc\n    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n--]]\n\n--!strict\n--!native\n\n--- Joins the bits of two 32-bit integers into one 64-bit integer.\nlocal function join(high: number, low: number): number\n    return high * 0x100000000 + low % 0x100000000\nend\n\n--- Splits a 64-bit integer into two 32-bit integers.\nlocal function split(n: number): (number, number)\n    return n // 0x100000000, n % 0x100000000\nend\n\n--- Returns the least significant bits.\nlocal function low(n: number): number\n    return n % 0x100000000\nend\n\n--- Returns the most significant bits.\nlocal function high(n: number): number\n    return n // 0x100000000\nend\n\nlocal function bop(op: (...number) -> number, n1: number, n2: number, ...: number): number\n    -- Makes the function returns consistent with bit32\n    if not n2 then\n        if not n1 then\n            return join(op(), op())\n        end\n        return n1\n    end\n\n    local h2, l2 = split(n2)\n    local h1, l1 = split(n1)\n    local high, low = op(h1, h2), op(l1, l2)\n    for i = 1, select('#', ...) do\n        local h, l = split(select(i, ...))\n        high = op(high, h)\n        low = op(low, l)\n    end\n    return join(high, low)\nend\n\nlocal function band(...: number): number\n    return bop(bit32.band, ...)\nend\n\nlocal function bor(...: number): number\n    return bop(bit32.bor, ...)\nend\n\nlocal function bxor(...: number): number\n    return bop(bit32.bxor, ...)\nend\n\n--- Perform a bitwise and of all input numbers, and return true if the result is\n--- not 0. If the function is called with no arguments, true is returned.\nlocal function btest(...: number): boolean\n    return band(...) ~= 0\nend\n\nlocal function bnot(n: number): number\n    local high, low = split(n)\n    return join(bit32.bnot(high), bit32.bnot(low))\nend\n\nlocal function lshift(n: number, i: number): number\n    if bit32.band(i, 63) == 0 then\n        return n\n    end\n    local high, low = split(n)\n    if bit32.band(i, 32) == 0 then\n        low, high = bit32.lshift(low, i), bit32.bor(bit32.lshift(high, i), bit32.rshift(low, 32 - i))\n    else\n        high = bit32.lshift(low, (i - 32))\n        low = 0\n    end\n    return join(high, low)\nend\n\nlocal function rshift(n: number, i: number): number\n    if bit32.band(i, 63) == 0 then\n        return n\n    end\n    local high, low = split(n)\n    if bit32.band(i, 32) == 0 then\n        low, high = bit32.bor(bit32.rshift(low, i), bit32.lshift(high, 32 - i)), bit32.rshift(high, i)\n    else\n        low, high = bit32.rshift(high, i - 32), 0\n    end\n    return join(high, low)\nend\n\nlocal function arshift(n: number, i: number): number\n    if bit32.band(i, 63) == 0 then\n        return n\n    end\n    local high, low = split(n)\n    if bit32.band(i, 32) == 0 then\n        low, high = bit32.bor(bit32.rshift(low, i), bit32.lshift(high, 32 - i)), bit32.arshift(high, i)\n    else\n        low, high = bit32.arshift(high, i - 32), bit32.arshift(high, 31)\n    end\n    return join(high, low)\nend\n\n-- local function lrotate(n: number, i: number): number\n--     if bit32.band(i, 63) == 0 then\n--         return n\n--     end\n--     local high, low = split(n)\n--     if bit32.band(i, 32) ~= 0 then\n--         low, high = high, low\n--     end\n--     if bit32.band(i, 31) ~= 0 then\n--         low, high = bit32.bor(bit32.lshift(low, i), bit32.rshift(high, 32 - i)), bit32.bor(bit32.lshift(high, i), bit32.rshift(low, 32 - i))\n--     end\n--     return join(high, low)\n-- end\n\nlocal function lrotate(n: number, i: number): number\n    return bor(lshift(n, i), rshift(n, 64 - i))\nend\n\nlocal function rrotate(n: number, i: number): number\n    return lrotate(n, 64 - i)\nend\n\nlocal bit64 = {\n    join = join,\n    split = split,\n    low = low,\n    high = high,\n    band = band,\n    bor = bor,\n    bxor = bxor,\n    bnot = bnot,\n    lshift = lshift,\n    rshift = rshift,\n    arshift = arshift,\n    lrotate = lrotate,\n    rrotate = rrotate,\n    btest = btest,\n}\n\nreturn bit64\n","uri":"file:///home/mxruben/Projects/luau-bit64/bit64.luau","version":0}}}
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Warning, message: "No definitions file provided by client" }
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","result":[null,null],"id":0}
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","result":null,"id":1}
2024-06-20T14:38:51.378 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Warning, message: "No definitions file provided by client" }
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp <- {"id":2,"jsonrpc":"2.0","method":"workspace/configuration","params":{"items":[{"section":"luau-lsp"},{"scopeUri":"file:///home/mxruben/Projects/luau-bit64","section":"luau-lsp"}]}}
2024-06-20T14:38:51.378 helix_lsp::transport [INFO] luau-lsp -> {"jsonrpc":"2.0","result":[null,null],"id":2}
2024-06-20T14:38:51.379 helix_lsp::transport [INFO] luau-lsp <- {"error":{"code":-32802,"data":{"retriggerRequest":true},"message":"server not yet received configuration for diagnostics"},"id":null,"jsonrpc":"2.0"}
2024-06-20T14:38:51.379 helix_lsp::transport [ERROR] luau-lsp <- ServerError(-32802): server not yet received configuration for diagnostics
2024-06-20T14:38:51.379 helix_lsp::transport [ERROR] Discarding Language Server response without a request (id=Null) Err(Rpc(Error { code: ServerError(-32802), message: "server not yet received configuration for diagnostics", data: Some(Object {"retriggerRequest": Bool(true)}) }))
2024-06-20T14:38:51.379 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"loaded configuration for ","type":3}}
2024-06-20T14:38:51.379 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"loaded configuration for file:///home/mxruben/Projects/luau-bit64","type":3}}
2024-06-20T14:38:51.379 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "loaded configuration for " }
2024-06-20T14:38:51.379 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/showMessage","params":{"message":"Failed to load sourcemap.json for workspace 'luau-bit64'. Instance information will not be available","type":1}}
2024-06-20T14:38:51.379 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "loaded configuration for file:///home/mxruben/Projects/luau-bit64" }
2024-06-20T14:38:51.379 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "Failed to load sourcemap.json for workspace 'luau-bit64'. Instance information will not be available" }
2024-06-20T14:38:51.380 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"diagnostics":[],"uri":"file:///home/mxruben/Projects/luau-bit64/bit64.luau","version":0}}
2024-06-20T14:38:51.381 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"loaded configuration for ","type":3}}
2024-06-20T14:38:51.381 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/logMessage","params":{"message":"loaded configuration for file:///home/mxruben/Projects/luau-bit64","type":3}}
2024-06-20T14:38:51.381 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"window/showMessage","params":{"message":"Failed to load sourcemap.json for workspace 'luau-bit64'. Instance information will not be available","type":1}}
2024-06-20T14:38:51.381 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "loaded configuration for " }
2024-06-20T14:38:51.381 helix_term::application [INFO] window/logMessage: LogMessageParams { typ: Info, message: "loaded configuration for file:///home/mxruben/Projects/luau-bit64" }
2024-06-20T14:38:51.381 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "Failed to load sourcemap.json for workspace 'luau-bit64'. Instance information will not be available" }
2024-06-20T14:38:51.381 helix_lsp::transport [INFO] luau-lsp <- {"jsonrpc":"2.0","method":"textDocument/publishDiagnostics","params":{"diagnostics":[],"uri":"file:///home/mxruben/Projects/luau-bit64/bit64.luau","version":0}}

[kirawi]

You haven't added highlight queries. See https://docs.helix-editor.com/guides/adding_languages.html#queries

[mxruben]

I'm sorry, how would I go about doing that? Shouldn't they be compiled into the grammar? Both luau grammar repos I tried have a highlights.scm file.

[kirawi]

You have to copy them over

[mxruben]

Oh I see, not sure how I missed that. Thank you. Now I just gotta figure out why my lsp config isn't working.

[CompeyDev]

Any luck getting your LSP config working? I passed a --settings argument to luau-lsp and luau-lsp launches without an error, but relative requires don't seem to work.

[Jamtoad]

Were either of you able to get the config working? I have spent the past week or so attempting probably over 20 different things. However, nothing seems to work. Its almost like Helix launches the LSP barebones without any config.

I ended up writing a batch file to start up Rojo and then also start up source map watching. Then I configured Helix to run :lsp_restart for Luau files every time its saves. This seemed to do the trick, but I still don't have Roblox types!