gffranco
106268d488
The Phase 11 plumbing already landed the data structures (`Wiki`
aggregate, per-wiki `WorkspaceIndex`, `wikis = [...]` config shape
with v1.0 desugaring). Phase 18 closes the user-visible gap: cross-
wiki link resolution + the picker command surface.
Cross-wiki resolution:
- `Backend::wikis_snapshot` — clone the Vec under the read lock
so commands can drop it before awaiting.
- `Backend::wiki_by_index` / `wiki_by_name` — pair with the
parser's `wiki<N>:` / `wn.<Name>:` interwiki shapes.
- `Backend::resolve_target_uri(target, source_uri)` — single entry
point for cross-wiki page lookup:
- `Wiki` / `AnchorOnly` → source wiki's index (Phase 8
behaviour preserved).
- `Interwiki` → routes to the wiki referenced by
`wiki_index` / `wiki_name`, then resolves the page in that
wiki's `pages_by_name`. Returns `None` when no wiki matches
or the page isn't indexed.
- `Backend::heading_range_for(target_uri, anchor)` — anchor lookup
on the target wiki's index. Phase 8's `goto_definition` was
computing this against the *source* wiki's index, which broke for
interwiki anchors; both `goto_definition` and `hover` are
refactored onto the new pair.
Commands:
- `nuwiki.wiki.listAll` — returns `[{ id, name, root, syntax,
file_extension }]`. Drives the picker UI.
- `nuwiki.wiki.select` — alias of `listAll` per SPEC §12.9
(selection is client-side; the server just exposes the list).
- `nuwiki.wiki.openIndex` — args `{ wiki? }` accepting an index id
(number), name (string), or numeric string. Returns
`{ uri, name, tab: false }` for `<root>/index<file_extension>`.
- `nuwiki.wiki.tabOpenIndex` — same payload but `tab: true` so
the client knows to open in a new tab/split.
- `nuwiki.wiki.gotoPage` — args `{ page, wiki? }`. Prefers an
indexed URI when the page is already known; otherwise builds
`<root>/<page><file_extension>` directly. Drives the
`:VimwikiGoto {name}` compat command.
Tests: 12 new in `phase18_multi_wiki.rs` covering parser shapes for
`wiki<N>:` / `wn.<Name>:` (and that plain `[[Home]]` stays
`LinkKind::Wiki`), multi-wiki config loading + v1.0 single-root
desugaring, `WikiId` sequential assignment, longest-prefix URI
routing for nested roots, the cross-wiki resolution semantics
(target wiki's index wins when both wikis define the same page
name), missing-wiki fallback, the COMMANDS list completeness, and a
link-kind matrix covering all nine kinds. Total 369 tests pass;
fmt + clippy clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
85 lines
2.7 KiB
Markdown
85 lines
2.7 KiB
Markdown
# nuwiki
|
||
|
||
A Vim/Neovim plugin providing full vimwiki syntax support, implemented as a
|
||
Rust-based language server (LSP).
|
||
|
||
> **Status:** v1.0 (Phases 0–10) shipped — parsing, highlighting, navigation,
|
||
> editor glue, and release pipeline are all live. v1.1 (Phases 11–19) in
|
||
> progress, closing the gap to a full vimwiki replacement: tags, diary,
|
||
> server-side edit commands, link health, HTML export commands, multi-wiki,
|
||
> and the `:Vimwiki*` keymap layer.
|
||
|
||
See [`SPEC.md`](./SPEC.md) for the full project specification.
|
||
|
||
## Implementation status
|
||
|
||
### v1.0 — foundation
|
||
|
||
| Phase | Name | Status |
|
||
|---|---|---|
|
||
| 0 | Scaffolding | ✅ done |
|
||
| 1 | Core AST | ✅ done |
|
||
| 2 | Syntax Plugin Interface | ✅ done |
|
||
| 3 | Vimwiki Lexer | ✅ done |
|
||
| 4 | Vimwiki Parser | ✅ done |
|
||
| 5 | Renderer | ✅ done |
|
||
| 6 | LSP Foundation | ✅ done |
|
||
| 7 | Semantic Tokens | ✅ done |
|
||
| 8 | Navigation | ✅ done |
|
||
| 9 | Editor Glue | ✅ done |
|
||
| 10 | CI/CD release pipeline | ✅ done |
|
||
|
||
### v1.1 — full vimwiki replacement
|
||
|
||
| Phase | Name | Status |
|
||
|---|---|---|
|
||
| 11 | Plumbing prerequisites | ✅ done |
|
||
| 12 | Tags | ✅ done |
|
||
| 13 | Workspace edits + executeCommand | ✅ done |
|
||
| 14 | List & table edit commands | ✅ done (focused subset; table/list-renumber/colorize deferred) |
|
||
| 15 | Link health + TOC/index generation | ✅ done |
|
||
| 16 | Diary | ✅ done |
|
||
| 17 | HTML export commands | ✅ done |
|
||
| 18 | Multi-wiki | ✅ done |
|
||
| 19 | Editor glue v2 (`:Vimwiki*` compat, keymaps, text objects, folding) | ⏳ |
|
||
|
||
## Repository layout
|
||
|
||
```
|
||
nuwiki/
|
||
├── Cargo.toml workspace root
|
||
├── crates/
|
||
│ ├── nuwiki-core/ parser, AST, renderer (no editor deps)
|
||
│ ├── nuwiki-lsp/ LSP protocol bridge
|
||
│ └── nuwiki-ls/ binary that speaks LSP over stdio
|
||
├── plugin/ universal Vim/Neovim entry point
|
||
├── lua/nuwiki/ Neovim Lua glue
|
||
├── autoload/nuwiki/ Vim VimL glue
|
||
├── ftdetect/ filetype detection for .wiki
|
||
├── ftplugin/ per-buffer filetype settings
|
||
├── syntax/ static fallback highlighting
|
||
├── doc/ `:h nuwiki`
|
||
├── scripts/ build-time helpers
|
||
└── .gitea/workflows/ CI / release pipelines
|
||
```
|
||
|
||
## Building
|
||
|
||
```sh
|
||
cargo build --workspace
|
||
cargo test --workspace
|
||
```
|
||
|
||
MSRV: Rust 1.83.
|
||
|
||
## License
|
||
|
||
Dual-licensed under either of:
|
||
|
||
- Apache License, Version 2.0 ([`LICENSE-APACHE`](./LICENSE-APACHE))
|
||
- MIT license ([`LICENSE-MIT`](./LICENSE-MIT))
|
||
|
||
at your option. Unless you explicitly state otherwise, any contribution
|
||
intentionally submitted for inclusion in this work shall be dual licensed as
|
||
above, without any additional terms or conditions.
|