forked from antrea-io/antrea
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add spell check script to hack (antrea-io#539)
Add spell check script to hack Add a script to check commonly misspelled English words and add it to Github workflow
- Loading branch information
Showing
13 changed files
with
107 additions
and
20 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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 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 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 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,12 @@ | ||
| CHANGELOG | ||
| CODE_OF_CONDUCT | ||
| GOVERNANCE | ||
| LICENSE | ||
| MAINTAINERS | ||
| go.mod | ||
| go.sum | ||
| clientset_generated | ||
| generated_expansion | ||
| generated.pb.go | ||
| generated.proto | ||
| zz_generated |
This file contains 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 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,54 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Copyright 2020 Antrea Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # This script checks commonly misspelled English words. This script is a | ||
| # slight modification of the kubernetes/hack/verify-spelling.sh. | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| TOOL_VERSION="v0.3.4" | ||
|
|
||
| ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" | ||
| cd "${ROOT}" | ||
|
|
||
| TMP_DIR=$(mktemp -d) | ||
|
|
||
| exitHandler() ( | ||
| echo "Cleaning up temporary directory" | ||
| rm -rf "${TMP_DIR}" | ||
| ) | ||
| trap exitHandler EXIT | ||
|
|
||
| cd "${TMP_DIR}" | ||
| GO111MODULE=on GOBIN="${TMP_DIR}" go get "github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}" | ||
| export PATH="${TMP_DIR}:${PATH}" | ||
| cd "${ROOT}" | ||
|
|
||
| # Check spelling and ignore skipped files. | ||
| RES=0 | ||
| echo "Spell check start" | ||
| ERROR_LOG="${TMP_DIR}/errors.log" | ||
| skipping_file="${ROOT}/hack/.spelling_failures" | ||
| failing_packages=$(sed "s| | -e |g" "${skipping_file}") | ||
| git ls-files | grep -v -e "${failing_packages}"| xargs misspell > "${ERROR_LOG}" | ||
| if [[ -s "${ERROR_LOG}" ]]; then | ||
| sed 's/^/error: /' "${ERROR_LOG}" | ||
| echo "Found spelling errors!" | ||
| RES=1 | ||
| fi | ||
| exit "${RES}" |
This file contains 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