gffranco
8b29d4e9b9
Vimwiki `:tag1:tag2:` syntax across the full stack. P11 resolved as
strict-vimwiki — no markdown `#tag` alias.
AST (nuwiki-core):
- `TagScope { File, Heading(usize), Standalone }` mirrors vimwiki's
three placement-determined meanings: lines 0-1 → File; one or two
lines below the most recent heading → Heading(idx); otherwise
Standalone.
- `TagNode { span, tags: Vec<String>, scope }` + `BlockNode::Tag`.
- `PageMetadata.tags: Vec<String>` accumulates the file-scope tag
names — convenience projection of the Tag blocks whose scope is
File. New field is additive (Default derive) so existing consumers
using `..Default::default()` keep working.
- `Visitor::visit_tag` lands with a default body and `walk_block`
dispatches the new arm.
Lexer (`syntax/vimwiki/lexer.rs`):
- `VimwikiTokenKind::Tag(Vec<String>)` block-level token.
- `try_lex_tag` runs in the normal-line dispatcher right after heading
recognition; demands the *whole trimmed line* match `:name:name…:`,
with non-empty whitespace-free names between adjacent colons. Empty
segments (`::tag::`), whitespace inside a name, or single-colon
lines are all rejected. Doesn't fight `Term::` (definition-list
marker) because that pattern requires text before the `::`.
- Indentation is tolerated; the span covers the trimmed run.
Parser (`syntax/vimwiki/parser.rs`):
- `ParseState` gains `headings_seen` + `last_heading_line`.
- `parse_heading` bumps both on every closed heading so the tag
parser can detect the heading window.
- `parse_tag` reads the Tag token, computes the scope via
`scope_for_tag(tag_line)`, eats the trailing newline, and emits the
TagNode.
- `parse_document` post-processes each block: when a Tag with
`scope == File` is emitted, its names are pushed (de-duped) into
`metadata.tags`.
Renderer (`render/html.rs`):
- `render_tag` emits `<div class="tags"><span class="tag"
id="tag-name">name</span>...</div>`. The `id` is what makes
`[[Page#tag-name]]` jump to the rendered tag.
Semantic tokens (`semantic_tokens.rs`):
- New `TOKEN_TAG = 19` / `vimwikiTag` so editors highlight tag lines
distinctly. `emit_block` adds the Tag arm.
Workspace index (`index.rs`):
- `IndexedPage.tags: Vec<TagInfo>` records each tag occurrence on a
page with its span + scope.
- `WorkspaceIndex.tags_by_name: HashMap<String, Vec<TagOccurrence>>`
is the reverse map for cross-page anchor resolution + the Phase 13
`nuwiki.tags.search` command.
- `upsert` populates both; `remove` scrubs the reverse map and drops
empty entries; `tags_for(name)` is the public lookup.
LSP handlers (`lib.rs`):
- `heading_range_in` falls back to tag matching when the anchor
isn't a heading slug — so `[[Page#some-tag]]` lands on the matching
TagNode. Heading anchors win over tag anchors when both match (the
vimwiki precedence).
- `workspace/symbol` includes tags alongside headings, named `:tag:`
and kinded `PROPERTY` so editor UIs can distinguish them.
Tests (20 new):
- Syntax (15 in `vimwiki_tags.rs`):
lexer recognition + rejection of `::tag::`, whitespace-in-name,
Term::-conflict; parser scope paths (file, heading-1-below,
heading-2-below, standalone, no-heading, line-1 priority);
metadata dedup; renderer HTML + escaping.
- LSP index (5 in `tags_index_and_lsp.rs`):
per-page tag population, cross-page `tags_by_name` aggregation,
re-upsert replaces stale tags, `remove` cleans the reverse map,
heading-scope tag indexed but not in file metadata.
All 191 v1.0 + Phase 11 tests still pass — backward compatible.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
85 lines
2.6 KiB
Markdown
85 lines
2.6 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 | ⏳ |
|
||
| 14 | List & table edit commands | ⏳ |
|
||
| 15 | Link health + TOC/index generation | ⏳ |
|
||
| 16 | Diary | ⏳ |
|
||
| 17 | HTML export commands | ⏳ |
|
||
| 18 | Multi-wiki | ⏳ |
|
||
| 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.
|