@commte/mdbrowse 0.2.0 → 0.2.1

package/README.ja.md

@@ -70,6 +70,11 @@ mdb -w file.md   # 1つのファイルだけを前面で監視する（Ctrl-C
 mdb --path       # 出力先の HTML のパスを表示する
 ```
 
+| 環境変数 | 既定値 | |
+|---|---|---|
+| `MDBROWSE_OUT` | `/tmp/mdbrowse.html` | 出力先の HTML |
+| `MDBROWSE_HEAD` | `~/.config/mdbrowse/head.html` | スタイルとブラウザ側のスクリプト |
+
 ### どうやって保存したファイルを見つけているか
 
 Spotlight（`mdfind`）に「直近に保存された Markdown」を尋ねて、それを変換している。ディスクを歩き回らないので軽い。隠しディレクトリ、`node_modules`、`~/Library` の下は無視する。Spotlight が使えない環境では、`mdb` を実行したディレクトリを見る動きに落ちる

package/README.md

@@ -70,6 +70,11 @@ mdb -w file.md   # follow one file in the foreground (Ctrl-C to stop)
 mdb --path       # print the output HTML path
 ```
 
+| Variable | Default | |
+|---|---|---|
+| `MDBROWSE_OUT` | `/tmp/mdbrowse.html` | output HTML path |
+| `MDBROWSE_HEAD` | `~/.config/mdbrowse/head.html` | stylesheet and browser script |
+
 ### How the sync finds your file
 
 It asks Spotlight (`mdfind`) which Markdown file was saved most recently, twice a second-and-a-bit, and renders that one. Walking your disk is never involved, so it stays cheap. Files under hidden directories, `node_modules` and `~/Library` are ignored. Without Spotlight it falls back to watching the directory you started `mdb` in.

package/assets/head.html

@@ -186,6 +186,8 @@
     var printing = false;
     addEventListener('beforeprint', function () { printing = true; });
     addEventListener('afterprint', function () { printing = false; });
+    // 印刷がキャンセルされて afterprint が来ない場合に、止まったままにならないようにする
+    addEventListener('visibilitychange', function () { if (!document.hidden) printing = false; });
 
     function save() { try { localStorage.setItem('mdbrowse', JSON.stringify(s)); } catch (e) {} }
     function fontSize() { return s.fontSize || parseInt(getComputedStyle(r).getPropertyValue('--font-size')) || 16; }
@@ -333,8 +335,9 @@
     addEventListener('focus', function () { checkStamp(); });
     // バーを操作している間は再読み込みを止める。状態を持たずにその場で見る
     // （持つと、バーの上にポインタを置いたままウィンドウを離れたときに止まったままになる）
+    var hoverable = !matchMedia || matchMedia('(hover: hover)').matches;
     setInterval(function () {
-      if (printing || bar.matches(':hover')) return;
+      if (printing || (hoverable && bar.matches(':hover'))) return;
       if (Date.now() - lastScroll < 900) return;
       checkStamp();
     }, 1000);

package/bin/mdbrowse

@@ -3,7 +3,7 @@
 # browser tab can stay open and just swap its contents.
 set -euo pipefail
 
-VERSION="0.2.0"
+VERSION="0.2.1"
 PROG="$(basename "$0")"
 OUT="${MDBROWSE_OUT:-/tmp/mdbrowse.html}"
 CONFIG_DIR="${XDG_CONFIG_HOME:-$HOME/.config}/mdbrowse"
@@ -79,12 +79,15 @@ open_tab() {
 }
 
 PIDFILE="${OUT%.html}-sync.pid"
+LOGFILE="${OUT%.html}-sync.log"
 
 running_pid() {
   [ -f "$PIDFILE" ] || return 1
   local pid; pid="$(cat "$PIDFILE" 2>/dev/null)"
   [ -n "$pid" ] || return 1
   kill -0 "$pid" 2>/dev/null || return 1
+  # PID は使い回される。中身が自分のプロセスか確かめてから扱う
+  ps -p "$pid" -o command= 2>/dev/null | grep -q -- '--sync-daemon' || return 1
   echo "$pid"
 }
 
