Skip to content

750: Teach ad-hoc hooks line parsing - #757

Merged
sds merged 9 commits into
sds:mainfrom
guillaume-d:guillaume-d/bug/750-teach-ad-hoc-hooks-line-parsing
Nov 10, 2026
Merged

750: Teach ad-hoc hooks line parsing#757
sds merged 9 commits into
sds:mainfrom
guillaume-d:guillaume-d/bug/750-teach-ad-hoc-hooks-line-parsing

Conversation

@guillaume-d

@guillaume-d guillaume-d commented Jun 11, 2021 •
edited by sds
Loading

Copy link
Copy Markdown
Contributor

Command hooks can now parse file diagnostics through YAML configuration, enabling Overcommit's existing warning and modified-line handling without a Ruby plugin.

Closes #750. Implements the requirements and review decisions from that issue:

  • An explicit message_pattern Ruby regex enables parsing; a named file capture is required, while line and type are optional.
  • warning_message_type_pattern accepts a regex or literal substring; unmatched or missing types default to errors.
  • Commands receive applicable files and respect include, exclude, requires_files, and problem_on_unmodified_line.
  • Existing command hooks retain their Git-hook behavior. Only stdout is parsed; tools using stderr can redirect it in a wrapper, as agreed in review. Prefiltering and stream-selection options remain outside this change.

Also fixes regex loading with current Psych versions, prevents failed commands with empty/blank stdout from passing, validates patterns, and avoids stale behavior when the same hook name is loaded with different configuration. Documentation includes the GNU/Emacs-style example and the failure behavior.

Validation: full local suite passed (1,813 examples); all 37 focused loader/configuration examples pass, including a real subprocess with staged files and Windows drive-letter diagnostics. Pre-commit checks and RuboCop pass. GitHub CI covers Ruby 3.3, 3.4, and 4.0 on Ubuntu and Windows.

This was referenced Jun 11, 2021
Closed
Merged
sds
sds reviewed Jun 21, 2021
View reviewed changes

@sds sds left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks so much for opening this pull request, @guillaume-d. Very excited to move this forward.

Left a few comments to clarify how we could potentially make this experience a seamless one without having to introduce the concept of an "ad hoc" hook to the configuration format. Curious to get your perspective.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread lib/overcommit/hook_loader/base.rb Resolved
Comment thread README.md Resolved
sds
sds reviewed Jul 15, 2021
View reviewed changes

@sds sds left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Sincere apologies for the very slow response, @guillaume-d. Let me know your thoughts!

Comment thread README.md Resolved
Comment thread lib/overcommit/hook_loader/base.rb Resolved
@guillaume-d

guillaume-d commented Jul 16, 2021

Copy link
Copy Markdown
Contributor Author

Sincere apologies for the very slow response, @guillaume-d. Let me know your thoughts!

No problem, was started to worry something bad may have happened.
In the meantime, I have been implementing some kind of flattening, I will just finish it (hopefully today) and push that for now as a stepping stone, and once done will have another look at implementing your suggestions.

@guillaume-d
guillaume-d force-pushed the guillaume-d/bug/750-teach-ad-hoc-hooks-line-parsing branch from 1438fa3 to 34bf2c8 Compare October 11, 2021 18:06
@guillaume-d
guillaume-d force-pushed the guillaume-d/bug/750-teach-ad-hoc-hooks-line-parsing branch 3 times, most recently from f5f0d60 to 72ed54f Compare October 11, 2021 18:29
@guillaume-d
guillaume-d force-pushed the guillaume-d/bug/750-teach-ad-hoc-hooks-line-parsing branch from 72ed54f to 3dc1d14 Compare October 11, 2021 18:31
@guillaume-d

guillaume-d commented Oct 11, 2021

Copy link
Copy Markdown
Contributor Author

Sincere apologies for the very slow response, @guillaume-d. Let me know your thoughts!

No problem, was started to worry something bad may have happened. In the meantime, I have been implementing some kind of flattening, I will just finish it (hopefully today) and push that for now as a stepping stone, and once done will have another look at implementing your suggestions.

Hi. I think all comments have finally been adressed now.

I am afraid I will not have much more time to do another review round (except maybe if feedback is very minor and comes fast, before I get sidetracked by other things).

If nothing comes I will just use my fork of overcommit going forward, and use #758 and future uses of this feature from there.

