Luau LSP

A luau-lsp extension to improve your experience in neovim.

demo.mp4

Installation

lazy.nvim

{
  "lopi-py/luau-lsp.nvim",
  ft = { "luau" }
  opts = {
    ...
  },
  dependencies = {
    "nvim-lua/plenary.nvim",
  }
}

Packer

use {
  "lopi-py/luau-lsp.nvim",
  ft = { "luau" },
  config = function()
    require("luau-lsp").setup {
      ...
    }
  end,
  requires = {
    "nvim-lua/plenary.nvim",
  },
}

Setup

Caution

Calling lspconfig's setup may result in problems where the server is not properly set up

require("lspconfig").luau_lsp.setup { ... }

Use luau-lsp.nvim's setup instead

require("luau-lsp").setup { ... }

mason-lspconfig.nvim

require("mason-lspconfig").setup_handlers {
  luau_lsp = function()
    require("luau-lsp").setup {
      ...
    }
  end,
}

Roblox

Roblox types and sourcemap generation are supported:

require("luau-lsp").setup {
  sourcemap = {
    enable = true,
    autogenerate = true, -- automatic generation when the server is attached
    rojo_project_file = "default.project.json"
  },
  types = {
    roblox = true,
    roblox_security_level = "PluginSecurity",
  },
}

:LuauRegenerateSourcemap is provided to start sourcemap generation with the project file passed as argument or the one configured in sourcemap.rojo_project_file, will stop the current job and start a new one if required.

Definition files

require("luau-lsp").setup {
  types = {
    definition_files = { "path/to/definitions/file" },
    documentation_files = { "path/to/documentation/file" },
  },
}

Luau FFLags

require("luau-lsp").setup {
  fflags = {
    sync = true, -- sync currently enabled fflags with roblox's published fflags
    override = {
      LuauTarjanChildLimit = 0,
    },
  },
}

Bytecode generation

:LuauBytecode and :LuauCompilerRemarks open a new window and show the current Luau file bytecode and compiler remarks. It will automatically update if you change the file or edit it. Close with q.

bytecode.mp4

Server settings

require("luau-lsp").setup {
  server = {
    settings = {
      -- https://github.com/folke/neoconf.nvim/blob/main/schemas/luau_lsp.json
      ["luau-lsp"] = {
        completion = {
          imports = {
            enabled = true, -- enable auto imports
          },
        },
      },
    },
  },
}

Treesitter

Note that nvim-treesitter has its own luau parser but causes some conflicts, so you can opt in for the custom parser:

require("luau-lsp").treesitter() -- optional

-- treesitter configs here
require("nvim-treesitter.configs").setup {
  ...
}

:TSInstall luau

It is important that you call require("luau-lsp").treesitter() BEFORE your actual treesitter config, you need to reinstall the parser every time you switch between luau parsers. If you want to only use the default parser, just ignore this step.

Project configuration

It is allowed to config a project with :h 'exrc'

vim.o.exrc = true

-- .nvim.lua
require("luau-lsp").config {
  ...
}

Configuration

luau-lsp.nvim comes with the following defaults:

---@class LuauLspConfig
local defaults = {
  sourcemap = {
    enabled = true,
    autogenerate = true,
    rojo_path = "rojo",
    rojo_project_file = "default.project.json",
    include_non_scripts = true,
  },
  types = {
    ---@type string[]
    definition_files = {},
    ---@type string[]
    documentation_files = {},
    roblox = true,
    roblox_security_level = "PluginSecurity",
  },
  fflags = {
    enable_by_default = false,
    sync = true,
    ---@type table<string, "True"|"False"|number>
    override = {},
  },
  ---@type table<string, any>
  server = {
    cmd = { "luau-lsp", "lsp" },
    root_dir = function(path)
      local util = require "luau-lsp.util"
      return vim.fs.dirname(vim.fs.find(function(name)
        return name:match ".*%.project.json$"
          or util.list_contains({
            ".git",
            ".luaurc",
            ".stylua.toml",
            "stylua.toml",
            "selene.toml",
            "selene.yml",
          }, name)
      end, {
        upward = true,
        path = path,
      })[1])
    end,
    -- see https://github.com/folke/neoconf.nvim/blob/main/schemas/luau_lsp.json
    settings = {},
  },
}