rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(config-help): add --html and --man flags; add config-update function #36

Merged
rootiest merged 1 commits from feat/config-help-flags-and-updater into main 2026-06-08 19:30:53 +00:00
Conversation 0 Commits 1 Files Changed 4
+367 -15
rootiest commented 2026-06-08 19:28:14 +00:00
Owner
Copy Link
Copy Source

Summary

  • config-help --html / -w: opens docs/html/index.html in the default browser using smart browser detection — queries the x-scheme-handler/https MIME entry via xdg-mime to find the real browser binary, falls back through known binaries (firefox, chromium, vivaldi, etc.), then xdg-open as last resort. Bypasses xdg-open's text/html MIME lookup which could route to non-browser apps (e.g. ebook readers).
  • config-help --man / -m: opens the compiled docs/fish-config.1 man page directly via man -l, skipping the pager fallback chain.
  • config-update: new function that pulls the latest config from the hard-coded upstream URL (https://git.rootiest.dev/rootiest/fish-config.git) without requiring a configured git remote. Git output is suppressed; colored messages report fetch/merge status. Supports --dry-run (preview only) and --force (auto-stash local changes).
  • README: updated Offline Documentation table and added a new "Updating the Config" section.

Manual Verification

  • config-help --help shows --html and --man in USAGE, ARGUMENTS, and EXAMPLES
  • config-help --html prints "Opening HTML docs in <browser>…" and opens docs/html/index.html in a web browser (not an ebook reader)
  • config-help --man opens the fish-config man page in the terminal
  • config-help --man prints an error if docs/fish-config.1 is missing
  • config-update --dry-run fetches upstream and reports commits available without modifying anything
  • config-update (when already up to date) prints "✓ Already up to date."
  • config-update --force on a dirty tree stashes, pulls, and restores the stash
  • config-update on a dirty tree (without --force) warns and exits cleanly
## Summary - **`config-help --html` / `-w`**: opens `docs/html/index.html` in the default browser using smart browser detection — queries the `x-scheme-handler/https` MIME entry via `xdg-mime` to find the real browser binary, falls back through known binaries (firefox, chromium, vivaldi, etc.), then `xdg-open` as last resort. Bypasses `xdg-open`'s `text/html` MIME lookup which could route to non-browser apps (e.g. ebook readers). - **`config-help --man` / `-m`**: opens the compiled `docs/fish-config.1` man page directly via `man -l`, skipping the pager fallback chain. - **`config-update`**: new function that pulls the latest config from the hard-coded upstream URL (`https://git.rootiest.dev/rootiest/fish-config.git`) without requiring a configured git remote. Git output is suppressed; colored messages report fetch/merge status. Supports `--dry-run` (preview only) and `--force` (auto-stash local changes). - **README**: updated Offline Documentation table and added a new "Updating the Config" section. ## Manual Verification - [x] `config-help --help` shows `--html` and `--man` in USAGE, ARGUMENTS, and EXAMPLES - [x] `config-help --html` prints "Opening HTML docs in \<browser\>…" and opens `docs/html/index.html` in a web browser (not an ebook reader) - [x] `config-help --man` opens the fish-config man page in the terminal - [x] `config-help --man` prints an error if `docs/fish-config.1` is missing - [x] `config-update --dry-run` fetches upstream and reports commits available without modifying anything - [x] `config-update` (when already up to date) prints "✓ Already up to date." - [x] `config-update --force` on a dirty tree stashes, pulls, and restores the stash - [x] `config-update` on a dirty tree (without `--force`) warns and exits cleanly
rootiest added 1 commit 2026-06-08 19:30:04 +00:00
feat(config-help): add --html and --man flags; add config-update function de07040c16 
config-help gains two new flags:
- --html / -w: opens docs/html/index.html in the default browser using
  smart browser detection (xdg-mime https scheme handler → known binaries
  → xdg-open fallback) to avoid MIME-type mismatches with non-browser apps
- --man / -m: opens the compiled docs/fish-config.1 man page via man -l

config-update is a new function that pulls the latest fish config from the
hard-coded upstream URL without requiring a configured git remote. Suppresses
git output and reports status with colored messages. Supports --dry-run and
--force flags.

README updated to document all new commands.
rootiest force-pushed feat/config-help-flags-and-updater from 278dc6571c to de07040c16 2026-06-08 19:30:04 +00:00 Compare
rootiest merged commit bf2ad2f1e7 into main 2026-06-08 19:30:53 +00:00
rootiest deleted branch feat/config-help-flags-and-updater 2026-06-08 19:30:53 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
rootiest (Rootiest)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rootiest/fish-config#36