@@ -105,9 +108,20 @@ start_sync() {
     echo "$PROG: already in sync (mdb --stop to end it)"
     return 0
   fi
+  # PID は起動した本人に書かせる。すぐ落ちた場合に死んだ PID を残さないため
   nohup "$0" --sync-daemon "$PWD" >/dev/null 2>&1 &
-  echo $! > "$PIDFILE"
-  echo "$PROG: in sync — save any .md and it shows up here (mdb --stop to end it)"
+  local i=0
+  while [ $i -lt 20 ]; do
+    running_pid >/dev/null && break
+    i=$(( i + 1 ))
+    sleep 0.1
+  done
+  if running_pid >/dev/null; then
+    echo "$PROG: in sync — save any .md and it shows up here (mdb --stop to end it)"
+  else
+    echo "$PROG: could not start the background sync (see $LOGFILE)" >&2
+    return 1
+  fi
 }
 
 case "${1:-}" in
@@ -147,13 +161,23 @@ while [ $# -gt 0 ]; do
     --sync-daemon) daemon=1; shift; sync_cwd="${1:-$PWD}" ;;
     --) shift; [ $# -gt 0 ] && src="$1"; break ;;
     -*) echo "$PROG: unknown option: $1" >&2; exit 2 ;;
-    *) src="$1" ;;
+    *)
+      if [ -n "$src" ]; then
+        echo "$PROG: too many files: $1" >&2
+        exit 2
+      fi
+      src="$1" ;;
   esac
-  shift
+  shift || break
 done
 
 # 引数なし（または --open だけ）が既定の使い方。タブを開いて、以後は勝手に追従する
 if [ -z "$src" ] && [ "$watch" -eq 0 ] && [ "$daemon" -eq 0 ]; then
+  # --open だけを渡された場合はタブを開くだけ（エディタのタスクから呼ばれる経路）
+  if [ "$do_open" -eq 1 ]; then
+    open_tab
+    exit 0
+  fi
   if ! command -v pandoc >/dev/null 2>&1; then
     echo "$PROG: pandoc not found. Install it first (macOS: brew install pandoc)" >&2
     exit 127
@@ -192,34 +216,41 @@ if command -v node >/dev/null 2>&1 && [ -f "$HIGHLIGHTER" ]; then
   use_shiki=1
 fi
 
-# シンタックスハイライトの指定は pandoc 3.9 で名前が変わった
+# シンタックスハイライトの指定は pandoc 3.9 で名前が変わった。
+# sort -V は POSIX に無いので、major と minor を数として比べる
 pv="$(pandoc --version | head -1 | awk '{print $2}')"
