generated from eblume/project-template
Erich Blume
3997e948ed
Some checks failed
Build / validate (pull_request) Failing after 3s
Make mise the dev entrypoint for the headless e2e suite, matching the repo's mise-tasks convention (auto-discovered, shows in `mise tasks`). Dev relies on system-installed nvim + rustc; CI will provide them via Dagger (slice 11c). The self-contained shim runner is unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# heph.nvim
|
|
|
|
The primary surface for [hephaestus](../README.md) — an obsidian.nvim
|
|
replacement that is a thin client of the local `hephd` daemon over its
|
|
unix-socket JSON-RPC (tech-spec §8). Notes, journals, and tasks are edited as
|
|
ordinary Neovim buffers; saving routes through the daemon.
|
|
|
|
> **Status:** built in checkpointed slices. **11a (this slice)** delivers the
|
|
> RPC client, buffer-backed editing, `[[wiki-link]]` following, and the daily
|
|
> journal. Task/agenda views (`:Heph next`/`list`/capture), the per-task log,
|
|
> and promotion arrive in 11b/11c. See tech-spec §14.
|
|
|
|
## How it works
|
|
|
|
- **Buffer-backed nodes.** A node is edited in a buffer named
|
|
`heph://node/<id>`. Opening it loads the markdown body via `node.get`; `:w`
|
|
saves the whole buffer back via `node.update` (the backend diffs it into a
|
|
text CRDT, so sending the full buffer is correct). `buftype=acwrite`.
|
|
- **Links.** Press `<CR>` on a `[[wiki-link]]` to jump to its node (resolved
|
|
exactly via `node.resolve`). Unresolved links are allowed — they just notify.
|
|
- **Journal.** `:Heph today` (or `:Heph journal YYYY-MM-DD`) opens a dated
|
|
journal note; the id is deterministic so reopening is idempotent.
|
|
|
|
## Setup
|
|
|
|
Requires a running `hephd` (`hephd --mode local`) and Neovim ≥ 0.10.
|
|
|
|
```lua
|
|
require("heph").setup({
|
|
-- socket = "/run/user/1000/heph/hephd.sock", -- defaults to hephd's path
|
|
-- keymaps = true, -- <leader>h* maps
|
|
-- autostart = false, -- spawn hephd if absent
|
|
})
|
|
```
|
|
|
|
## Commands
|
|
|
|
| Command | Action |
|
|
|---|---|
|
|
| `:Heph today` | Open today's journal |
|
|
| `:Heph journal <YYYY-MM-DD>` | Open a dated journal |
|
|
| `:Heph follow` | Follow the `[[link]]` under the cursor (also `<CR>`) |
|
|
| `:Heph open <id>` | Open a node buffer by id |
|
|
|
|
## Tests
|
|
|
|
The e2e suite drives the plugin in headless Neovim against a real daemon:
|
|
|
|
```bash
|
|
mise run test-nvim # builds hephd, runs the headless e2e suite
|
|
```
|
|
|
|
The suite uses a small self-contained busted-style runner
|
|
(`tests/e2e/runner.lua`) — no external plugins and no network, so it is
|
|
deterministic. Dev runs use system-installed Neovim (≥ 0.10) + rustc; CI runs
|
|
the same suite inside a Dagger container that provides them (slice 11c).
|