Quickstart

Status: live. The analysis API below is the real, shipped gdscript-ide surface (see plans/ROADMAP.md for what's still ahead on the road to 1.0).

The library is built around two types modeled on rust-analyzer:

• AnalysisHost — the single mutable owner of analysis state, one per project. Its only mutation entry point is apply_change.
• Analysis — a cheap, cloneable, immutable snapshot you run read queries against. Every query is cancellable: a newer change cancels in-flight reads.

All inputs are a FileId plus byte offsets; all results are POD structs (serde-serializable), with no lsp-types in the core. The client converts byte offsets to UTF-16 and codes to its protocol.

Analyze a single .gd string

// (marked `ignore` only because `mdbook test` can't resolve the external
// `gdscript-ide` crate from a bare fenced block — the code itself is real.)
use gdscript_ide::{AnalysisHost, Change, FileId};

fn main() {
    // 1. Create a host and push a file's contents through a Change.
    //    The library never reads the filesystem itself — text is injected.
    let mut host = AnalysisHost::new();
    let file = FileId(0);

    let source = r#"
extends Node

func _ready() -> void:
    var n := 1 + 1
    print(n)
"#;

    let mut change = Change::new();
    change.change_file(file, source);
    host.apply_change(change);

    // 2. Take an immutable snapshot and run read queries.
    let analysis = host.analysis();

    // Parse + type diagnostics for the file (POD; byte offsets).
    let diagnostics = analysis.diagnostics(file).unwrap();
    for d in &diagnostics {
        println!("{:?} @ {:?}: {}", d.severity, d.range, d.message);
    }

    // Document symbols (outline) for the file.
    let symbols = analysis.document_symbols(file).unwrap();
    println!("{} top-level symbols", symbols.len());
}

The same Analysis snapshot exposes completions, hover, goto_definition, find_references, rename, signature_help, semantic_tokens, inlay_hints, and more — one method per IDE feature, each returning POD. See Consuming from Rust for the full surface, and plans/01-ARCHITECTURE.md §2 for the authoritative API sketch.

What works today

Everything above is live: parse + type diagnostics, type-aware hover and completion, the full LSP-grade query surface (signature help, folding, inlay hints, code actions, semantic tokens), scene-aware node-path typing, and a gdformat-compatible formatter. See the Roadmap for what's still ahead on the road to 1.0.