Skip to content

Comments

feat: add check_symlinks builtin#326

Merged
jdx merged 3 commits intomainfrom
feat/util-check-symlinks
Oct 3, 2025
Merged

feat: add check_symlinks builtin#326
jdx merged 3 commits intomainfrom
feat/util-check-symlinks

Conversation

@jdx
Copy link
Owner

@jdx jdx commented Oct 3, 2025

Summary

  • Adds hk util check-symlinks command to detect broken symlinks
  • Checks for symlinks pointing to non-existent targets
  • Works with both file and directory symlinks
  • Includes 6 unit tests and 7 bats integration tests

Test plan

  • All 241 tests passing
  • CI green
  • Builtin integration tested

🤖 Generated with Claude Code


Note

Introduce hk util check-symlinks and Builtins.check_symlinks to detect broken symlinks, with docs and tests.

  • CLI:
    • Add hk util check-symlinks subcommand in src/cli/util/check_symlinks.rs and register it in src/cli/util/mod.rs.
  • Builtins:
    • Introduce pkl/builtins/check_symlinks.pkl and export Builtins.check_symlinks in pkl/Builtins.pkl.
  • Docs:
    • Document check_symlinks in docs/cli/util.md (usage, features, examples) and add builtin entry in docs/builtins.md.
  • Tests:
    • Add Rust unit tests in check_symlinks.rs and Bats integration tests in test/util_check_symlinks.bats.

Written by Cursor Bugbot for commit 17b0fbe. This will update automatically on new commits. Configure here.

Detects broken symlinks (symlinks that point to non-existent targets).
Useful for catching broken links before deployment.

Includes:
- `hk util check-symlinks` command
- 6 unit tests
- 7 bats integration tests
- Builtin configuration in pkl/builtins/
- Documentation updates

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@jdx jdx force-pushed the feat/util-check-symlinks branch from 0f60188 to 744a749 Compare October 3, 2025 15:50
@jdx jdx enabled auto-merge (squash) October 3, 2025 15:58
@jdx jdx merged commit a0fcb5a into main Oct 3, 2025
6 checks passed
@jdx jdx deleted the feat/util-check-symlinks branch October 3, 2025 15:59
@jdx jdx mentioned this pull request Oct 3, 2025
jdx added a commit that referenced this pull request Oct 5, 2025
## [1.17.0](https://github.com/jdx/hk/compare/v1.16.0..v1.17.0) -
2025-10-05

### 🚀 Features

- Add hk util trailing-whitespace command by
[@jdx](https://github.com/jdx) in
[#319](#319)
- add mixed_line_ending builtin by [@jdx](https://github.com/jdx) in
[#324](#324)
- add check_symlinks builtin by [@jdx](https://github.com/jdx) in
[#326](#326)
- add check_executables_have_shebangs builtin by
[@jdx](https://github.com/jdx) in
[#325](#325)
- Add check-merge-conflict util command and builtin by
[@jdx](https://github.com/jdx) in
[#322](#322)
- add check_case_conflict builtin by [@jdx](https://github.com/jdx) in
[#323](#323)
- add detect_private_key builtin by [@jdx](https://github.com/jdx) in
[#332](#332)
- add check_added_large_files builtin by [@jdx](https://github.com/jdx)
in [#329](#329)
- add python_debug_statements builtin by [@jdx](https://github.com/jdx)
in [#331](#331)
- add python_check_ast builtin by [@jdx](https://github.com/jdx) in
[#330](#330)
- add no_commit_to_branch builtin by [@jdx](https://github.com/jdx) in
[#333](#333)
- add check_byte_order_marker and fix_byte_order_marker builtins by
[@jdx](https://github.com/jdx) in
[#328](#328)
- add regex pattern support for glob and exclude by
[@jdx](https://github.com/jdx) in
[#336](#336)
- automatically batch large file lists to prevent ARG_MAX errors by
[@jdx](https://github.com/jdx) in
[#338](#338)

### 🐛 Bug Fixes

- Add validation for stage attribute requiring fix command by
[@jdx](https://github.com/jdx) in
[#327](#327)
- display stderr when check_list_files returns empty list by
[@jdx](https://github.com/jdx) in
[#334](#334)
- added new builtins to Builtins.pkl by [@jdx](https://github.com/jdx)
in
[b8a2b17](b8a2b17)
- enable experimental settings in mise.toml for swift support by
[@jdx](https://github.com/jdx) in
[#342](#342)
- correct airflow migration test to expect local imports by
[@jdx](https://github.com/jdx) in
[#343](#343)
- make final CI check always run and fail if dependencies fail by
[@jdx](https://github.com/jdx) in
[#344](#344)
- add ruff format to ruff builtin by [@jdx](https://github.com/jdx) in
[#340](#340)

### 🚜 Refactor

- Split util module into separate files by
[@jdx](https://github.com/jdx) in
[#321](#321)

### 🛡️ Security

- migrate pre-commit by [@jdx](https://github.com/jdx) in
[#318](#318)

### 🔍 Other Changes

- split CI runs into parallel jobs and add docs-sync mise task by
[@jdx](https://github.com/jdx) in
[#337](#337)
- remove v0 pkl files from docs/public by [@jdx](https://github.com/jdx)
in [#341](#341)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Release 1.17.0 with new migrate command, many util subcommands,
refreshed docs, and dependency updates.
> 
> - **Version**: bump `hk` to `1.17.0` (Cargo.toml, usage specs, docs).
> - **CLI**:
> - **New Command**: `migrate pre-commit` with flags (`--config`,
`--output`, `--force`, `--hk-pkl-root`).
> - **Util Subcommands**: add `check-added-large-files`,
`check-byte-order-marker`, `fix-byte-order-marker`,
`check-case-conflict`, `check-executables-have-shebangs`,
`check-merge-conflict`, `check-symlinks`, `detect-private-key`,
`end-of-file-fixer`, `mixed-line-ending`, `no-commit-to-branch`,
`python-check-ast`, `python-debug-statements`, `trailing-whitespace`.
> - **Docs**:
> - Update `docs/cli/index.md`, regenerate `docs/cli/commands.json`, and
`hk.usage.kdl`.
>   - Split `util` docs into per-command pages and add `migrate` docs.
> - **Dependencies**: update `Cargo.lock` crate versions and set `hk`
crate version to `1.17.0`.
> - **Changelog**: add `CHANGELOG.md` entry for `1.17.0` with
features/bug fixes.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
75b972a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: mise-en-dev <[email protected]>
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