Skip to content

Commit

Permalink
add spelling checking script
Browse files Browse the repository at this point in the history
  • Loading branch information
dixudx committed Feb 23, 2018
1 parent 48434b4 commit 16a807a
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
19 changes: 19 additions & 0 deletions hack/.spelling_failures
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
BUILD
CHANGELOG
OWNERS
api.pb.go
api.proto
docs/api-reference
docs/man
docs/user-guide
generated.pb.go
generated.proto
pkg/client/clientset_generated
pkg/client/informers/informers_generated/
pkg/generated
swagger
test/e2e/generated
third_party/
translations/
vendor/
zz_generated
1 change: 1 addition & 0 deletions hack/make-rules/verify.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ QUICK_PATTERNS+=(
"verify-imports.sh"
"verify-pkg-names.sh"
"verify-readonly-packages.sh"
"verify-spelling.sh"
"verify-staging-client-go.sh"
"verify-test-images.sh"
"verify-test-owners.sh"
Expand Down
37 changes: 37 additions & 0 deletions hack/verify-spelling.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/usr/bin/env bash
# Copyright 2018 The Kubernetes 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.

set -o errexit
set -o nounset
set -o pipefail

export KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
source "${KUBE_ROOT}/hack/lib/init.sh"

# Install tools we need, but only from vendor/...
cd ${KUBE_ROOT}
go install ./vendor/github.com/client9/misspell/cmd/misspell
if ! which misspell >/dev/null 2>&1; then
echo "Can't find misspell - is your GOPATH 'bin' in your PATH?" >&2
echo " GOPATH: ${GOPATH}" >&2
echo " PATH: ${PATH}" >&2
exit 1
fi

# Spell checking
# All the skipping files are defined in hack/.spelling_failures
skipping_file="${KUBE_ROOT}/hack/.spelling_failures"
failing_packages=$(echo `cat ${skipping_file}` | sed "s| | -e |g")
git ls-files | grep -v -e ${failing_packages} | xargs misspell -i "Creater,creater,ect" -error -o stderr

0 comments on commit 16a807a

Please sign in to comment.