nuwiki/development/start-nvim.sh

#!/usr/bin/env bash
#
# start-nvim.sh — launch Neovim with a minimal config that loads nuwiki.
#
# Builds the language server (release mode), symlinks it into `bin/` so
# the plugin's default install path resolves, then spawns Neovim with
# `--clean` and a generated `init.lua` that:
#   * adds this repo to `runtimepath`
#   * configures wiki_root to a scratch directory under
#     $XDG_CACHE_HOME/nuwiki-dev/wiki
#   * calls `require('nuwiki').setup({...})`
#
# Usage: ./development/start-nvim.sh [extra args...]
#   ./development/start-nvim.sh                       # open the scratch wiki's index
#   ./development/start-nvim.sh path/to/note.wiki     # open a specific file
#   NUWIKI_DEV_WIKI=/tmp/foo ./development/start-nvim.sh
#   NUWIKI_DEV_SKIP_BUILD=1 ./development/start-nvim.sh   # reuse the cached binary
#
# The release binary is rebuilt on every launch so source changes
# always reach the running LSP. `cargo build --release` is incremental,
# so this is a fast no-op when nothing changed. Set
# NUWIKI_DEV_SKIP_BUILD=1 to skip the build step entirely.
#
# Tested with Neovim 0.10+. State (cache/data/config) lives under
# $XDG_CACHE_HOME/nuwiki-dev/ so your real Neovim install stays
# untouched.

set -euo pipefail

REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
DEV_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/nuwiki-dev"
WIKI_DIR="${NUWIKI_DEV_WIKI:-$DEV_DIR/wiki}"
INIT_FILE="$DEV_DIR/init.lua"
STATE_DIR="$DEV_DIR/nvim-state"
DATA_DIR="$DEV_DIR/nvim-data"
CONFIG_DIR="$DEV_DIR/nvim-config"

log() { printf '\033[1;34m[nuwiki-dev]\033[0m %s\n' "$*"; }

ensure_binary() {
  local bin="$REPO_ROOT/bin/nuwiki-ls"
  local built="$REPO_ROOT/target/release/nuwiki-ls"
  if [[ "${NUWIKI_DEV_SKIP_BUILD:-0}" == "1" ]]; then
    if [[ ! -x "$bin" ]]; then
      log "NUWIKI_DEV_SKIP_BUILD=1 but $bin is missing — building anyway"
    else
      log "NUWIKI_DEV_SKIP_BUILD=1 — using existing $bin"
      return
    fi
  fi
  log "building nuwiki-ls (release)…"
  cargo build --release -p nuwiki-ls --manifest-path "$REPO_ROOT/Cargo.toml"
  mkdir -p "$REPO_ROOT/bin"
  ln -sf "$built" "$bin"
  log "binary ready: $bin (built $(date -r "$built" '+%Y-%m-%d %H:%M:%S'))"
}

# write_sample_wiki DIR — lay down a fixture that exercises every vimwiki
# feature nuwiki supports: one page per feature group plus a diary. Kept
# identical to the copy in start-vim.sh so both launchers showcase the
# same surface. Heredocs use a quoted delimiter so `$math`, backticks,
# and backslashes land verbatim.
write_sample_wiki() {
  local root="$1"
  mkdir -p "$root" "$root/diary"

  cat > "$root/index.wiki" <<'EOF'
= nuwiki sample wiki =

%% Generated by the start-* dev launchers. A single fixture that exercises
%% every vimwiki feature nuwiki supports — open the linked pages and run
%% the plugin commands against them.

One page per feature group:

- [[Syntax]] — inline formatting, blocks, comments
- [[Lists]] — bullets, ordering, checkbox states, nesting
- [[Tables]] — alignment and spanning cells
- [[Links]] — every wikilink and URL form
- [[Notes]] — anchor targets for cross-page links
- [[diary/diary]] — the diary index

=== Heading level 3 ===
==== Heading level 4 ====
===== Heading level 5 =====
====== Heading level 6 ======

== Commands to try ==

- :NuwikiTOC
- :NuwikiGenerateLinks
- :NuwikiCheckLinks
- :NuwikiMakeDiaryNote

:sample:smoke-test:sandbox:
EOF

  cat > "$root/Syntax.wiki" <<'EOF'
= Syntax showcase =

Back to [[index]].

== Inline formatting ==

*bold*, _italic_, *_bold italic_*, ~~strikethrough~~, `inline code`,
super^script^ and sub,,script,,, and inline math $e^{i\pi} + 1 = 0$.

== Keywords ==

TODO STARTED FIXME XXX DONE FIXED STOPPED

== Horizontal rule ==

----

== Blockquote ==

> A quoted line.
> A second quoted line.

== Definition list ==

Term:: Definition of the term.
Another:: Its definition.

== Code block ==

{{{python
def greet(name):
    return f"hello {name}"
}}}

== Math block ==

{{$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
}}$

== Comments ==

%% a single-line comment
%%+ a multi-line
comment block +%%

== Transclusion ==

{{file:image.png}}
{{image.png|alt text|width=120}}
EOF

  cat > "$root/Lists.wiki" <<'EOF'
= Lists =

Back to [[index]].

== Unordered ==

- item with dash
- second
  - nested under dash
* item with star
# item with hash

== Ordered ==

1. first
2. second
   1. nested ordered
1) paren style
a) alpha
A) Alpha
i) roman
I) Roman

== Checkbox states ==

- [ ] empty (0%)
- [.] started (1-33%)
- [o] in progress (34-66%)
- [O] nearly done (67-99%)
- [X] done (100%)
- [-] rejected

== Nested with checkboxes ==

- [ ] parent task
  - [X] done subtask
  - [ ] pending subtask
    - [ ] deep subtask
EOF

  cat > "$root/Tables.wiki" <<'EOF'
= Tables =

Back to [[index]].

== Plain ==

| Name | Role |
| Alice | Author |
| Bob | Editor |

== Aligned ==

| Left | Center | Right |
|:-----|:------:|------:|
| a | b | c |
| d | e | f |

== Spanning cells ==

| Header | Span |
| cell | > |
| rowspan | value |
| \/ | value |
EOF

  cat > "$root/Links.wiki" <<'EOF'
= Links =

Back to [[index]].

== Wikilinks ==

- [[Notes]]
- [[Notes|described]]
- [[Notes#Section one]]
- [[Notes#Section one|anchored + described]]
- [[/index]]
- [[diary/]]
- [[#Wikilinks]]

== Diary and interwiki ==

- [[diary:2026-05-30]]
- [[wiki1:index]]
- [[wn.MyWiki:index]]

== External and raw URLs ==

- [[https://example.com]]
- [[https://example.com|Example]]
- https://example.com
- mailto:gffranco@gmail.com
- file:///etc/hosts
EOF

  cat > "$root/Notes.wiki" <<'EOF'
= Notes =

A page that other pages point at. Back to [[index]].

== Section one ==

Anchor target for cross-page links.

== Section two ==

Another anchor target.
EOF

  cat > "$root/diary/diary.wiki" <<'EOF'
= Diary =

Back to [[/index]].

- [[2026-05-30]]
EOF

  cat > "$root/diary/2026-05-30.wiki" <<'EOF'
= 2026-05-30 =

A diary entry. Back to [[diary]].

- [X] set up sample wiki
- [ ] review every feature page
EOF
}

seed_wiki() {
  mkdir -p "$WIKI_DIR" "$WIKI_DIR/diary"
  # Seed the whole showcase as a unit; skip when an index already exists
  # so a re-run never clobbers edits made while testing.
  if [[ -f "$WIKI_DIR/index.wiki" ]]; then
    return
  fi
  write_sample_wiki "$WIKI_DIR"
}

write_init() {
  mkdir -p "$DEV_DIR"
  cat > "$INIT_FILE" <<EOF
-- start-nvim.sh: generated minimal config for nuwiki development.
-- Regenerated on every launch; edit start-nvim.sh, not this file.

-- Confine state to the dev cache so we never touch the user's real
-- Neovim install.
vim.env.XDG_STATE_HOME = '$STATE_DIR'
vim.env.XDG_DATA_HOME = '$DATA_DIR'
vim.env.XDG_CONFIG_HOME = '$CONFIG_DIR'

vim.opt.runtimepath:prepend('$REPO_ROOT')

vim.g.nuwiki_binary_path = '$REPO_ROOT/bin/nuwiki-ls'

-- Friendly defaults for an interactive smoke test.
vim.opt.number = true
vim.opt.signcolumn = 'yes'
vim.opt.termguicolors = true
vim.opt.swapfile = false
vim.opt.writebackup = false
vim.opt.undofile = false
vim.g.mapleader = ' '

require('nuwiki').setup({
  wiki_root = '$WIKI_DIR',
})

-- Surface log lines (the LSP logs via window/logMessage). Without this
-- they're swallowed; with it they land in :messages.
vim.lsp.set_log_level('info')

print('[nuwiki-dev] ready — wiki root: $WIKI_DIR')
print('[nuwiki-dev] :LspInfo to inspect, :checkhealth nuwiki for diagnostics')
EOF
}

main() {
  ensure_binary
  seed_wiki
  write_init
  mkdir -p "$STATE_DIR" "$DATA_DIR" "$CONFIG_DIR"

  log "launching: nvim --clean -u $INIT_FILE"
  if [[ $# -gt 0 ]]; then
    exec nvim --clean -u "$INIT_FILE" "$@"
  else
    exec nvim --clean -u "$INIT_FILE" "$WIKI_DIR/index.wiki"
  fi
}

main "$@"