Add verify-spelling.sh for English words. #547

yanggangtony · 2023-04-25T11:54:25Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

Add verify-spelling.sh to check english typos...

Ignore .golangci.yaml,

./.golangci.yaml:22:6: "importas" is a misspelling of "imports"
./.golangci.yaml:50:2: "importas" is a misspelling of "imports"

because importas is the package name.
golinters importas typos

Which issue(s) this PR fixes:

Fixes #545

Special notes for your reviewer:

Does this PR introduce a user-facing change?

None

netlify · 2023-04-25T11:54:33Z

✅ Deploy Preview for k8s-kwok canceled.

Name	Link
🔨 Latest commit	`2edbdd2`
🔍 Latest deploy log	https://app.netlify.com/sites/k8s-kwok/deploys/645478fbb67a2b0008ecc03b

wzshiming · 2023-04-26T02:28:02Z

hack/verify-spelling.sh

+  echo "Checking spelling..."
+  ERROR_LOG="${TMP_DIR}/errors.log"
+
+  find . -type f | grep -v .golangci.yaml | grep -v vendor/ | xargs misspell >"${ERROR_LOG}"


We should have a list of allowed words, not the whole document excluded.

@wzshiming
thanks for review.

you means like the code below

skipping_file="${KUBE_ROOT}/scripts/.spelling_failures" failing_packages=$(sed "s| | -e |g" "${skipping_file}")

And we add the .golangci.yaml and vendor/ to .spelling_failures files?

Actually i used did it like that, but error shows,
So i update the code ..😂😂

If that , i will try again and test ..

For more tools details see https://github.com/client9/misspell
Refer #514 to add verify-spelling.sh and update-spelling.sh

with -i $(sed <"${spelling_words}" "s| |,|g")

thanks .
I will do it later.

hack/verify-all.sh

hack/update-spelling.sh

hack/allowd_spelling_words

wzshiming · 2023-05-04T09:56:24Z

hack/update-spelling.sh

+
+function check() {
+  #NOTE we use go install refer the go site :https://go.dev/doc/go-get-install-deprecation
+  go install github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}


Refer to https://github.com/kubernetes-sigs/kwok/blob/77084dafb31221339996078e319501e4668c7d74/hack/update-shell-format.sh#L32C1-L41

yanggangtony · 2023-05-04T10:24:57Z

So fast for review...😀😀

yanggangtony · 2023-05-04T11:16:18Z

vendor dir is not exclude..
i will test it again.
wait a moment for rereviw.

yanggangtony · 2023-05-04T13:14:23Z

@wzshiming
the ci passd.
would you please review again?

wzshiming · 2023-05-04T13:29:59Z

hack/verify-spelling.sh

+##########
+# This script verifies mispellings in location. Today it only supports
+# verifying English locale but can be modified in a future to support
+# other locales also
+# You need to run this script inside the root directory of "website" git repo.
+#
+# Syntax: verify-spelling.sh LOCALE
+# Example: verify-spelling.sh en
+# If no locale is passed, it will assume "en"
+#
+# Requirements:
+# - go v1.14 or superior version


Suggested change

##########

# This script verifies mispellings in location. Today it only supports

# verifying English locale but can be modified in a future to support

# other locales also

# You need to run this script inside the root directory of "website" git repo.

#

# Syntax: verify-spelling.sh LOCALE

# Example: verify-spelling.sh en

# If no locale is passed, it will assume "en"

#

# Requirements:

# - go v1.14 or superior version

wzshiming · 2023-05-04T13:30:04Z

hack/verify-spelling.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+


Suggested change

wzshiming · 2023-05-04T13:31:28Z

hack/update-spelling.sh

+# cd to the root path
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"


Suggested change

# cd to the root path

ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"

ROOT_DIR="$(realpath "$(dirname "${BASH_SOURCE[0]}")"/..)"

wzshiming · 2023-05-04T13:32:13Z

hack/update-spelling.sh

