feat: add tmpdir step test option by thejcannon · Pull Request #663 · jdx/hk

thejcannon · 2026-02-04T15:06:53Z

A few things are kind broken right now in the "half-in-half-out" world of deducing the sandbox from {{tmp}}:

Paths are passed absolutely, which breaks the default file filtering
- Arguably this may be broken in hk itself, but I'm not here to argue that
Paths are also given to the tool absolutely, when in almost every invocation of hk they are passed relatively

This also unlocks some other features like adding a tera expectation (which is good for testing the globs)

Ideally, we'd phase out {{tmp}} and remove it. @jdx LMK what you think about that

gemini-code-assist · 2026-02-04T15:07:09Z

Summary of Changes

Hello @thejcannon, I'm Gemini Code Assist¹! 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 enhances the StepTest functionality by introducing a new tmpdir option, providing explicit control over whether tests execute within a temporary directory sandbox or the project's root. This change resolves existing issues with path handling when {{tmp}} is used and offers greater flexibility for defining test environments, while also enabling future features like tera expectations.

Highlights

New tmpdir Option for StepTest: A tmpdir boolean option has been introduced in the StepTest configuration (both Pkl and Rust struct) to explicitly control whether a test runs in a temporary directory sandbox.
Explicit Sandbox Control: Users can now explicitly force a test to run in a temporary directory (tmpdir = true) or the repository root (tmpdir = false), overriding the previous auto-detection logic based on {{tmp}} usage.
Improved Sandbox Logic: The test runner's sandbox detection logic has been updated to prioritize the explicit tmpdir setting. If tmpdir is not specified, it falls back to auto-detection based on whether files reference {{tmp}}.
New Test Coverage: New bats tests have been added to thoroughly verify the behavior of the tmpdir option, covering scenarios where it's explicitly set to true, false, and when it defaults based on {{tmp}} usage.

Changelog

pkl/Config.pkl
- Added a new tmpdir: Boolean? property to the StepTest class, allowing configuration of temporary directory usage.
src/step_test.rs
- Introduced pub tmpdir: Option<bool> to the StepTest struct, mirroring the Pkl configuration.
src/test_runner.rs
- Modified the run_test_named function to incorporate the new tmpdir option, using it to determine if a sandbox should be used, with a fallback to the existing {{tmp}} auto-detection.
test/hk_test_tmpdir.bats
- Added a new test file containing several bats tests to validate the correct behavior of the tmpdir option under various scenarios.

Activity

The author thejcannon has introduced a new feature to enhance test configuration flexibility.
The PR description indicates a potential future discussion with @jdx regarding the deprecation of {{tmp}}.

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.

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. ↩

gemini-code-assist

Code Review

This pull request introduces a tmpdir option for step tests, allowing explicit control over whether a test runs in a sandboxed temporary directory or the repository root. The changes are well-implemented across the Pkl configuration and Rust source code, and the new logic correctly handles the new option. The added tests cover the new functionality well. I've included one suggestion to improve the clarity and robustness of the new tests.

@matdibu

### 🚀 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 tags instead of 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)  --- > [!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. > > 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).  Co-authored-by: mise-en-dev <123107610+mise-en-dev@users.noreply.github.com>

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 tags instead of 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. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

feat: add tmpdir step test option

dc01e9c

gemini-code-assist Bot reviewed Feb 4, 2026

View reviewed changes

Comment thread test/hk_test_tmpdir.bats

assert_failure

f6f9f11

jdx merged commit c0ddb06 into jdx:main Feb 4, 2026
16 checks passed

jdx mentioned this pull request Feb 4, 2026

chore: release v1.36.0 #657

Merged

thejcannon deleted the jcannon/tmpdir-options branch February 4, 2026 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add tmpdir step test option#663

feat: add tmpdir step test option#663
jdx merged 2 commits intojdx:mainfrom
thejcannon:jcannon/tmpdir-options

thejcannon commented Feb 4, 2026

Uh oh!

gemini-code-assist Bot commented Feb 4, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

thejcannon commented Feb 4, 2026

Uh oh!

gemini-code-assist Bot commented Feb 4, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants