Repository navigation
Adding pre-commit hooks - #26
Merged
Merged
Conversation
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.
Add pre-commit hooks
Adds a
.pre-commit-config.yaml, so the checks CI runs, plus some it doesn't, run before every commit. It follows osctrl's setup and uses the same hook repos and versions. Install once per clone withpre-commit install.Hooks
pre-commit-hooksv6.0.0):.plistas XML, socheck-xmltargets it explicitly.osctrld.exe.golangci-lint-fullhook, which lints the whole module like CI does. The default hook only lints changed files, which breaks theunusedlinter.gofmt. CI doesn't check formatting.GOOS=windows. A native lint run skips every//go:build windowsfile. This hook uses the golangci-lint onPATH.go test -race.osctrl's Python-only checks are left out, and so is
go-static-check, since golangci-lint already runs staticcheck.The README's Development section explains how to install and run the hooks.
Validation
pre-commit run --all-filesagainst a clean checkout ofHEAD. Every hook passed exceptend-of-file-fixer, which found thatMakefilehas no trailing newline. That is fixed automatically the first time a commit touchesMakefile.check-xmlactually validates the plist: a deliberately broken copy fails to parse.pre-commit validate-config: valid.