rootiest
cb4d74423a
- config_help --help / -h prints full usage, section keyword examples, ov navigation key reference, and the pager fallback chain. - Prepend a dim nav hint line to the ov input stream and pin it with --header 1 so "Space=next section ^=prev Alt+u=sections /=search q=quit" is always visible at the top of the screen.
200 lines
8.0 KiB
Fish
200 lines
8.0 KiB
Fish
# Copyright (C) 2026 Rootiest
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
# SYNOPSIS
|
|
# config_help [section]
|
|
# config_help --help
|
|
#
|
|
# DESCRIPTION
|
|
# Opens the offline fish shell configuration manual in the best available
|
|
# pager. Falls back through ov -> bat -> man -> less -> cat.
|
|
# If a section keyword is provided, the pager opens at the first heading
|
|
# that matches the keyword. Lookup order: docs/fish-config.index (exact
|
|
# keyword aliases), then a normalized heading scan as fallback.
|
|
# When opened with ov a sticky navigation hint is shown at the top of the
|
|
# screen. Pass --help or -h to print usage and navigation key reference.
|
|
#
|
|
# ARGUMENTS
|
|
# section Optional keyword to jump to a matching section heading
|
|
# --help Print usage and navigation reference, then exit
|
|
# -h Alias for --help
|
|
#
|
|
# RETURNS
|
|
# 0 Manual displayed (or --help printed)
|
|
# 1 Documentation file not found
|
|
#
|
|
# EXAMPLE
|
|
# config_help
|
|
# config_help keybindings
|
|
# config_help pkg
|
|
# config_help fish-deps
|
|
# config_help --help
|
|
function config_help --description 'Open the offline fish shell configuration manual'
|
|
# ── --help / -h ──────────────────────────────────────────────
|
|
if contains -- --help $argv; or contains -- -h $argv
|
|
echo "config_help — view the offline fish shell configuration manual"
|
|
echo ""
|
|
echo "USAGE"
|
|
echo " config_help [section]"
|
|
echo " config_help --help"
|
|
echo ""
|
|
echo "ARGUMENTS"
|
|
echo " section Optional keyword to jump to a matching section heading."
|
|
echo " Searches docs/fish-config.index for aliases first, then"
|
|
echo " falls back to a normalized (case- and punctuation-insensitive)"
|
|
echo " scan of heading lines."
|
|
echo ""
|
|
echo "EXAMPLES"
|
|
echo " config_help open at top"
|
|
echo " config_help keybindings jump to Key Bindings section"
|
|
echo " config_help pkg jump to the pkg function entry"
|
|
echo " config_help fish-deps jump to fish-deps"
|
|
echo " config_help abbreviations jump to Abbreviations section"
|
|
echo ""
|
|
echo "NAVIGATION (ov pager)"
|
|
echo " Space next section"
|
|
echo " ^ previous section"
|
|
echo " Alt+u toggle section list sidebar"
|
|
echo " / search forward"
|
|
echo " n / N next / previous search match"
|
|
echo " g go to line number"
|
|
echo " q quit"
|
|
echo ""
|
|
echo "PAGER FALLBACK CHAIN"
|
|
echo " 1. ov + bat section nav + syntax highlighting (best)"
|
|
echo " 2. ov alone section nav, raw Markdown"
|
|
echo " 3. bat alone syntax highlighting, use / to search"
|
|
echo " 4. man -l pre-compiled man page (if available)"
|
|
echo " 5. less plain text with line-jump"
|
|
echo " 6. cat plain output"
|
|
return 0
|
|
end
|
|
|
|
set -l doc_file "$__fish_config_dir/docs/fish-config.md"
|
|
set -l idx_file "$__fish_config_dir/docs/fish-config.index"
|
|
set -l man_file "$__fish_config_dir/docs/fish-config.1"
|
|
|
|
if not test -f "$doc_file"
|
|
set_color red
|
|
echo "error: documentation not found at $doc_file" >&2
|
|
set_color normal
|
|
return 1
|
|
end
|
|
|
|
# ── Resolve section start line ───────────────────────────────
|
|
# 1. Look up keyword in fish-config.index (keyword → exact heading text).
|
|
# 2. Fall back to normalized scan of heading lines if not in index.
|
|
# 3. Resolve start_line via grep -F on the heading text (immune to line
|
|
# number drift — only breaks if the heading itself is renamed).
|
|
set -l start_line 1
|
|
if test -n "$argv[1]"
|
|
set -l norm_kw (string lower -- $argv[1] | string replace -ra '[^a-z0-9]' '')
|
|
set -l found_text ""
|
|
|
|
# ── Index lookup ─────────────────────────────────────────
|
|
if test -f "$idx_file"
|
|
while read -l idxline
|
|
string match -qr '^[[:space:]]*(#|$)' -- $idxline; and continue
|
|
set -l kv (string split -m 1 '=' -- $idxline)
|
|
test (count $kv) -lt 2; and continue
|
|
set -l k (string lower -- $kv[1] | string replace -ra '[^a-z0-9]' '')
|
|
if test "$k" = "$norm_kw"
|
|
set found_text $kv[2]
|
|
break
|
|
end
|
|
end < "$idx_file"
|
|
end
|
|
|
|
# ── Normalized scan fallback ─────────────────────────────
|
|
if test -z "$found_text"
|
|
for entry in (grep -n "^#" "$doc_file")
|
|
set -l parts (string split -m 1 ':' -- $entry)
|
|
set -l text $parts[2]
|
|
set -l norm_text (string lower -- $text | string replace -ra '[^a-z0-9]' '')
|
|
if string match -q "*$norm_kw*" $norm_text
|
|
set found_text $text
|
|
break
|
|
end
|
|
end
|
|
end
|
|
|
|
if test -n "$found_text"
|
|
set -l lnum (grep -Fn "$found_text" "$doc_file" | cut -d: -f1 | head -1)
|
|
if test -n "$lnum"
|
|
set start_line $lnum
|
|
end
|
|
else
|
|
set_color yellow
|
|
echo "note: no section matching '$argv[1]' — opening at top" >&2
|
|
set_color normal
|
|
end
|
|
end
|
|
|
|
# ── Navigation hint line ─────────────────────────────────────
|
|
# Prepended to the ov input stream and pinned via --header 1 so it
|
|
# remains visible at the top of the screen at all times.
|
|
set -l nav_hint \
|
|
" \033[2m[ Space=next section ^=prev Alt+u=sections /=search q=quit ]\033[0m"
|
|
|
|
# ── Viewer fallback chain ────────────────────────────────────
|
|
# When jumping to a section, slice the file from start_line so ov
|
|
# opens with that section at the top without needing --pattern.
|
|
# (--section-header pins delimiter lines as sticky headers, removing
|
|
# them from pattern-search scope — tail-slice sidesteps this entirely.)
|
|
if type -q ov; and type -q bat
|
|
set -l ov_args \
|
|
--header 1 \
|
|
--section-delimiter "^#" \
|
|
--section-header
|
|
if test $start_line -gt 1
|
|
begin
|
|
printf "$nav_hint\n"
|
|
bat --color=always --style=plain --language=markdown "$doc_file" \
|
|
| tail -n +$start_line
|
|
end | ov $ov_args
|
|
else
|
|
begin
|
|
printf "$nav_hint\n"
|
|
bat --color=always --style=plain --language=markdown "$doc_file"
|
|
end | ov $ov_args
|
|
end
|
|
|
|
# ov alone: section navigation on raw Markdown; no code highlighting.
|
|
else if type -q ov
|
|
set -l ov_args \
|
|
--header 1 \
|
|
--section-delimiter "^#" \
|
|
--section-header
|
|
if test $start_line -gt 1
|
|
begin
|
|
printf "$nav_hint\n"
|
|
tail -n +$start_line "$doc_file"
|
|
end | ov $ov_args
|
|
else
|
|
begin
|
|
printf "$nav_hint\n"
|
|
cat "$doc_file"
|
|
end | ov $ov_args
|
|
end
|
|
|
|
# bat alone: syntax highlighting with built-in paging; no line jump.
|
|
else if type -q bat
|
|
if test $start_line -gt 1
|
|
set_color brblack
|
|
echo "note: bat pager — use / to search for your section" >&2
|
|
set_color normal
|
|
end
|
|
bat --language=markdown --paging=always "$doc_file"
|
|
|
|
# Pre-compiled man page (generated by CI after merge).
|
|
else if test -f "$man_file"
|
|
man -l "$man_file"
|
|
|
|
else if type -q less
|
|
less +"$start_line" "$doc_file"
|
|
|
|
else
|
|
cat "$doc_file"
|
|
end
|
|
end
|