Major clean up and improvements to vimwiki compatibility and documentation.

Reviewed-on: #1

crates/nuwiki-lsp/src/lib.rs

@@ -1,8 +1,7 @@
 //! LSP protocol bridge for nuwiki.
 //!
-//! `tower-lsp` server that maintains a `DocumentStore` (SPEC §6.10) plus a
-//! workspace-wide index (SPEC §6.10 + P8) and exposes every LSP method
-//! through Phase 8:
+//! `tower-lsp` server that maintains a `DocumentStore` plus a
+//! workspace-wide index and exposes every LSP method:
 //!
 //!   - `initialize` / `initialized` / `shutdown`
 //!   - `textDocument/didOpen`, `didChange` (full sync), `didClose`
@@ -14,12 +13,12 @@
 //!   - `workspace/symbol` — search across indexed headings
 //!
 //! Position encoding is negotiated as UTF-8 when the client supports LSP
-//! 3.17+ encodings (SPEC §6.11). When the client only supports the legacy
+//! 3.17+ encodings. When the client only supports the legacy
 //! UTF-16 default, positions get translated through a per-line lookup.
 //!
-//! Re-parses are full per change (incremental parsing deferred post-v1).
+//! Re-parses are full per change (no incremental parsing).
 //! The workspace scan runs in a background tokio task spawned from
-//! `initialize` (P8) with `window/workDoneProgress` begin/end events.
+//! `initialize` with `window/workDoneProgress` begin/end events.
 
 pub mod commands;
 pub mod config;
