Skip to content

Editor Setup

Lune prioritizes developer experience, providing type definitions and documentation for many editors and tools without any additional downloads.

Run this command to configure your project for editor support:

Terminal
lune --init

This creates:

  • .luaurc - Luau LSP configuration with path aliases
  • lune.config.json - Lune project configuration
  • lune_packages/ - Directory for installed packages

The Luau Language Server (luau-lsp) provides excellent editor support including:

  • Autocomplete for all @lune/* modules
  • Type checking with full type definitions
  • Hover documentation for functions and types
  • Go to definition support
  1. Install the Luau LSP extension
  2. Run lune --init in your project
  3. Restart VS Code

Add to your LSP config:

require('lspconfig').luau_lsp.setup({
-- Configuration here
})

Any editor supporting the Language Server Protocol can use luau-lsp. Check your editor’s documentation for LSP setup.

If autocomplete isn’t working:

  1. Make sure you ran lune --init
  2. Check that .luaurc exists in your project root
  3. Restart your editor/language server

Command Line Usage | Next: Security