luaut-language-server 1.0.1 → 1.1.1

package/README.md

@@ -17,16 +17,24 @@ luaut-language-server --stdio
 | request | notes |
 |---|---|
 | `publishDiagnostics` | syntax, scope (redeclare, assign-to-`const`) and type errors, on open and on every keystroke |
-| `hover` | the type as luaut writes it — the **narrowed** type at a reference, so a guarded `v` reads `string`, not `string \| nil` |
-| `definition` | the binding's declaration |
+| `hover` | the type as luaut writes it — the **narrowed** type at a reference, so a guarded `v` reads `string`, not `string \| nil`. Also every name in a type or definitions file: `declare` names (with their overload count), alias names, object-type properties, type parameters, `infer` names, and any type annotation, which reads as what it resolves to |
+| `semanticTokens` | colours from the parser, not from patterns — see [Highlighting](#highlighting) |
+| `definition` | the binding's declaration — and from an `import`, the export in the other module |
 | `references`, `documentHighlight` | every use of the binding |
 | `rename`, `prepareRename` | refuses names that are not identifiers, and builtins from the definitions files |
-| `completion` | members after `.` / `:`, names in scope, type names in a type position |
+| `completion` | members after `.` / `:` (never the globals there), names in scope, type names in a type position; inside an `import`, module paths and the exported names |
 | `signatureHelp` | every overload, with the active parameter — `:` calls count `self` for you |
 | `documentSymbol` | functions, type aliases, top-level bindings |
 
-Single file, for now: `import` resolves to `any`, so cross-file navigation is
-not there yet. See [Not yet](#not-yet).
+### Modules
+
+An `import` resolves to a file relative to the importer (`./x`, `../x`; the
+extension may be left off, and a folder means its `index.luaut`). That module
+is analyzed too, and its exports become the importer's types — so imported
+values are type-checked, imported types work in annotations, and a missing
+module or export is a diagnostic. Open documents are read before disk, so an
+import sees unsaved edits, and a cached result is dropped as soon as anything
+it imports changes.
 
 ## How it is put together
 
@@ -68,6 +76,21 @@ the `declare` statements in the definitions passed to `Analyzer`. Adding a
 global to a `.d.luaut` is all it takes for the editor to stop calling it
 undefined.
 
+### Highlighting
+
+A word's role in luaut depends on where it stands: `extends` is a keyword in a
+type and a name elsewhere, `type Foo = ...` declares an alias while `type(x)`
+calls a builtin, `typeof x` in a type is a query while `typeof(v)` in code is a
+call. A TextMate grammar only sees characters, so it can only guess — and
+guessed `extends (` into a function call.
+
+So `semanticTokens` classifies every token from the same lexer and AST the
+analyzer uses: declarations, parameters, properties, methods, types, type
+parameters, and soft keywords only where the AST did not claim the word as a
+name. The grammar in the editor extension keeps just what characters decide
+alone — comments, strings, numbers, reserved words — so a file looks right
+before the server answers, and never disagrees with it after.
+
 ## Not yet
 
 - **One file at a time.** No workspace indexing, so no cross-file
@@ -75,7 +98,7 @@ undefined.
   opened.
 - **No formatting** — there is no luaut printer yet (the compiler owns
   emitting Luau, and it emits *Luau*, not luaut).
-- No code actions, inlay hints, semantic tokens, or folding ranges.
+- No code actions, inlay hints, or folding ranges.
 - Everything `luaut-parser` does not check is invisible here too: unknown
   properties, writes to `readonly`, generic constraints at call sites,
   metatables.