fix(docs): escape angle brackets in --pr flag description#666
Merged
Conversation
The `<default-branch>` in the --pr flag's help text was being rendered as HTML in the generated markdown docs, causing Vue's template parser to fail with a SyntaxError during the Vitepress build. Changed to `DEFAULT_BRANCH` to avoid HTML interpretation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
Summary of ChangesHello @jdx, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a documentation build failure in the release workflow. The issue arose because angle brackets in the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Contributor
There was a problem hiding this comment.
Code Review
This pull request addresses a documentation build failure by changing <default-branch> to DEFAULT_BRANCH in a help string to prevent it from being parsed as HTML. The fix is correct, but I've suggested an alternative approach using backticks to preserve the conventional placeholder format, which improves clarity while still resolving the build issue.
| #[clap(long, overrides_with = "stage")] | ||
| pub no_stage: bool, | ||
| /// Check only files changed in the current PR/branch (shortcut for --from-ref <default-branch> --to-ref HEAD) | ||
| /// Check only files changed in the current PR/branch (shortcut for --from-ref DEFAULT_BRANCH --to-ref HEAD) |
Contributor
There was a problem hiding this comment.
While using DEFAULT_BRANCH fixes the build issue, it's less conventional for a placeholder in command-line help text, where <...> is a common pattern. To maintain this convention and improve clarity for users, you can wrap <default-branch> in backticks. This will treat it as a code snippet, preventing it from being interpreted as an HTML tag by the documentation generator.
Suggested change
| /// Check only files changed in the current PR/branch (shortcut for --from-ref DEFAULT_BRANCH --to-ref HEAD) | |
| /// Check only files changed in the current PR/branch (shortcut for --from-ref `<default-branch>` --to-ref HEAD) |
Merged
jdx
added a commit
that referenced
this pull request
Feb 9, 2026
### 🚀 Features - **(cmake_format)** init by [@matdibu](https://github.com/matdibu) in [#672](#672) - **(deadnix)** init by [@matdibu](https://github.com/matdibu) in [#670](#670) - **(hclfmt)** init by [@matdibu](https://github.com/matdibu) in [#675](#675) - **(nil)** init by [@matdibu](https://github.com/matdibu) in [#669](#669) - **(nixf_diagnose)** init by [@matdibu](https://github.com/matdibu) in [#671](#671) - **(ruff_format)** use `--quiet` by [@matdibu](https://github.com/matdibu) in [#667](#667) - **(tombi)** use `--quiet` by [@matdibu](https://github.com/matdibu) in [#676](#676) - add ty builtin by [@joonas](https://github.com/joonas) in [#566](#566) - add --pr shortcut flag for checking PR-changed files by [@jdx](https://github.com/jdx) in [#660](#660) - add tmpdir step test option by [@thejcannon](https://github.com/thejcannon) in [#663](#663) ### 🐛 Bug Fixes - **(bultins)** respect typos exclusions with --force-exclude by [@CallumKerson](https://github.com/CallumKerson) in [#659](#659) - **(docs)** escape angle brackets in --pr flag description by [@jdx](https://github.com/jdx) in [#666](#666) - **(docs)** use valid <br> tags instead of </br> in sea shanty by [@jdx](https://github.com/jdx) in [12e17f8](12e17f8) - **(go_fumpt)** comment out broken check by [@matdibu](https://github.com/matdibu) in [#668](#668) - **(yamllint)** enable strict mode by [@matdibu](https://github.com/matdibu) in [#673](#673) - respect ignore when recursing by [@thejcannon](https://github.com/thejcannon) in [#661](#661) - Deduplicate files in check-case-conflict to prevent false positives by [@safinn](https://github.com/safinn) in [#678](#678) - Fix building of nix flake wiwth the inclusion of git subomdules by [@jeffutter](https://github.com/jeffutter) in [#681](#681) ### 🛡️ Security - add tone calibration to release notes prompt by [@jdx](https://github.com/jdx) in [#679](#679) - add opengraph meta tags by [@jdx](https://github.com/jdx) in [#685](#685) ### 📦️ Dependency Updates - lock file maintenance by [@renovate[bot]](https://github.com/renovate[bot]) in [#658](#658) - update anthropics/claude-code-action digest to b113f49 by [@renovate[bot]](https://github.com/renovate[bot]) in [#684](#684) - update actions/checkout digest to de0fac2 by [@renovate[bot]](https://github.com/renovate[bot]) in [#683](#683) ### New Contributors - @jeffutter made their first contribution in [#681](#681) - @matdibu made their first contribution in [#673](#673) - @safinn made their first contribution in [#678](#678) - @CallumKerson made their first contribution in [#659](#659) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Mostly release bookkeeping, but the `Cargo.lock` refresh pulls in multiple dependency version changes that could affect build/runtime behavior. > > **Overview** > Updates the project release to **v1.36.0** by bumping version strings across `Cargo.toml`, `hk.usage.kdl`, generated CLI docs/metadata, and example PKL configuration URLs. > > Adds the `1.36.0` section to `CHANGELOG.md` and refreshes generated CLI documentation to include the `--pr` shortcut flag description for `check`/`fix`/`run`. > > Refreshes `Cargo.lock` with dependency updates (including several transitive additions/removals) and updates the Pkl error hint in `src/config.rs` to reference the new release URL. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 7925e85. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: mise-en-dev <123107610+mise-en-dev@users.noreply.github.com>
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Feb 9, 2026
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [hk](https://github.com/jdx/hk) | minor | `1.35.0` → `1.36.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jdx/hk (hk)</summary> ### [`v1.36.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1360---2026-02-09) [Compare Source](jdx/hk@v1.35.0...v1.36.0) ##### 🚀 Features - **(cmake\_format)** init by [@​matdibu](https://github.com/matdibu) in [#​672](jdx/hk#672) - **(deadnix)** init by [@​matdibu](https://github.com/matdibu) in [#​670](jdx/hk#670) - **(hclfmt)** init by [@​matdibu](https://github.com/matdibu) in [#​675](jdx/hk#675) - **(nil)** init by [@​matdibu](https://github.com/matdibu) in [#​669](jdx/hk#669) - **(nixf\_diagnose)** init by [@​matdibu](https://github.com/matdibu) in [#​671](jdx/hk#671) - **(ruff\_format)** use `--quiet` by [@​matdibu](https://github.com/matdibu) in [#​667](jdx/hk#667) - **(tombi)** use `--quiet` by [@​matdibu](https://github.com/matdibu) in [#​676](jdx/hk#676) - add ty builtin by [@​joonas](https://github.com/joonas) in [#​566](jdx/hk#566) - add --pr shortcut flag for checking MR-changed files by [@​jdx](https://github.com/jdx) in [#​660](jdx/hk#660) - add tmpdir step test option by [@​thejcannon](https://github.com/thejcannon) in [#​663](jdx/hk#663) ##### 🐛 Bug Fixes - **(bultins)** respect typos exclusions with --force-exclude by [@​CallumKerson](https://github.com/CallumKerson) in [#​659](jdx/hk#659) - **(docs)** escape angle brackets in --pr flag description by [@​jdx](https://github.com/jdx) in [#​666](jdx/hk#666) - **(docs)** use valid <br> tags instead of </br> in sea shanty by [@​jdx](https://github.com/jdx) in [12e17f8](jdx/hk@12e17f8) - **(go\_fumpt)** comment out broken check by [@​matdibu](https://github.com/matdibu) in [#​668](jdx/hk#668) - **(yamllint)** enable strict mode by [@​matdibu](https://github.com/matdibu) in [#​673](jdx/hk#673) - respect ignore when recursing by [@​thejcannon](https://github.com/thejcannon) in [#​661](jdx/hk#661) - Deduplicate files in check-case-conflict to prevent false positives by [@​safinn](https://github.com/safinn) in [#​678](jdx/hk#678) - Fix building of nix flake wiwth the inclusion of git subomdules by [@​jeffutter](https://github.com/jeffutter) in [#​681](jdx/hk#681) ##### 🛡️ Security - add tone calibration to release notes prompt by [@​jdx](https://github.com/jdx) in [#​679](jdx/hk#679) - add opengraph meta tags by [@​jdx](https://github.com/jdx) in [#​685](jdx/hk#685) ##### 🔍 Other Changes - Use tmpdir for the tests by [@​thejcannon](https://github.com/thejcannon) in [#​677](jdx/hk#677) ##### 📦️ Dependency Updates - lock file maintenance by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​658](jdx/hk#658) - update anthropics/claude-code-action digest to [`b113f49`](jdx/hk@b113f49) by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​684](jdx/hk#684) - update actions/checkout digest to [`de0fac2`](jdx/hk@de0fac2) by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​683](jdx/hk#683) ##### New Contributors - [@​jeffutter](https://github.com/jeffutter) made their first contribution in [#​681](jdx/hk#681) - [@​matdibu](https://github.com/matdibu) made their first contribution in [#​673](jdx/hk#673) - [@​safinn](https://github.com/safinn) made their first contribution in [#​678](jdx/hk#678) - [@​CallumKerson](https://github.com/CallumKerson) made their first contribution in [#​659](jdx/hk#659) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi45Ni4wIiwidXBkYXRlZEluVmVyIjoiNDIuOTYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6Om1pbm9yIl19-->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<default-branch>in the--prflag's help text was being rendered as HTML in the generated markdown docsDEFAULT_BRANCHto avoid HTML interpretationFixes the docs build failure in the release workflow: https://github.com/jdx/hk/actions/runs/21681540416/job/62517092359
Test plan
🤖 Generated with Claude Code
Note
Low Risk
Low risk: changes only a CLI help string and does not affect runtime behavior or hook execution logic.
Overview
Updates the
--prflag help text insrc/hook_options.rsto replace the<default-branch>placeholder withDEFAULT_BRANCH, preventing angle brackets from being interpreted as HTML in generated docs and avoiding downstream docs build failures.Written by Cursor Bugbot for commit deb0353. This will update automatically on new commits. Configure here.