@commte/mdbrowse 0.3.1 → 0.3.3

package/README.ja.md

@@ -47,7 +47,7 @@ cd mdbrowse
 ./install.sh
 ```
 
-`mdb`（と長いほうの `mdbrowse`）が `~/.local/bin` に、スタイルシートが `~/.config/mdbrowse/head.html` に入る。再インストールしても自分で編集したスタイルシートは上書きされない。配布時の状態に戻したいときは `--force` を付ける
+`install.sh` は、実行に要る依存（Shiki）が無ければ npm で入れてから、`mdb`（と長いほうの `mdbrowse`）を `~/.local/bin` に、スタイルシートを `~/.config/mdbrowse/head.html` に置く。再インストールしても自分で編集したスタイルシートは上書きされない。配布時の状態に戻したいときは `--force` を付ける
 
 </details>
 
@@ -59,7 +59,7 @@ mdb
 
 プレビュー用のタブが開き、小さな背景プロセスが動きだす。以後どの Markdown を保存しても、どのプロジェクトのものでも、そのタブに出る。止めるときは `mdb --stop`、再開はまた `mdb`
 
-ログアウトや再起動で消える。macOS なら、勝手に戻ってくるようにもできる
+ログアウトや再起動で消えるので、そのままだと次に使うときにもう一度 `mdb` を叩くことになる。macOS なら、勝手に戻ってくるようにもできる
 
 ```sh
 mdb --install-agent
@@ -186,6 +186,14 @@ vim.api.nvim_create_autocmd("BufWritePost", {
 mdb sample.md
 ```
 
+## テスト
+
+```sh
+npm test
+```
+
+`test/cli.sh` はコマンド側を動かす。変換、相対パスの書き換え、異常系、監視、背景プロセスまで通す。必要なのは pandoc だけ。`test/browser.test.js` は `assets/head.html` からスクリプトを取り出して jsdom で動かし、更新の検知、目次の判定、バーの設定を見る。CI では macOS と Linux の両方で回していて、通らないものは公開されない
+
 ## 仕組み
 
 ```

package/README.md

@@ -47,7 +47,7 @@ cd mdbrowse
 ./install.sh
 ```
 
-This installs `mdb` (and the longer `mdbrowse`) into `~/.local/bin`, and the stylesheet into `~/.config/mdbrowse/head.html`. Your stylesheet is never overwritten on reinstall; pass `--force` when you do want the shipped one back.
+`install.sh` pulls in the one runtime dependency (Shiki) with npm if it is not there yet, then installs `mdb` (and the longer `mdbrowse`) into `~/.local/bin` and the stylesheet into `~/.config/mdbrowse/head.html`. Your stylesheet is never overwritten on reinstall; pass `--force` when you do want the shipped one back.
 
 </details>
 
@@ -59,7 +59,7 @@ mdb
 
 That opens the preview tab and starts a small background process. Save any Markdown file from here on and it shows up in that tab, whichever project it lives in. `mdb --stop` ends it; `mdb` starts it again.
 
-The process is gone after a logout or a reboot. On macOS you can have it come back on its own:
+The process is gone after a logout or a reboot, so otherwise you run `mdb` again next time. On macOS you can have it come back on its own:
 
 ```sh
 mdb --install-agent
@@ -186,6 +186,14 @@ Everything else visual lives in `~/.config/mdbrowse/head.html`: a settings block
 mdb sample.md
 ```
 
+## Tests
+
+```sh
+npm test
+```
+
+`test/cli.sh` drives the command itself — rendering, path rewriting, exit codes, watching, the background sync — and needs nothing but pandoc. `test/browser.test.js` pulls the script out of `assets/head.html` and runs it under jsdom, covering the reload loop, the table of contents rules and the settings bar. Both run on macOS and Linux in CI, and a release only goes out if they pass.
+
 ## How it works
 
 ```

package/assets/head.html

@@ -56,7 +56,7 @@
   body {
     max-width: var(--content-width);
     margin: 0 auto;
-    padding: 32px 32px 160px;
+    padding: 80px 32px 160px;
     font-size: var(--font-size);
     line-height: var(--line-height);
     font-family: var(--font-family);
@@ -79,6 +79,8 @@
   h1:first-child { margin-top: 0; }
   p, ul, ol, blockquote, table, pre { margin: 0 0 16px; }
   a { color: var(--link); text-decoration: none; }
+  /* 訪問済みも同じ色にする。指定しないと環境によっては本文色に落ちて見分けが付かない */
+  a:visited { color: var(--link); }
   a:hover { text-decoration: underline; }
   code {
     font-family: var(--code-font-family); font-size: 85%;

package/bin/mdbrowse

@@ -3,7 +3,7 @@
 # browser tab can stay open and just swap its contents.
 set -euo pipefail
 
-VERSION="0.3.1"
+VERSION="0.3.3"
 PROG="$(basename "$0")"
 OUT="${MDBROWSE_OUT:-/tmp/mdbrowse.html}"
 case "$OUT" in
@@ -141,6 +141,17 @@ stop_sync() {
   if [ "$stopped" -eq 1 ]; then echo "$PROG: stopped"; else echo "$PROG: not running"; fi
 }
 
+# ログイン時の自動起動があることを、初回だけ1行で知らせる。
+# 毎回出すと邪魔になるので、一度出したら記録して黙る
+hint_agent() {
+  [ "$(uname -s)" = "Darwin" ] || return 0
+  agent_installed && return 0
+  [ -f "$RUNTIME_DIR/agent-hint" ] && return 0
+  mkdir -p "$RUNTIME_DIR" 2>/dev/null || true
+  : > "$RUNTIME_DIR/agent-hint" 2>/dev/null || true
+  echo "$PROG: it stops at logout — 'mdb --install-agent' starts it at every login"
+}
+
 start_sync() {
   if running_pid >/dev/null; then
     echo "$PROG: already in sync (mdb --stop to end it)"
@@ -156,6 +167,7 @@ start_sync() {
   done
   if running_pid >/dev/null; then
     echo "$PROG: in sync — save any .md and it shows up here (mdb --stop to end it)"
+    hint_agent
   else
     echo "$PROG: could not start the background sync (see $LOGFILE)" >&2
     return 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commte/mdbrowse",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Preview the Markdown file you are editing in a real browser, with your own CSS, from any editor that can run a shell command. No server, no port.",
   "bin": {
     "mdbrowse": "bin/mdbrowse",
@@ -15,6 +15,11 @@
     "README.ja.md",
     "LICENSE"
   ],
+  "scripts": {
+    "test": "bash test/cli.sh && vitest run",
+    "test:cli": "bash test/cli.sh",
+    "test:browser": "vitest run"
+  },
   "keywords": [
     "markdown",
     "preview",
@@ -43,5 +48,9 @@
   },
   "dependencies": {
     "shiki": "^4.4.3"
+  },
+  "devDependencies": {
+    "jsdom": "^30.0.1",
+    "vitest": "^5.0.0"
   }
 }