# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later

# CATEGORY
#   14-miscellaneous
#
# SYNOPSIS
#   config-help [section]
#   config-help --html
#   config-help [section] --man
#   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. Section matching is case-insensitive. Pass --html / -w to open
#   the published documentation website (https://fish.rootiest.fyi/)
#   in the default browser via xdg-open — deep links to a section aren't
#   supported there, so if a keyword is given a note points you to the site's
#   search box instead. Pass --man / -m to open the compiled man page
#   (docs/fish-config.1) via `man -l`; if a section keyword is given, the
#   pager opens at the nearest match. Pass --help or -h for usage and the
#   navigation key reference.
#
# ARGUMENTS
#   section     Optional keyword to jump to a matching section heading
#   -w, --html  Open the published documentation website in the default browser
#   -m, --man   Open the compiled man page via man -l
#   -h, --help  Print usage and navigation reference, then exit
#
# EXIT STATUS
#   0  Manual displayed
#   1  Documentation file not found, or required tool not available
#
# RETURNS
#   With -h/--help, the usage and navigation reference, printed to stdout.
#   Otherwise, the manual is shown via the resolved pager (not captured stdout).
#
# EXAMPLE
#   config-help
#   config-help keybindings
#   config-help pkg
#   config-help fish-deps
#   config-help --html
#   config-help --man
#   config-help keys --man
#   config-help --help
#   config-help pkg --man
#
# NOTES
#   The preferred invocation is `help config [...]` — this function is
#   registered as a handler in the help wrapper so that syntax works
#   transparently. Direct `config-help` calls are also valid.
function config-help --description 'Open the offline fish shell configuration manual'
    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"
    set -l site_url "https://fish.rootiest.fyi/"

    # ── Extract section keyword (first non-flag argument) ────────
    set -l section_kw ""
    for arg in $argv
        if not string match -q -- '-*' $arg
            set section_kw $arg
            break
        end
    end

    # ── Resolve section keyword → heading text ───────────────────
    # Used by --html (anchor lookup), --man (search pattern), and the
    # pager fallback chain (line number). Runs once, shared by all paths.
    set -l found_text ""
    if test -n "$section_kw"
        set -l norm_kw (string lower -- $section_kw | string replace -ra '[^a-z0-9]' '')

        # 1. Index lookup (keyword aliases)
        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

        # 2. Normalized heading scan fallback
        if test -z "$found_text"; and test -f "$doc_file"
            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
    end

    # ── --html / -w ──────────────────────────────────────────────
    if contains -- --html $argv; or contains -- -w $argv
        if test -n "$section_kw"
            set_color yellow
            echo "note: deep links aren't available on the website — opening the site root; use its search box to find '$section_kw'" >&2
            set_color normal
        end

        if type -q xdg-open
            xdg-open "$site_url" &>/dev/null &
            disown
        else
            set_color red
            echo "error: no opener found — visit $site_url" >&2
            set_color normal
            return 1
        end
        return 0
    end

    # ── --man / -m ───────────────────────────────────────────────
    if contains -- --man $argv; or contains -- -m $argv
        if not test -f "$man_file"
            set_color red
            echo "error: man page not found at $man_file" >&2
            set_color normal
            return 1
        end
        if not type -q man
            set_color red
            echo "error: man not found — cannot open man page" >&2
            set_color normal
            return 1
        end
        if test -n "$found_text"
            # Strip Markdown heading markers to get the bare section name,
            # then pass it as a less search pattern. MANPAGER is overridden
            # here because the bat renderer does not support +/pattern jumps.
            set -l pattern (string replace -ra '^#+ *' '' -- $found_text | string trim)
            # Single-quote the +/pattern inside the MANPAGER string so the
            # shell doesn't word-split headings that contain spaces.
            env MANPAGER="less '+/$pattern'" man -l "$man_file"
        else if test -n "$section_kw"
            set_color yellow
            echo "note: no section matching '$section_kw' — opening at top" >&2
            set_color normal
            man -l "$man_file"
        else
            man -l "$man_file"
        end
        return 0
    end

    # ── --help / -h ──────────────────────────────────────────────
    if contains -- --help $argv; or contains -- -h $argv
        set_color --bold
        echo "help config / config-help"
        set_color normal
        echo " — view the offline fish shell configuration manual"
        echo ""
        set_color --bold brblue
        echo USAGE
        set_color normal
        echo "  help config "(set_color yellow)"[section]"(set_color normal)
        echo "  help config "(set_color yellow)"[section] --html"(set_color normal)
        echo "  help config "(set_color yellow)"[section] --man"(set_color normal)
        echo "  help config "(set_color yellow)"--help"(set_color normal)
        echo ""
        set_color --bold brblue
        echo ARGUMENTS
        set_color normal
        echo "  "(set_color yellow)"section"(set_color normal)"      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 "  "(set_color yellow)"-w, --html"(set_color normal)"   Open the published documentation website in the default browser."
        echo "               Deep links aren't supported — use the site's search box."
        echo "  "(set_color yellow)"-m, --man"(set_color normal)"    Open the compiled man page via man -l."
        echo "               If a section keyword is given, jumps to the nearest match."
        echo ""
        set_color --bold brblue
        echo EXAMPLES
        set_color normal
        echo "  "(set_color green)"help config"(set_color normal)"                       open at top"
        echo "  "(set_color green)"help config keybindings"(set_color normal)"           jump to Key Bindings section"
        echo "  "(set_color green)"help config pkg"(set_color normal)"                   jump to the pkg function entry"
        echo "  "(set_color green)"help config fish-deps"(set_color normal)"             jump to fish-deps"
        echo "  "(set_color green)"help config abbreviations"(set_color normal)"         jump to Abbreviations section"
        echo "  "(set_color green)"help config --html"(set_color normal)"                open the documentation website"
        echo "  "(set_color green)"help config --man"(set_color normal)"                 open compiled man page"
        echo "  "(set_color green)"help config pkg --man"(set_color normal)"             open man page at pkg section"
        echo ""
        set_color --bold brblue
        echo "NAVIGATION (ov pager)"
        set_color normal
        echo "  "(set_color cyan)"Space"(set_color normal)"       next section"
        echo "  "(set_color cyan)"^"(set_color normal)"           previous section"
        echo "  "(set_color cyan)"Alt+u"(set_color normal)"       toggle section list sidebar"
        echo "  "(set_color cyan)"/"(set_color normal)"           search forward"
        echo "  "(set_color cyan)"n"(set_color normal)" / "(set_color cyan)"N"(set_color normal)"       next / previous search match"
        echo "  "(set_color cyan)"g"(set_color normal)"           go to line number"
        echo "  "(set_color cyan)"q"(set_color normal)"           quit"
        echo ""
        set_color --bold brblue
        echo "PAGER FALLBACK CHAIN"
        set_color normal
        echo "  "(set_color brblack)"1."(set_color normal)" ov + bat   section nav + syntax highlighting  "(set_color brblack)"(best)"(set_color normal)
        echo "  "(set_color brblack)"2."(set_color normal)" ov alone   section nav, raw Markdown"
        echo "  "(set_color brblack)"3."(set_color normal)" bat alone  syntax highlighting, use / to search"
        echo "  "(set_color brblack)"4."(set_color normal)" man -l     pre-compiled man page (if available)"
        echo "  "(set_color brblack)"5."(set_color normal)" less       plain text with line-jump"
        echo "  "(set_color brblack)"6."(set_color normal)" cat        plain output"
        return 0
    end

    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 (for pager) ───────────────────
    # found_text is already resolved above; just need the line number.
    set -l start_line 1
    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 if test -n "$section_kw"
        set_color yellow
        echo "note: no section matching '$section_kw' — opening at top" >&2
        set_color normal
    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[2mNAVIGATION: [ 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