verify-spelling.sh 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. #!/usr/bin/env bash
  2. # Copyright 2018 The Kubernetes Authors.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. # This script checks commonly misspelled English words in all files in the
  16. # working directory by client9/misspell package.
  17. # Usage: `hack/verify-spelling.sh`.
  18. set -o errexit
  19. set -o nounset
  20. set -o pipefail
  21. KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
  22. export KUBE_ROOT
  23. source "${KUBE_ROOT}/hack/lib/init.sh"
  24. # Ensure that we find the binaries we build before anything else.
  25. export GOBIN="${KUBE_OUTPUT_BINPATH}"
  26. PATH="${GOBIN}:${PATH}"
  27. # Install tools we need, but only from vendor/...
  28. go install k8s.io/kubernetes/vendor/github.com/client9/misspell/cmd/misspell
  29. # Spell checking
  30. # All the skipping files are defined in hack/.spelling_failures
  31. skipping_file="${KUBE_ROOT}/hack/.spelling_failures"
  32. failing_packages=$(sed "s| | -e |g" "${skipping_file}")
  33. git ls-files | grep -v -e "${failing_packages}" | xargs misspell -i "Creater,creater,ect" -error -o stderr