Skip to content

fix: respect ignore when recursing#661

Merged
jdx merged 5 commits intojdx:mainfrom
thejcannon:jcannon/walk-ignore
Feb 4, 2026
Merged

fix: respect ignore when recursing#661
jdx merged 5 commits intojdx:mainfrom
thejcannon:jcannon/walk-ignore

Conversation

@thejcannon
Copy link
Copy Markdown
Contributor

Fixes #629 by using the ignore crate for directory recursing

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @thejcannon, 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 resolves a reported issue where hk was not respecting .gitignore rules during directory traversal. By integrating the ignore crate, the file scanning mechanism now accurately excludes ignored files and directories, including .git folders, from processing. This enhancement ensures more predictable and correct file operations within the hk tool.

Highlights

  • Dependency Update: The ignore crate has been added to Cargo.toml and Cargo.lock to provide robust .gitignore parsing and file traversal capabilities.
  • Refactored File Traversal: The all_files_in_dir function in src/hook.rs has been refactored to use ignore::WalkBuilder. This change ensures that directory recursion correctly respects .gitignore rules and explicitly skips .git directories, while still allowing other dotfiles.
  • New Integration Tests: A new test file, test/dir_traversal.bats, has been added. It includes tests to verify that hk check correctly ignores files and directories specified in .gitignore and that the .git directory is always excluded from processing.
Changelog
  • Cargo.lock
    • Added ignore crate to dependencies.
  • Cargo.toml
    • Added ignore = "0.4" dependency.
  • src/hook.rs
    • Replaced custom directory traversal logic in all_files_in_dir with ignore::WalkBuilder.
    • Configured WalkBuilder to allow hidden files but explicitly skip .git directories.
  • test/dir_traversal.bats
    • Added new BATS test file.
    • Included tests to verify that hk check correctly ignores files and directories listed in .gitignore.
    • Added a test to confirm that the .git directory is always ignored.
Activity
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly switches to the ignore crate for directory traversal to respect .gitignore files, addressing the issue described. The new tests adequately verify this change. I've provided a couple of suggestions for src/hook.rs to simplify the code, improve error handling, and enhance performance.

Comment thread src/hook.rs Outdated
Comment thread src/hook.rs Outdated
@jdx
Copy link
Copy Markdown
Owner

jdx commented Feb 4, 2026

I think this is a good default, but it needs to be configurable

@thejcannon
Copy link
Copy Markdown
Contributor Author

@jdx added the option!

@jdx jdx merged commit b24584b into jdx:main Feb 4, 2026
16 checks passed
@jdx jdx mentioned this pull request Feb 4, 2026
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 [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;672](jdx/hk#672)
- **(deadnix)** init by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;670](jdx/hk#670)
- **(hclfmt)** init by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;675](jdx/hk#675)
- **(nil)** init by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;669](jdx/hk#669)
- **(nixf\_diagnose)** init by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;671](jdx/hk#671)
- **(ruff\_format)** use `--quiet` by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;667](jdx/hk#667)
- **(tombi)** use `--quiet` by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;676](jdx/hk#676)
- add ty builtin by [@&#8203;joonas](https://github.com/joonas) in [#&#8203;566](jdx/hk#566)
- add --pr shortcut flag for checking MR-changed files by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;660](jdx/hk#660)
- add tmpdir step test option by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;663](jdx/hk#663)

##### 🐛 Bug Fixes

- **(bultins)** respect typos exclusions with --force-exclude by [@&#8203;CallumKerson](https://github.com/CallumKerson) in [#&#8203;659](jdx/hk#659)
- **(docs)** escape angle brackets in --pr flag description by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;666](jdx/hk#666)
- **(docs)** use valid <br> tags instead of </br> in sea shanty by [@&#8203;jdx](https://github.com/jdx) in [12e17f8](jdx/hk@12e17f8)
- **(go\_fumpt)** comment out broken check by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;668](jdx/hk#668)
- **(yamllint)** enable strict mode by [@&#8203;matdibu](https://github.com/matdibu) in [#&#8203;673](jdx/hk#673)
- respect ignore when recursing by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;661](jdx/hk#661)
- Deduplicate files in check-case-conflict to prevent false positives by [@&#8203;safinn](https://github.com/safinn) in [#&#8203;678](jdx/hk#678)
- Fix building of nix flake wiwth the inclusion of git subomdules by [@&#8203;jeffutter](https://github.com/jeffutter) in [#&#8203;681](jdx/hk#681)

##### 🛡️ Security

- add tone calibration to release notes prompt by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;679](jdx/hk#679)
- add opengraph meta tags by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;685](jdx/hk#685)

##### 🔍 Other Changes

- Use tmpdir for the tests by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;677](jdx/hk#677)

##### 📦️ Dependency Updates

- lock file maintenance by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;658](jdx/hk#658)
- update anthropics/claude-code-action digest to [`b113f49`](jdx/hk@b113f49) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;684](jdx/hk#684)
- update actions/checkout digest to [`de0fac2`](jdx/hk@de0fac2) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;683](jdx/hk#683)

##### New Contributors

- [@&#8203;jeffutter](https://github.com/jeffutter) made their first contribution in [#&#8203;681](jdx/hk#681)
- [@&#8203;matdibu](https://github.com/matdibu) made their first contribution in [#&#8203;673](jdx/hk#673)
- [@&#8203;safinn](https://github.com/safinn) made their first contribution in [#&#8203;678](jdx/hk#678)
- [@&#8203;CallumKerson](https://github.com/CallumKerson) made their first contribution in [#&#8203;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-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants