k8s.io/kubernetes@v1.31.0-alpha.0.0.20240520171757-56147500dadc/hack/verify-spelling.sh (about)

     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  
    16  # This script checks commonly misspelled English words in all files in the
    17  # working directory by client9/misspell package.
    18  # Usage: `hack/verify-spelling.sh`.
    19  
    20  set -o errexit
    21  set -o nounset
    22  set -o pipefail
    23  
    24  KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
    25  export KUBE_ROOT
    26  source "${KUBE_ROOT}/hack/lib/init.sh"
    27  
    28  kube::golang::setup_env
    29  
    30  # Ensure that we find the binaries we build before anything else.
    31  export GOBIN="${KUBE_OUTPUT_BIN}"
    32  PATH="${GOBIN}:${PATH}"
    33  
    34  # Install tools we need
    35  go -C "${KUBE_ROOT}/hack/tools" install github.com/client9/misspell/cmd/misspell
    36  
    37  # Spell checking
    38  # All the skipping files are defined in hack/.spelling_failures
    39  skipping_file="${KUBE_ROOT}/hack/.spelling_failures"
    40  failing_packages=$(sed "s| | -e |g" "${skipping_file}")
    41  git ls-files | grep -v -e "${failing_packages}" | xargs misspell -i "Creater,creater,ect" -error -o stderr