@@ -111,8 +110,8 @@ pub async fn run_stdio() -> io::Result<()> {
 struct DocumentState {
     text: String,
     ast: DocumentNode,
-    /// Last version we observed from the client. Held per SPEC §6.10 even
-    /// though the foundation phase doesn't yet need to read it back.
+    /// Last version we observed from the client. Held even
+    /// though nothing reads it back yet.
     #[allow(dead_code)]
     version: i32,
 }
@@ -124,8 +123,8 @@ struct Backend {
     /// True after `initialize` if the client opted into UTF-8 encoding.
     /// Otherwise we keep the LSP 3.16 default of UTF-16.
     use_utf8: Arc<AtomicBool>,
-    /// Per-wiki state (P11). Vector holds one entry until Phase 18
-    /// (multi-wiki) lets users add more.
+    /// Per-wiki state. Vector holds one entry until multi-wiki
+    /// support lets users add more.
     wikis: Arc<RwLock<Vec<Wiki>>>,
     /// Server config received via `initializationOptions` and refreshed
     /// via `workspace/didChangeConfiguration` (P18).
@@ -151,7 +150,7 @@ impl Backend {
         wikis.iter().find(|w| w.id == id).cloned()
     }
 
-    /// Used by Phase 15 workspace-level commands (`checkLinks`, `findOrphans`)
+    /// Used by workspace-level commands (`checkLinks`, `findOrphans`)
     /// when no URI is supplied — they fall back to the first registered wiki.
     fn default_wiki(&self) -> Option<Wiki> {
         let wikis = self.wikis.read().ok()?;
@@ -290,7 +289,7 @@ impl Backend {
 
     /// Return live state if `uri` is open in the editor, otherwise read
     /// the file from disk and re-parse. The closed-doc path is used by
-    /// cross-document operations (Phase 13 `workspace/rename` and link
+    /// cross-document operations (`workspace/rename` and link
     /// health) that need accurate spans + text without trusting cached
     /// `WorkspaceIndex` data.
     pub async fn read_or_open(&self, uri: &Url) -> io::Result<DocSnapshot> {
@@ -318,7 +317,7 @@ impl Backend {
     }
 
     async fn update_document(&self, uri: Url, text: String, version: i32) {
-        // For Phase 6 we always treat unknown buffers as vimwiki — if/when
+        // We always treat unknown buffers as vimwiki — if/when
         // multi-syntax dispatch lands the pick should follow the URI's ext.
         let plugin = match self.registry.get("vimwiki") {
             Some(p) => p,
@@ -373,7 +372,7 @@ impl Backend {
 #[tower_lsp::async_trait]
 impl LanguageServer for Backend {
     async fn initialize(&self, params: InitializeParams) -> LspResult<InitializeResult> {
-        // SPEC §6.11: prefer UTF-8 if the client advertises support.
+        // Prefer UTF-8 if the client advertises support.
         let supports_utf8 = params
             .capabilities
             .general
@@ -404,7 +403,7 @@ impl LanguageServer for Backend {
                         change: Some(TextDocumentSyncKind::FULL),
                         will_save: None,
                         will_save_wait_until: None,
-                        // Phase 17 `auto_export` listens on `did_save`. Asking
+                        // `auto_export` listens on `did_save`. Asking
                         // for `include_text: false` since the document store
                         // already mirrors the live buffer.
                         save: Some(TextDocumentSyncSaveOptions::SaveOptions(SaveOptions {
@@ -502,9 +501,9 @@ impl LanguageServer for Backend {
 
     async fn did_change_configuration(&self, params: DidChangeConfigurationParams) {
         // Apply the new settings to `Config`. Re-indexing on root changes
-        // is out of scope for Phase 11; for now we just accept the new
+        // is out of scope here; for now we just accept the new
         // values so later commands see the right diagnostic settings etc.
-        // Phase 18 (multi-wiki) revisits this with proper rebuild semantics.
+        // Multi-wiki support revisits this with proper rebuild semantics.
         let mut cfg = self.config.write().expect("config lock poisoned");
         cfg.apply_change(&params.settings);
     }
@@ -530,7 +529,7 @@ impl LanguageServer for Backend {
     }
 
     async fn did_rename_files(&self, params: RenameFilesParams) {
-        // Phase 13 advertises this capability so the editor pushes
+        // We advertise this capability so the editor pushes
         // out-of-band renames (file explorer drags, `:VimwikiRenameFile`
         // when the client opts to surface the new URI). Update the index
         // so backlinks/headings track the new URI without waiting for
@@ -576,7 +575,7 @@ impl LanguageServer for Backend {
     }
 
     async fn did_save(&self, params: DidSaveTextDocumentParams) {
-        // Phase 17: when `auto_export` is set on the resolved wiki, run
+        // When `auto_export` is set on the resolved wiki, run
         // the equivalent of `nuwiki.export.currentToHtml` after the file
         // hits disk. Best-effort — failures are logged but do not bubble
         // to the client. Skips pages with the `%nohtml` directive.
@@ -934,7 +933,7 @@ impl LanguageServer for Backend {
                         });
                     }
                 }
-                // Phase 12: surface tags too, named as `:tag:` so editors
+                // Surface tags too, named as `:tag:` so editors
                 // can distinguish them from headings at a glance.
                 for t in &page.tags {
                     if q.is_empty() || t.name.to_lowercase().contains(&q) {
@@ -1121,9 +1120,9 @@ fn utf16_column(text: &str, line: u32, byte_col: u32) -> u32 {
         .sum::<usize>() as u32
 }
 
-/// Backward-compat wrapper kept for v1.0 test surface. New call sites
+/// Backward-compat wrapper kept for the legacy test surface. New call sites
 /// should use `collect_diagnostics` so they can opt into link-health
-/// (Phase 15) and other sources.
+/// and other sources.
 pub fn ast_diagnostics(ast: &DocumentNode, text: &str, utf8: bool) -> Vec<Diagnostic> {
     collect_diagnostics(
         ast,
@@ -1136,12 +1135,12 @@ pub fn ast_diagnostics(ast: &DocumentNode, text: &str, utf8: bool) -> Vec<Diagno
     )
 }
 
-/// Composable diagnostic collector (P11 §12.2.4).
+/// Composable diagnostic collector.
 ///
 /// Sources, each gated by `cfg`:
 ///
 /// 1. Parse errors (always on).
-/// 2. Broken-link warnings (Phase 15) — emitted when an index, source
+/// 2. Broken-link warnings — emitted when an index, source
 ///    page name, and `link_severity != Off` are all available.
 pub fn collect_diagnostics(
     ast: &DocumentNode,
@@ -1317,8 +1316,8 @@ fn keyword_str(k: nuwiki_core::ast::Keyword) -> &'static str {
 
 // ===== Workspace + navigation helpers =====
 //
-// `workspace_root_from_params` lived here through Phase 10; Phase 11 lifted
-// that logic into `Config::from_init_params` (see `config.rs`) so workspace
+// `workspace_root_from_params` logic now lives in
+// `Config::from_init_params` (see `config.rs`) so workspace
 // folders and `root_uri` are handled alongside `initializationOptions`.
 
 /// Background workspace scan (P8). Walks every `.wiki` file under `root`,
@@ -1469,7 +1468,7 @@ fn heading_range_in(idx: &WorkspaceIndex, uri: &Url, anchor: &str, _utf8: bool)
     if let Some(h) = page.find_heading_by_anchor(anchor) {
         return Some(span_to_lsp_range_no_text(&h.span));
     }
-    // Phase 12: tags-as-anchors. `[[Page#tag-name]]` lands on the
+    // Tags-as-anchors. `[[Page#tag-name]]` lands on the
     // matching `TagNode` on the target page.
     let t = page.tags.iter().find(|t| t.name == anchor)?;
     Some(span_to_lsp_range_no_text(&t.span))