chore: catch lint failures before push (misspell + scoped golangci-lint) #2994
+151
−0
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| #!/bin/sh | ||
| # Pre-push hook: run the misspell linter (locale US, same as .golangci.yaml's | ||
| # misspell config) on the .go/.md files this push introduces or modifies, so | ||
| # spelling failures surface locally instead of on the PR's lint check. | ||
| # | ||
| # Install with: make install-hooks | ||
| # Bypass for a one-off push: git push --no-verify | ||
|
|
||
| root=$(git rev-parse --show-toplevel) || exit 0 | ||
|
|
||
| # go tool compiles misspell from tool.mod on first use and caches it; go may | ||
| # not be on PATH in GUI-spawned shells, so fall back to the default install. | ||
| if command -v go >/dev/null 2>&1; then | ||
| GO=go | ||
| elif [ -x /usr/local/go/bin/go ]; then | ||
| GO=/usr/local/go/bin/go | ||
| else | ||
| exit 0 | ||
| fi | ||
|
|
||
| ZERO=0000000000000000000000000000000000000000 | ||
| status=0 | ||
|
|
||
| while read -r local_ref local_sha remote_ref remote_sha; do | ||
| [ "$local_sha" = "$ZERO" ] && continue # deleting a remote ref | ||
|
|
||
| if [ "$remote_sha" = "$ZERO" ]; then | ||
| # New remote branch: diff against the merge-base with stage (or main). | ||
| base=$(git merge-base "$local_sha" origin/stage 2>/dev/null) || | ||
| base=$(git merge-base "$local_sha" origin/main 2>/dev/null) || continue | ||
| else | ||
| base=$remote_sha | ||
| fi | ||
|
|
||
| files=$(git diff --name-only --diff-filter=ACMR "$base" "$local_sha" -- '*.go' '*.md') | ||
| [ -z "$files" ] && continue | ||
|
|
||
| # Check the blobs at local_sha, not the working tree, so uncommitted edits | ||
| # don't mask (or fake) findings in what's actually being pushed. | ||
| for f in $files; do | ||
|
Contributor
There was a problem hiding this comment.
For a pushed Go or Markdown path containing whitespace or shell glob characters, |
||
| out=$(git show "$local_sha:$f" 2>/dev/null | | ||
| GOWORK=off "$GO" tool -modfile="$root/tool.mod" misspell -locale US -error 2>&1) | ||
| if [ -n "$out" ]; then | ||
| echo "pre-push: misspell found issues in $f:" >&2 | ||
| echo "$out" | sed "s|^stdin| $f|" >&2 | ||
| status=1 | ||
| fi | ||
|
Contributor
There was a problem hiding this comment.
When |
||
| done | ||
| done | ||
|
|
||
| if [ "$status" -ne 0 ]; then | ||
| echo "" >&2 | ||
| echo "pre-push: fix the spellings above and amend/commit — the CI lint check (golangci-lint misspell) fails on them." >&2 | ||
| echo "pre-push: bypass once with: git push --no-verify" >&2 | ||
| fi | ||
| exit $status | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If a contributor's checkout lacks local
origin/stageandorigin/mainrefs, both merge-base commands fail and the silentcontinuepermits the new branch push without running misspell, defeating the hook's purpose of surfacing failures before CI.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 231d6b7.