sds added 4 commits November 9, 2026 22:31
@sds
Merge remote-tracking branch 'origin/main' into pr-757
ce52790 
* origin/main: (108 commits)
  Remember all previously approved configurations and hooks (sds#665)
  Keep deleted and renamed paths absent while stashing changes (sds#928)
  Document the case-sensitive KtLint hook name (sds#927)
  Update CI actions and pin Ubuntu to clear annotations (sds#926)
  Preserve standard input bytes when forwarding hooks (sds#925)
  Preserve Git-quoted filenames when running all hooks (sds#924)
  Fail when Git cannot enumerate tracked files (sds#923)
  Add note about disabling default hooks (sds#922)
  Close files inspected by LineEndings (sds#921)
  Use Script Host before PowerShell for Windows parent query fallback (sds#920)
  Cache Windows dependency resolution with daily refreshes (sds#919)
  Avoid PowerShell startup for Windows parent command queries (sds#918)
  Avoid repeated CLI startup when preparing integration fixtures (sds#917)
  Allocate more CI runners to Windows with asymmetric sharding (sds#916)
  Shard CI tests across runners and add one required CI check (sds#915)
  Remove EOL Ruby versions from the CI matrix (sds#914)
  Cut CI test time by 68% while preserving the full test matrix (sds#913)
  Cut version 0.75.0 (sds#912)
  Re-enable the full Windows test matrix and fix platform failures (sds#911)
  Read .overcommit.yml as UTF-8 in the hook template (sds#910)
  Update Overcommit logo (sds#907)
  Cut version 0.74.0 (sds#906)
  Keep each worktree's signatures separate (sds#903)
  Recognize amend aliases on macOS (sds#904)
  Exclude files deleted from the working tree from all_files (sds#905)
  Restore the Ruby 2.6-3.1 test checks (sds#902)
  Delete subprocess output tempfiles once they are read (sds#901)
  Stop wrapping commands in cmd.exe on Windows (sds#898)
  Allow URL-only lines to exceed TextWidth body limit (sds#900)
  Cut version 0.73.0 (sds#896)
  Add automated release flow (sds#895)
  Instruct oxfmt not to fail if no files are matched (sds#894)
  Add filetypes to oxc tools (sds#893)
  Add pre commit hook for herb-lint (sds#892)
  Cut version 0.72.0 (sds#891)
  Remove maintainability badge (sds#890)
  Require patched REXML version (sds#889)
  Fix operation state restoration in linked worktrees (sds#887)
  Fail Flay hook when flay crashes instead of silently passing (sds#885)
  Fix Solargraph regexp capture warning (sds#886)
  Cut version 0.71.0 (sds#883)
  Prepare for the new solargraph typecheck format (sds#873)
  Make hook context input reads thread-safe (sds#882)
  Cut version 0.70.0 (sds#880)
  Add oxc pre-commit hooks (sds#879)
  Add Ruby 3.4 and 4.0 to CI matrix (sds#878)
  Cut version 0.69.0 (sds#877)
  Use Etc.nprocessors and handle sandboxed environments (sds#876)
  Cut version 0.68.0 (sds#872)
  Add solargraph pre-commit hook for typechecking (sds#871)
  Update RuboCop in Gemfile to silence a deprecation warning in build (sds#870)
  Cut version 0.67.1
  adds 'set' requirements to diff hook context. (sds#866)
  Add note about unsupported YAML features in `gemfile:` line in default.yml (sds#865)
  Cut version 0.67.0 (sds#864)
  Restore ability to specify "gemfile: false" in config (sds#863)
  Cut version 0.66.0 (sds#861)
  Add `-diff` cli option for running precommit hooks against diffs (sds#860)
  Cut version 0.65.0
  Load bundled gems on expected version (sds#859)
  Update changelog
  Bump rexml to >= 3.3.9 to resolve GHSA-2rxp-v6pw-ch6m (sds#857)
  Expand tildes(~) for hooksPath (sds#853)
  Fix spec compatibility with recent git versions (sds#854)
  Update changelog
  Cut version 0.64.0 (sds#852)
  Add changelog_uri to gemspec (sds#851)
  Support stylelint 16+, which emits messages on stderr (sds#848)
  Add Ruby 3.3 to CI matrix (sds#849)
  Update README with latest requirements (sds#845)
  Fix README badges (sds#844)
  Cut version 0.63.0 (sds#843)
  Add RSpec Hook to PreCommit, Add Applicable files if set (sds#842)
  Fix RuboCop warnings (sds#841)
  [FEATURE] New pre-commit hook: Sorbet (Issue sds#825) (sds#826)
  Green CI PoC (sds#833)
  Revert "Get suite running smoothly again (sds#824)" (sds#840)
  Get suite running smoothly again (sds#824)
  Cut version 0.62.0 (sds#821)
  Allow childprocess 5 (sds#820)
  Update branch for CI from `master` to `main` (sds#819)
  Update RuboCop (sds#818)
  Adding Ruby 3.2 to test matrix (sds#816)
  Cut version 0.61.0 (sds#817)
  fix: local overcommit file merges with existing .overcommit.yml file (sds#815)
  Allow ReplaceBranch to use skip_if (sds#809)
  Cut version 0.60.0 (sds#807)
  Add non ASCII encoding schema support to RailsSchemaUpToDate hook (sds#786)
  Rescue Psych::DisallowedClass in YamlSyntax (sds#805)
  Add optional additional local configuration (sds#799)
  Add MixTest hook (sds#802)
  Add MixFormat hook (sds#801)
  support trailing space in replace_branch's 'replacement_text' config (sds#804)
  Allow overriding Gemfile.lock (sds#796)
  Cut version 0.59.1 (sds#785)
  Revert addition of `--disable-pending-cops` flag to RuboCop (sds#783)
  Revert `Fix encoding of process output under windows` (sds#784)
  Cut version 0.59.0 (sds#780)
  Partial log flushing to make long hooks intuitive (sds#777)
  Fix pronto hooks swallowing generic errors (sds#779)
  ...

# Conflicts:
#	CHANGELOG.md
#	README.md
@sds
Complete configurable command diagnostics and cover issue sds#750 req…
b317848 
…uirements
@sds
Separate successful command guard from diagnostic parsing
6380372
@sds
Exercise drive-letter diagnostics in command hook tests
a15939b
@sds
sds merged commit 344aafc into sds:main Nov 10, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sds sds sds left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Teach ad-hoc hooks line-parsing using regexes in YAML

2 participants

@guillaume-d @sds