Explain what prek does in README - #2507
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README “About” blurb to explain what prek does in plain terms, without assuming prior familiarity with pre-commit, while still positioning prek as a compatible Rust-based alternative.
Changes:
- Rewrites the description to explain hooks, when they run (commit/on-demand/CI), and what they can do.
- Adds a short bridge for readers familiar with
pre-commit, emphasizing single-binary distribution and compatibility.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+24
to
+26
| prek is a framework for running hooks on your code. It runs them before you commit changes, on demand, or in CI. | ||
| These hooks can format files, catch lint errors, detect secrets, or run any other command your project defines. | ||
| prek also installs and manages the tools and dependencies they need. |
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Aug 11, 2026
This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [prek](https://github.com/j178/prek) | tools | patch | `0.4.10` → `0.4.13` | 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>j178/prek (prek)</summary> ### [`v0.4.13`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0413) [Compare Source](j178/prek@v0.4.12...v0.4.13) Released on 2026-08-10. ##### Highlights ##### Manage hook tools with mise The new `language: mise` support lets hooks install tools using [`mise`](https://mise.jdx.dev/) in an isolated environment: ```yaml repos: - repo: local hooks: - id: golangci-lint name: golangci-lint language: mise additional_dependencies: ["aqua:golangci/golangci-lint@2"] entry: golangci-lint run --fast-only ./... pass_filenames: false ``` ##### Run commands in hook environments The new `prek exec` subcommand can run an explicit command in a configured hook's prepared environment. For example, the hook above makes its managed binary available to this command: ```console $ prek exec golangci-lint -- golangci-lint --version ``` ##### Enhancements - Add `mise` language support ([#​2540](j178/prek#2540)) - Add `deny-filename-pattern` and `require-filename-pattern` hooks ([#​2488](j178/prek#2488)) - Add `prek exec` for running commands in a hook environment ([#​2478](j178/prek#2478)) - Add `yaml-language-server:` comment to YAML sample config ([#​2486](j178/prek#2486)) - Make `prek cache size` output terminal-aware ([#​2508](j178/prek#2508)) - Match file regexes against path bytes ([#​2541](j178/prek#2541)) - Show hook aliases in run output ([#​2497](j178/prek#2497)) - Show hook descriptions in run output ([#​2490](j178/prek#2490)) ##### Performance - Avoid env cache scans for skipped hooks ([#​2502](j178/prek#2502)) - Cache Node version queries ([#​2500](j178/prek#2500)) ##### Bug fixes - Fix Node hook installation with npm 11 ([#​2487](j178/prek#2487)) - Isolate dependency installs from inherited Git repository state ([#​2506](j178/prek#2506)) ##### Documentation - Document combined group filtering ([#​2495](j178/prek#2495)) - Explain what prek does in README ([#​2507](j178/prek#2507)) - Refresh "Why prek" highlights ([#​2474](j178/prek#2474)) ##### Contributors - [@​will-wright-eng](https://github.com/will-wright-eng) - [@​Repiteo](https://github.com/Repiteo) - [@​j178](https://github.com/j178) ### [`v0.4.12`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0412) [Compare Source](j178/prek@v0.4.11...v0.4.12) Released on 2026-08-03. ##### Enhancements - Add `--require-group` for hook group intersections ([#​2472](j178/prek#2472)) - Align fast-path and builtin pre-commit hooks ([#​2433](j178/prek#2433)) - Do not shuffle file list for verbose output ([#​2431](j178/prek#2431)) - Improve top-level command descriptions ([#​2429](j178/prek#2429)) - Install `uv` from Astral CDN and drop source racing ([#​2455](j178/prek#2455)) - Make `prek install --force` bypass external hooks paths ([#​2437](j178/prek#2437)) - Show builtin hook flags in verbose list output ([#​2427](j178/prek#2427)) - Verify uv release archive checksums ([#​2456](j178/prek#2456)) ##### Performance - Precompute file tags in parallel ([#​2440](j178/prek#2440)) - Skip diffs after known hook modifications ([#​2447](j178/prek#2447)) - Skip worktree diffs for read-only languages ([#​2432](j178/prek#2432)) - Track builtin hook file changes directly ([#​2404](j178/prek#2404)) ##### Bug fixes - Use full object IDs in diff snapshots ([#​2448](j178/prek#2448)) ##### Documentation - Add a multi-repository configuration example ([#​2434](j178/prek#2434)) - Rewrite benchmark documentation ([#​2469](j178/prek#2469)) ##### Contributors - [@​j178](https://github.com/j178) - [@​BitWeaverDev](https://github.com/BitWeaverDev) - [@​allanlewis](https://github.com/allanlewis) ### [`v0.4.11`](https://github.com/j178/prek/blob/HEAD/CHANGELOG.md#0411) [Compare Source](j178/prek@v0.4.10...v0.4.11) Released on 2026-07-25. ##### Highlights - This release adds two new builtin hooks, `deny-pattern` and `require-pattern`, as native alternatives for `pygrep` use cases. `deny-pattern` fails when a configured pattern is found, while `require-pattern` ensures every selected file contains a match. By matching natively without spawning a Python subprocess, they run over 4x faster than `pygrep` in benchmarks. Note that they use [Rust `regex` syntax](https://docs.rs/regex/latest/regex/#syntax), which does not support look-around features such as negative lookbehind. - `prek run` now supports `--glob <PATTERN>` to run hooks on tracked files matching a glob. It can be repeated or combined with `--files` and `--directory`. - Hook priorities now support reusable aliases: ```toml [priorities] checks = 10 [[repos]] repo = "builtin" hooks = [ { id = "check-json", priority = "checks" }, { id = "check-yaml", priority = "checks" }, ] ``` This makes parallel scheduling easier to read and maintain. ##### Enhancements - Add `deny-pattern` and `require-pattern` builtin hooks ([#​2359](j178/prek#2359)) - Support `--glob` patterns in `prek run` ([#​2381](j178/prek#2381)) - Support reusable aliases for hook priorities ([#​2331](j178/prek#2331)) - Implement `requirements-txt-fixer` as a builtin hook ([#​2390](j178/prek#2390)) - Improve user-facing warnings and errors ([#​2380](j178/prek#2380)) - Install Node hooks through git url ([#​2394](j178/prek#2394)) ##### Performance - Reduce blocking-pool overhead in file hooks ([#​2384](j178/prek#2384)) - Speed up mixed-line-ending scans with memchr2 ([#​2391](j178/prek#2391)) ##### Bug fixes - Honor filenames in builtin hook entry and args ([#​2389](j178/prek#2389)) - Match identify tags across filename parts ([#​2399](j178/prek#2399)) - Preserve hook output order with a shared pipe ([#​2385](j178/prek#2385)) - Preserve system download policy when applying metadata ([#​2395](j178/prek#2395)) ##### Contributors - [@​j178](https://github.com/j178) - [@​chrisoro](https://github.com/chrisoro) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yODYuMSIsInVwZGF0ZWRJblZlciI6IjQzLjI4OC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiLCJhdXRvbWF0aW9uOmJvdC1hdXRob3JlZCIsImRlcGVuZGVuY3ktdHlwZTo6cGF0Y2giXX0=-->
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
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