gffranco
02291c2744
P9 resolved (SPEC §11): stay manual. CI builds the four Linux targets
via cross; macOS + Windows binaries are produced ad hoc by maintainers
and uploaded to the same Gitea release.
§8.2/§8.4 updated: crates.io publish is deferred for now (workflow
ships the Gitea release only; can be re-enabled with a one-line
`cargo publish -p nuwiki-core` job once we're ready to publish). The
CARGO_REGISTRY_TOKEN row in §8.4 is struck through accordingly.
release.yaml:
- Trigger: `push` on tags matching `v*`.
- build matrix (4 jobs): x86_64/aarch64 × gnu/musl. Each pins
Rust 1.83, caches `~/.cargo/{bin,registry,git}` + `target` keyed
on target + Cargo.lock hash, installs `cross 0.2.5` if not in
cache, runs `cross build --release -p nuwiki-ls`, packages as
`nuwiki-ls-{version}-{target}.tar.gz`, uploads as an artifact.
- release job: `needs: build`. Downloads all build artifacts via
download-artifact@v4 with `merge-multiple: true`; installs jq +
curl if missing; POSTs a release-create payload to
`/api/v1/repos/$REPO/releases` using `RELEASE_TOKEN`, then streams
each `.tar.gz` to `/releases/{id}/assets?name=…`. Up-front check
fails fast if the secret is unset.
README + SPEC top-line status: "All phases (0–10) complete." 172
tests still green locally.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
68 lines
2.1 KiB
Markdown
68 lines
2.1 KiB
Markdown
# nuwiki
|
||
|
||
A Vim/Neovim plugin providing full vimwiki syntax support, implemented as a
|
||
Rust-based language server (LSP).
|
||
|
||
> **Status:** All phases (0–10) complete. v1 feature set landed:
|
||
> editor-independent core, vimwiki lexer + parser, HTML renderer,
|
||
> tower-lsp server with diagnostics + outline + semantic tokens +
|
||
> navigation + workspace index, plugin glue, and release pipeline.
|
||
|
||
See [`SPEC.md`](./SPEC.md) for the full project specification.
|
||
|
||
## Implementation status
|
||
|
||
| 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 |
|
||
|
||
## 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.
|