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.

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

Jump to bottom

feat: add pre-commit hook config #19

Merged
merged 2 commits into from
Jun 7, 2024
Merged

feat: add pre-commit hook config #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e15ca5
Add pre-commit hook config, https://pre-commit.com
scop May 2, 2020
8592a4e
Document pre-commit hook usage
VannTen May 22, 2024
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
8 changes: 8 additions & 0 deletions .pre-commit-hooks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- id: misspell
name: misspell
description: Correct commonly misspelled English words... quickly
language: golang
entry: misspell
args:
- -w
- -error
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,23 @@ Usage of misspell:
-w Overwrite file with corrections (default is just to display)
```

### Pre-commit hook

To use misspell with [pre-commit](https://pre-commit.com/), add the following to your `.pre-commit-config.yaml`:


```yaml
- repo: https://github.com/golangci/misspell
rev: v0.6.0
hooks:
- id: misspell
# The hook will run on all files by default.
# To limit to some files only, use pre-commit patterns/types
# files: <pattern>
# exclude: <pattern>
# types: <types>
```

## FAQ

* [Automatic Corrections](#correct)
Expand Down