+fi
+
+function check() {
+  cd "${ROOT}"


Suggested change

cd "${ROOT}"

wzshiming · 2023-05-04T13:32:33Z

hack/update-spelling.sh

+
+# cleanup
+exitHandler() (
+  echo "Cleaning up..."
+  rm -rf "${TMP_DIR}"
+)
+trap exitHandler EXIT


Suggested change

# cleanup

exitHandler() (

echo "Cleaning up..."

rm -rf "${TMP_DIR}"

)

trap exitHandler EXIT

wzshiming · 2023-05-04T13:33:37Z

hack/verify-all.sh

+if [[ "${VERIFY_SHELL_SPELLING:-true}" == "true" ]]; then
+  echo "[*] Verifying spelling..."
+  "${ROOT_DIR}"/hack/verify-spelling.sh || failed+=(shell-spelling)
+fi


Suggested change

if [[ "${VERIFY_SHELL_SPELLING:-true}" == "true" ]]; then

echo "[*] Verifying spelling..."

"${ROOT_DIR}"/hack/verify-spelling.sh || failed+=(shell-spelling)

fi

if [[ "${VERIFY_SPELLING:-true}" == "true" ]]; then

echo "[*] Verifying spelling..."

"${ROOT_DIR}"/hack/verify-spelling.sh || failed+=(spelling)

fi

wzshiming · 2023-05-04T13:33:58Z

hack/update-all.sh

+if [[ "${UPDATE_SHELL_SPELLING:-true}" == "true" ]]; then
+  echo "[*] Update spelling..."
+  "${ROOT_DIR}"/hack/update-spelling.sh || failed+=(shell-spelling)
+fi


Suggested change

if [[ "${UPDATE_SHELL_SPELLING:-true}" == "true" ]]; then

echo "[*] Update spelling..."

"${ROOT_DIR}"/hack/update-spelling.sh || failed+=(shell-spelling)

fi

if [[ "${UPDATE_SPELLING:-true}" == "true" ]]; then

echo "[*] Update spelling..."

"${ROOT_DIR}"/hack/update-spelling.sh || failed+=(spelling)

fi

wzshiming · 2023-05-04T13:34:15Z

hack/verify-spelling.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Copyright 2019 The Kubernetes Authors.


Suggested change

# Copyright 2019 The Kubernetes Authors.

# Copyright 2023 The Kubernetes Authors.

wzshiming · 2023-05-04T13:34:39Z

hack/update-spelling.sh

+elif command -v "${GOPATH}/bin/misspell"; then
+  COMMAND=("${GOPATH}/bin/misspell")


Suggested change

elif command -v "${GOPATH}/bin/misspell"; then

COMMAND=("${GOPATH}/bin/misspell")

elif command -v "${ROOT_DIR}/bin/misspell"; then

COMMAND=("${ROOT_DIR}/bin/misspell")

wzshiming · 2023-05-04T13:35:49Z

hack/update-spelling.sh

+  go install github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}
+  COMMAND=(misspell)


Suggested change

go install github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}

COMMAND=(misspell)

GOBIN="${ROOT_DIR}/bin/" go install github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}

COMMAND=("${ROOT_DIR}/bin/misspell")

yanggangtony · 2023-05-04T14:41:38Z

Good suggestion.
Update later.

wzshiming · 2023-05-04T15:06:32Z

hack/update-spelling.sh

+  # check spelling
+  echo "Checking spelling..."
+  ignore="$(tr <"${allowd_spelling_words}" '\n' ',')"
+  "${COMMAND[@]}" -i "${ignore}" "$(find . -not \( -path ./vendor\* -o -path ./.git\* \))"


Suggested change

# check spelling

echo "Checking spelling..."

ignore="$(tr <"${allowd_spelling_words}" '\n' ',')"

"${COMMAND[@]}" -i "${ignore}" "$(find . -not $ -path ./vendor\* -o -path ./.git\* $)"

ignore="$(tr <"${allowd_spelling_words}" '\n' ',')"

"${COMMAND[@]}" -w -i "${ignore}" "$(find . -not $ -path ./vendor\* -o -path ./.git\* $)"

Good suggestion.
with -w flag , So misspell can override the file.
And then git --no-pager diff --exit-code can check the diff of the file.

Will update it later.

wzshiming · 2023-05-04T15:06:50Z

hack/update-spelling.sh

+elif command -v "${ROOT_DIR}/bin/misspell"; then
+  COMMAND=("${ROOT_DIR}/bin/misspell")
+else
+  #NOTE we use go install refer the go site :https://go.dev/doc/go-get-install-deprecation


Suggested change

#NOTE we use go install refer the go site :https://go.dev/doc/go-get-install-deprecation

wzshiming · 2023-05-04T15:10:39Z

hack/update-spelling.sh

+TOOL_VERSION="v0.3.4"
+
+ROOT_DIR="$(realpath "$(dirname "${BASH_SOURCE[0]}")"/..)"
+allowd_spelling_words="${ROOT_DIR}/hack/allowd_spelling_words"


Suggested change

allowd_spelling_words="${ROOT_DIR}/hack/allowd_spelling_words"

allowed_spelling_words="${ROOT_DIR}/hack/spelling.txt"

wzshiming · 2023-05-04T15:11:20Z

hack/update-spelling.sh

+  "${COMMAND[@]}" -i "${ignore}" "$(find . -not \( -path ./vendor\* -o -path ./.git\* \))"
+}
+
+cd "${ROOT_DIR}" && check || exit 1


Suggested change

cd "${ROOT_DIR}" && check || exit 1

cd "${ROOT_DIR}"

update || exit 1

wzshiming · 2023-05-05T01:58:27Z

hack/update-spelling.sh

+  ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"
+  "${COMMAND[@]}" -w -i "${ignore}" "$(find . -not \( -path ./vendor\* -o -path ./.git\* \))"


Suggested change

ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"

