Skip to content

Commit b39c878

Browse files
committed
Update the readme
1 parent 78a4626 commit b39c878

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,19 @@ Install the extension from the VSCode Marketplace or OpenVSX Registry:
1010
- OpenVSX Registry: https://open-vsx.org/extension/JohnnyMorganz/luau-lsp
1111

1212
Alternatively, check out [Getting Started for Language Server Clients](https://github.com/JohnnyMorganz/luau-lsp/blob/main/editors/README.md)
13-
to setup your own client for a different editor
13+
to setup your own client for a different editor.
14+
15+
A [Nightly Release](https://github.com/JohnnyMorganz/luau-lsp/actions/workflows/nightly.yml) runs every day with the latest changes on main.
16+
You can download the relevant release for your platform and manually install the `.vsix`.
17+
For debugging, the nightly release builds with debug symbols and profiling instrumentation.
1418

1519
### For General Users
1620

17-
The language server should be immediately usable for general Luau code after installation.
18-
String require support is provided for module paths, using `require("module")`.
21+
The language server will start working immediately for general Luau code. There is built-in support
22+
for Luau's generalised [require-by-string semantics](https://rfcs.luau.org/new-require-by-string-semantics.html), using `require("./module")`.
1923

20-
Type definitions can be provided by configuring `luau-lsp.types.definitionFiles`, with corresponding
21-
documentation added using `luau-lsp.types.documentationFiles`.
24+
To provide global type definitions for a custom environment, specify `luau-lsp.types.definitionFiles`.
25+
Corresponding documentation is configured using `luau-lsp.types.documentationFiles`.
2226

2327
If you use Luau in a different environment and are interested in using the language server, or
2428
looking for any specific features, please get in touch!
@@ -42,7 +46,8 @@ The following settings are configurable for sourcemap generation:
4246
- `luau-lsp.sourcemap.sourcemapFile`: What sourcemap file to use (default: `sourcemap.json`)
4347

4448
If you do not use Rojo, you can still use the Luau Language Server, you just need to manually generate a `sourcemap.json`
45-
file for your particular project layout.
49+
file for your particular project layout. You can configure `luau-lsp.sourcemap.generatorCommand` to run a custom generator.
50+
If your generator does not support file watching, enable `luau-lsp.sourcemap.useVSCodeWatcher`.
4651

4752
> Note: in the diagnostics type checker, the types for DataModel (DM) instances will resolve to `any`. This is a current limitation to reduce false positives.
4853
> However, autocomplete and hover intellisense will correctly resolve the DM type.
@@ -58,6 +63,13 @@ The entry point for the analysis tool is `luau-lsp analyze`.
5863

5964
Install the binary and run `luau-lsp --help` for more information.
6065

66+
## Configuration
67+
68+
There are 2 types of configuration styles for the language server. General configuration is provided by `.luaurc` files,
69+
which allow you to configure language strictness, lints, and require aliases. More information is available in Luau's [RFC documentation](https://rfcs.luau.org/config-luaurc.html).
70+
71+
The second configuration style is specific to the language server. See `luau-lsp` in your editor's settings for more details.
72+
6173
## Supported Features
6274

6375
- [x] Diagnostics (incl. type errors)

0 commit comments

Comments
 (0)