-if [ "$(printf '%s\n3.9\n' "$pv" | sort -V | head -1)" = "3.9" ]; then
+pv_major="${pv%%.*}"; pv_rest="${pv#*.}"; pv_minor="${pv_rest%%.*}"
+case "$pv_major$pv_minor" in *[!0-9]*|'') pv_major=0; pv_minor=0 ;; esac
+if [ "$pv_major" -gt 3 ] || { [ "$pv_major" -eq 3 ] && [ "$pv_minor" -ge 9 ]; }; then
   if [ "$use_shiki" -eq 1 ]; then hl=(--syntax-highlighting none); else hl=(--syntax-highlighting breezedark); fi
 else
   if [ "$use_shiki" -eq 1 ]; then hl=(--no-highlight); else hl=(--highlight-style breezedark); fi
 fi
 
 render() {
-  local args=(--standalone --from gfm "${hl[@]}" --variable "pagetitle=$(basename "$src")" --output "$OUT")
+  # 途中経過をタブに見せないため、別名で組み立ててから置き換える
+  local tmp="$OUT.part"
+  # 出力先が .part なので、拡張子から形式を推測させず明示する
+  local args=(--standalone --from gfm --to html5 "${hl[@]}" --variable "pagetitle=$(basename "$src")" --output "$tmp")
   [ -f "$HEAD" ] && args+=(--include-in-header "$HEAD")
 
   pandoc "$src" "${args[@]}"
 
   # コードブロックを Shiki で色付けし直す。失敗しても変換自体は成立させる
   if [ "$use_shiki" -eq 1 ]; then
-    node "$HIGHLIGHTER" "$OUT" || true
+    node "$HIGHLIGHTER" "$tmp" || true
   fi
 
   # frontmatter の title を pandoc が拾うと本文の先頭に見出しが増えるので落とす。
   # ブラウザのタブ名には pagetitle を使っている
-  perl -0pi -e 's#<header id="title-block-header">.*?</header>\n?##s' "$OUT"
+  perl -0pi -e 's#<header id="title-block-header">.*?</header>\n?##s' "$tmp"
 
   # 出力先が /tmp なので、元ファイルからの相対パス（画像・ローカルリンク）が
   # そのままでは解決できない。ソースのあるディレクトリ基準の file:// に書き換える。
   # 書き換えるのはタグの属性だけ。本文中の src="..." のようなインラインコードは触らない。
   # スキーム付き（http(s) data: mailto: など）／絶対パス／ページ内アンカーはそのまま残す
-  local src_dir="$(cd "$(dirname "$src")" && pwd)"
+  local src_dir
+  src_dir="$(cd "$(dirname "$src")" && pwd)" || return 1
   MDBROWSE_SRC_DIR="$src_dir" perl -0pi -e '
   BEGIN {
     $base = $ENV{MDBROWSE_SRC_DIR};
@@ -227,6 +258,8 @@ render() {
     $base =~ s/%/%25/g;
     $base =~ s/#/%23/g;
     $base =~ s/\?/%3F/g;
+    $base =~ s/&/%26/g;
+    $base =~ s/"/%22/g;
     $base =~ s/ /%20/g;
   }
   s{(<(?:img|a|source|video|audio|embed|object|track)\b)([^>]*?)(/?>)}{
@@ -235,62 +268,93 @@ render() {
                {$1 . "file://" . $base . "/" . $2 . "\""}ge;
     $tag . $attrs . $close;
   }gse;
-' "$OUT"
+' "$tmp"
+
+  mv -f "$tmp" "$OUT"
 
-  # 更新の目印。ブラウザはこれを見て、中身が変わったときだけ読み直す
-  printf 'window.__mdbrowseStamp="%s";\n' "$(date +%s)-$RANDOM" > "${OUT%.html}-stamp.js"
+  # 更新の目印。ブラウザはこれを見て、中身が変わったときだけ読み直す。
+  # 本体の差し替えが済んでから書く
+  local stamp="${OUT%.html}-stamp.js"
+  printf 'window.__mdbrowseStamp="%s";\n' "$(date +%s)-$RANDOM" > "$stamp.part"
+  mv -f "$stamp.part" "$stamp"
 }
 
 # ファイルの更新時刻とサイズ。同じ秒内の2回目の保存も拾えるようにサイズも見る
 if stat -f %m . >/dev/null 2>&1; then
-  fingerprint() { stat -f '%m %z' "$1" 2>/dev/null; }
-  stat_time_name() { xargs -0 stat -f '%m %N' 2>/dev/null; }
+  fingerprint() { stat -f '%Fm %z %i' "$1" 2>/dev/null || true; }
+  stat_time_name() { xargs -0 stat -f '%m %N' 2>/dev/null || true; }
 else
-  fingerprint() { stat -c '%Y %s' "$1" 2>/dev/null; }
-  stat_time_name() { xargs -0 stat -c '%Y %n' 2>/dev/null; }
+  fingerprint() { stat -c '%.9Y %s %i' "$1" 2>/dev/null || true; }
+  stat_time_name() { xargs -0 stat -c '%Y %n' 2>/dev/null || true; }
 fi
 
+# 「更新時刻 パス」の行から、いちばん新しい1件を返す。
+# sort と head の組み合わせは、件数が多いと head の SIGPIPE で pipefail に引っかかる
+pick_newest() {
+  awk '$1 > m { m = $1; sub(/^[0-9]+ /, ""); f = $0 } END { if (f != "") print f }'
+}
+
 # ディレクトリの中でいちばん最近保存された Markdown
 newest_md() {
   find "$1" \( -name .git -o -name node_modules -o -name .venv \) -prune \
        -o -type f -name '*.md' -print0 2>/dev/null \
-    | stat_time_name | sort -rn | head -1 | cut -d' ' -f2-
+    | stat_time_name | pick_newest || true
 }
 
 # Spotlight で「家じゅうで直近に保存された Markdown」を引く。木を歩かないので速い
+# 該当が無いときは grep が 1 を返す。pipefail に拾わせると背景プロセスが即死するので握る
 newest_global() {
   mdfind 'kMDItemFSName == "*.md"c && kMDItemContentModificationDate >= $time.now(-1800)' 2>/dev/null \
     | grep -v -e '/\.' -e '/node_modules/' -e '/Library/' \
-    | tr '\n' '\0' | stat_time_name | sort -rn | head -1 | cut -d' ' -f2-
+    | tr '\n' '\0' | stat_time_name | pick_newest || true
 }
 
 # 背景で動く本体。保存された Markdown を追いかけて変換し続ける
 if [ "$daemon" -eq 1 ]; then
+  # 先に別のものが動いていたら黙って降りる（同時に叩かれた場合の取り合いを避ける）
+  if running_pid >/dev/null; then exit 0; fi
+  echo $$ > "$PIDFILE"
   trap 'rm -f "$PIDFILE"' EXIT
   use_spotlight=0
   command -v mdfind >/dev/null 2>&1 && use_spotlight=1
-  [ "$use_spotlight" -eq 0 ] && root="$sync_cwd"
+  if [ "$use_spotlight" -eq 0 ]; then root="$sync_cwd"; fi
 
   pick() {
     if [ "$use_spotlight" -eq 1 ]; then newest_global; else newest_md "$root"; fi
   }
 
+  # 変換の失敗は画面に出ないので、ログに残す
+  log() { printf '%s %s\n' "$(date '+%Y-%m-%d %H:%M:%S')" "$1" >> "$LOGFILE"; }
+
+  # Spotlight を使えない場合は木を歩く。大きな木では間隔を伸ばす
+  scan_gap=2
+  if [ "$use_spotlight" -eq 0 ]; then
+    t0="$(perl -MTime::HiRes=time -e 'printf "%d", time*1000')"
+    newest_md "$root" >/dev/null
+    t1="$(perl -MTime::HiRes=time -e 'printf "%d", time*1000')"
+    scan_gap=$(( ( (t1 - t0) * 5 + 999) / 1000 ))
+    [ "$scan_gap" -lt 2 ] && scan_gap=2
+    [ "$scan_gap" -gt 10 ] && scan_gap=10
+    log "watching $root every ${scan_gap}s (no Spotlight)"
+  fi
+
   src="$(pick)"
-  if [ -n "$src" ] && [ -f "$src" ]; then render || true; fi
+  if [ -n "$src" ] && [ -f "$src" ]; then render || log "render failed: $src"; fi
   last="$src $(fingerprint "$src") $(fingerprint "$HEAD")"
   # 開いているファイルの保存は毎秒見る。別ファイルへの切り替えの検出は2秒ごと
   tick=0
   while sleep 1; do
     tick=$(( tick + 1 ))
-    if [ $(( tick % 2 )) -eq 0 ]; then
+    if [ $(( tick % scan_gap )) -eq 0 ]; then
       cand="$(pick)"
-      [ -n "$cand" ] && src="$cand"
+      if [ -n "$cand" ]; then src="$cand"; fi
     fi
+    [ -n "$src" ] || continue
     [ -f "$src" ] || continue
     now="$src $(fingerprint "$src") $(fingerprint "$HEAD")"
     [ "$now" = "$last" ] && continue
     last="$now"
-    render || true
+    render || log "render failed: $src"
   done
   exit 0
 fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commte/mdbrowse",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "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",