"${COMMAND[@]}" -w -i "${ignore}" "$(find . -not $ -path ./vendor\* -o -path ./.git\* $)"

local ignore

ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"

mapfile -t files < <(find . $ \

-iname "*.md" -o \

-iname "*.sh" -o \

-iname "*.go" -o \

-iname "*.tpl" -o \

-iname "*.yaml" -o \

-iname "*.yml" \

$ \

-not $ \

-path ./.git/\* -o \

-path ./vendor/\* -o \

-path ./demo/node_modules/\* -o \

-path ./site/themes/\* \

$)

"${COMMAND[@]}" -locale US -w -i "${ignore}" "${files[@]}"

Signed-off-by: yanggang <gang.yang@daocloud.io>

yanggangtony · 2023-05-05T03:11:41Z

/retest

wzshiming · 2023-05-05T03:13:40Z

pkg/log/logger_ctl.go

 		renderer: fmt.Sprintf("%s%s%s", c, msg, ctc.Reset),
 		width:    stringWidth(msg),
 	}
 }

-var levelColour = map[string]colour{
+var levelColour = map[string]color{


Suggested change

var levelColour = map[string]color{

var levelColor = map[string]color{

good, why the misspell not found that....😂😂

Signed-off-by: yanggang <gang.yang@daocloud.io>

wzshiming

/approve
/lgtm
/label tide/merge-method-squash

k8s-ci-robot · 2023-05-05T05:29:26Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wzshiming, yanggangtony

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [wzshiming]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 25, 2023

k8s-ci-robot requested review from wzshiming and yibozhuang April 25, 2023 11:54

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 25, 2023

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 25, 2023

wzshiming reviewed Apr 26, 2023

View reviewed changes

hack/verify-all.sh Outdated Show resolved Hide resolved

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 4, 2023

wzshiming reviewed May 4, 2023

View reviewed changes

wzshiming requested changes May 4, 2023

View reviewed changes

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 4, 2023

wzshiming requested changes May 4, 2023

View reviewed changes

wzshiming reviewed May 4, 2023

View reviewed changes

wzshiming reviewed May 5, 2023

View reviewed changes

Add verify-spelling.sh for English words.

1c20ffa

Signed-off-by: yanggang <gang.yang@daocloud.io>

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 5, 2023

wzshiming reviewed May 5, 2023

View reviewed changes

fix spellings

2edbdd2

Signed-off-by: yanggang <gang.yang@daocloud.io>

wzshiming approved these changes May 5, 2023

View reviewed changes

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 5, 2023

k8s-ci-robot assigned wzshiming May 5, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 5, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2023

k8s-ci-robot merged commit df42845 into kubernetes-sigs:main May 5, 2023

yanggangtony deleted the feature-misspell branch May 5, 2023 05:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add verify-spelling.sh for English words. #547

Add verify-spelling.sh for English words. #547

		# cd to the root path
		ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"

	# cd to the root path
	ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
	ROOT_DIR="$(realpath "$(dirname "${BASH_SOURCE[0]}")"/..)"

		@@ -0,0 +1,42 @@
		#!/usr/bin/env bash

		# Copyright 2019 The Kubernetes Authors.

	# Copyright 2019 The Kubernetes Authors.
	# Copyright 2023 The Kubernetes Authors.

		elif command -v "${GOPATH}/bin/misspell"; then
		COMMAND=("${GOPATH}/bin/misspell")

		go install github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}
		COMMAND=(misspell)

	allowd_spelling_words="${ROOT_DIR}/hack/allowd_spelling_words"
	allowed_spelling_words="${ROOT_DIR}/hack/spelling.txt"

	cd "${ROOT_DIR}" && check \|\| exit 1
	cd "${ROOT_DIR}"
	update \|\| exit 1

		ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"
		"${COMMAND[@]}" -w -i "${ignore}" "$(find . -not \( -path ./vendor\* -o -path ./.git\* \))"

-  ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"
-  "${COMMAND[@]}" -w -i "${ignore}" "$(find . -not \( -path ./vendor\* -o -path ./.git\* \))"
+  local ignore
+  ignore="$(tr <"${allowed_spelling_words}" '\n' ',')"
+  mapfile -t files < <(find . \( \
+    -iname "*.md" -o \
+    -iname "*.sh" -o \
+    -iname "*.go" -o \
+    -iname "*.tpl" -o \
+    -iname "*.yaml" -o \
+    -iname "*.yml" \
+    \) \
+    -not \( \
+    -path ./.git/\* -o \
+    -path ./vendor/\* -o \
+    -path ./demo/node_modules/\* -o \
+    -path ./site/themes/\* \
+    \))
+  "${COMMAND[@]}" -locale US -w -i "${ignore}" "${files[@]}"

	var levelColour = map[string]color{
	var levelColor = map[string]color{

Add verify-spelling.sh for English words. #547

Add verify-spelling.sh for English words. #547

Conversation

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

✅ Deploy Preview for k8s-kwok canceled.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment