Skip to content
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.

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

feat: Add Docker pre-commit hook #640

Merged
merged 1 commit into from
Dec 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@
types: [text]
stages: [commit, merge-commit, push, manual]

- id: typos-docker
name: typos
description: Source code spell checker, Docker image
language: docker
entry: typos
args: [--write-changes]
types: [text]
stages: [commit, merge-commit, push, manual]

- id: typos-src
name: typos
description: Source code spell checker, source install
Expand Down
3 changes: 2 additions & 1 deletion docs/pre-commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ repos:

The `typos` id installs a prebuilt executable from GitHub releases. If
one does not exist for the target platform, or if one built from
sources is preferred, use `typos-src` as the hook id instead.
sources is preferred, use `typos-docker` (requires Docker), or `typos-src`
(requires Rust) as the hook id instead.

Be sure to change `rev` to use the desired `typos` git tag or
revision.
Expand Down