Skip to content

Document each hook #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lucas-C merged 3 commits into from
Jun 6, 2025
Merged

Document each hook #104

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f35acc0
Document each hook
nyurik Jun 5, 2025
8162a8a
link to hook definitions
nyurik Jun 5, 2025
6e70c6d
mdformat
Lucas-C Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,25 @@ into separate repos:

## Usage

See [hook definitions](./.pre-commit-hooks.yaml) for additional hook
documentation.

All hooks work on text files, except for the `chmod` hook that applies to
all files.

```yaml
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.5.5
hooks:
- id: forbid-crlf
- id: remove-crlf
- id: forbid-tabs
- id: remove-tabs
- id: forbid-crlf # Forbid files containing CRLF end-lines to be committed
- id: remove-crlf # Replace CRLF end-lines by LF ones before committing
- id: forbid-tabs # Forbid files containing tabs to be committed
- id: remove-tabs # Replace tabs by whitespaces before committing
args: [--whitespaces-count, '2'] # defaults to: 4
- id: chmod
- id: chmod # Set file permissions
args: ['644']
files: \.md$
- id: insert-license
- id: insert-license # Insert a short license disclaimer as a header comment in source files
files: \.groovy$
args:
- --license-filepath
Expand Down