Merge pull request #20815 from ivanvc/replace-goword-with-misspell

Replace goword with golangci-lint misspell

Author: serathius

Makefile

@@ -96,7 +96,7 @@ fuzz:
 
 # Static analysis
 .PHONY: verify
-verify: verify-gofmt verify-bom verify-lint verify-dep verify-shellcheck verify-goword \
+verify: verify-gofmt verify-bom verify-lint verify-dep verify-shellcheck \
 	verify-license-header verify-mod-tidy \
 	verify-shellws verify-proto-annotations verify-genproto verify-yamllint \
 	verify-markdown-marker verify-go-versions verify-gomodguard \
@@ -134,10 +134,6 @@ fix-lint:
 verify-shellcheck:
 	PASSES="shellcheck" ./scripts/test.sh
 
-.PHONY: verify-goword
-verify-goword:
-	PASSES="goword" ./scripts/test.sh
-
 .PHONY: verify-license-header
 verify-license-header:
 	PASSES="license_header" ./scripts/test.sh

etcdctl/ctlv3/command/snapshot_command.go

@@ -37,7 +37,7 @@ var snapshotExample = util.Normalize(`
 	# Get snapshot from given address with certificates
 	etcdctl --endpoints=https://127.0.0.1:2379 --cacert=/etc/etcd/ca.crt --cert=/etc/etcd/etcd.crt --key=/etc/etcd/etcd.key snapshot save /backup/etcd-snapshot.db
 
-	# Get snapshot wih certain user and password
+	# Get snapshot with certain user and password
 	etcdctl --user=root --password=password123 snapshot save /backup/etcd-snapshot.db
 
 	# Get snapshot from given address with timeout

scripts/test.sh

@@ -421,36 +421,6 @@ function license_header_pass {
   run_for_modules generic_checker license_header_per_module
 }
 
-# goword_for_package package
-# checks spelling and comments in the 'package' in the current module
-#
-function goword_for_package {
-  # bash 3.x compatible replacement of: mapfile -t gofiles < <(go_srcs_in_module)
-  local gofiles=()
-  while IFS= read -r line; do gofiles+=("$line"); done < <(go_srcs_in_module)
-  
-  local gowordRes
-
-  # spellchecking can be enabled with GOBINARGS="--tags=spell"
-  # but it requires heavy dependencies installation, like:
-  # apt-get install libaspell-dev libhunspell-dev hunspell-en-us aspell-en
-
-  # only check for broke exported godocs
-  if gowordRes=$(run_go_tool "github.com/chzchzchz/goword" -use-spell=false "${gofiles[@]}" | grep godoc-export | sort); then
-    log_error -e "goword checking failed:\\n${gowordRes}"
-    return 255
-  fi
-  if [ -n "$gowordRes" ]; then
-    log_error -e "goword checking returned output:\\n${gowordRes}"
-    return 255
-  fi
-}
-
-
-function goword_pass {
-  run_for_modules goword_for_package || return 255
-}
-
 function go_fmt_for_package {
   # We utilize 'go fmt' to find all files suitable for formatting,
   # but reuse full power gofmt to perform just RO check.

tests/common/lease_test.go

@@ -143,7 +143,7 @@ func TestLeaseGrantTimeToLiveExpired(t *testing.T) {
 				// back to follower and ignores the lease revoking.
 				// The new leader will restart TTL counting. If so,
 				// we should call time.Sleep again and wait for revoking.
-				// It can't avoid flakey but reduce flakey possiblility.
+				// It can't avoid flakey but reduce flakey possibility.
 				for i := 0; i < 3; i++ {
 					currentLeader := clus.WaitLeader(t)
 					t.Logf("[%d] current leader index %d", i, currentLeader)
@@ -192,7 +192,7 @@ func TestLeaseGrantKeepAliveOnce(t *testing.T) {
 				// back to follower and ignores the lease revoking.
 				// The new leader will restart TTL counting. If so,
 				// we should call time.Sleep again and wait for revoking.
-				// It can't avoid flakey but reduce flakey possiblility.
+				// It can't avoid flakey but reduce flakey possibility.
 				for i := 0; i < 3; i++ {
 					currentLeader := clus.WaitLeader(t)
 					t.Logf("[%d] current leader index %d", i, currentLeader)

tests/e2e/reproduce_20271_test.go

@@ -90,7 +90,7 @@ to override boltdb file. So, for the following changes, the third member will co
 		require.NoError(t, err)
 	}
 
-	t.Log("Step 7: Restart the third member. It recovers from the new boltdb file. Therefore, data writen in Step 6 is lost.")
+	t.Log("Step 7: Restart the third member. It recovers from the new boltdb file. Therefore, data written in Step 6 is lost.")
 	require.NoError(t, epc.Procs[2].Restart(ctx))
 
 	t.Log("Step 8: Check hashkv of each member")

tests/integration/tracing_test.go

@@ -168,7 +168,7 @@ func TestTracing(t *testing.T) {
 			rpc: func(ctx context.Context, cli *clientv3.Client) error {
 				_, err := cli.KeepAliveOnce(ctx, 2345)
 				if err != nil && strings.Contains(err.Error(), "requested lease not found") {
-					// errors.Is does not work accross gRPC bounduaries.
+					// errors.Is does not work across gRPC bounduaries.
 					return nil
 				}
 				return err
@@ -188,7 +188,7 @@ func TestTracing(t *testing.T) {
 			rpc: func(ctx context.Context, cli *clientv3.Client) error {
 				_, err := cli.Revoke(ctx, 1234)
 				if err != nil && strings.Contains(err.Error(), "requested lease not found") {
-					// errors.Is does not work accross gRPC bounduaries.
+					// errors.Is does not work across gRPC bounduaries.
 					return nil
 				}
 				return err
@@ -329,7 +329,7 @@ func testRPCTracing(t *testing.T, wantSpan *v1.Span, clientAction func(context.C
 	cfg.EnableDistributedTracing = true
 	cfg.DistributedTracingAddress = listener.Addr().String()
 	cfg.DistributedTracingServiceName = "integration-test-tracing"
-	cfg.DistributedTracingSamplingRatePerMillion = 100 // overriden later in the test
+	cfg.DistributedTracingSamplingRatePerMillion = 100 // overridden later in the test
 
 	// start an etcd instance with tracing enabled
 	etcdSrv, err := embed.StartEtcd(cfg)

tools/.golangci.yaml

@@ -6,6 +6,7 @@ linters:
     - errorlint
     - govet
     - ineffassign
+    - misspell
     - nakedret
     - revive
     - staticcheck

tools/etcd-dump-db/scan.go

@@ -31,7 +31,7 @@ func scanKeys(dbPath string, startRev int64) error {
 	for pageID := uint64(2); pageID < hwm; {
 		p, _, err := readPage(dbPath, pgSize, pageID)
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "Reading page %d failed: %v. Continuting...\n", pageID, err)
+			fmt.Fprintf(os.Stderr, "Reading page %d failed: %v. Continuing...\n", pageID, err)
 			pageID++
 			continue
 		}

tools/mod/go.mod

@@ -7,7 +7,6 @@ toolchain go1.25.3
 require (
 	github.com/alexfalkowski/gocovmerge v1.11.0
 	github.com/appscodelabs/license-bill-of-materials v0.0.0-20220707232035-6018e0c5287c
-	github.com/chzchzchz/goword v0.0.0-20170907005317-a9744cb52b03
 	github.com/cloudflare/cfssl v1.6.5
 	github.com/gogo/protobuf v1.3.2
 	github.com/golangci/golangci-lint/v2 v2.5.0
@@ -43,7 +42,6 @@ require (
 	github.com/Masterminds/semver/v3 v3.3.1 // indirect
 	github.com/MirrexOne/unqueryvet v1.2.1 // indirect
 	github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect
-	github.com/akhenakh/hunspellgo v0.0.0-20160221122622-9db38fa26e19 // indirect
 	github.com/alecthomas/chroma/v2 v2.20.0 // indirect
 	github.com/alecthomas/go-check-sumtype v0.3.1 // indirect
 	github.com/alexkohler/nakedret/v2 v2.0.6 // indirect
@@ -214,7 +212,6 @@ require (
 	github.com/timonwong/loggercheck v0.11.0 // indirect
 	github.com/tomarrell/wrapcheck/v2 v2.11.0 // indirect
 	github.com/tommy-muehle/go-mnd/v2 v2.5.1 // indirect
-	github.com/trustmaster/go-aspell v0.0.0-20200701131845-c2b1f55bec8f // indirect
 	github.com/ultraware/funlen v0.2.0 // indirect
 	github.com/ultraware/whitespace v0.2.0 // indirect
 	github.com/uudashr/gocognit v1.2.0 // indirect

tools/mod/go.sum

@@ -36,8 +36,6 @@ github.com/MirrexOne/unqueryvet v1.2.1/go.mod h1:IWwCwMQlSWjAIteW0t+28Q5vouyktfu
 github.com/OpenPeeDeeP/depguard/v2 v2.2.1 h1:vckeWVESWp6Qog7UZSARNqfu/cZqvki8zsuj3piCMx4=
 github.com/OpenPeeDeeP/depguard/v2 v2.2.1/go.mod h1:q4DKzC4UcVaAvcfd41CZh0PWpGgzrVxUYBlgKNGquUo=
 github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8/go.mod h1:I0gYDMZ6Z5GRU7l58bNFSkPTFN6Yl12dsUlAZ8xy98g=
-github.com/akhenakh/hunspellgo v0.0.0-20160221122622-9db38fa26e19 h1:bYOD6QJnBJY79MJQR1i9cyQePG5oNDZXDKL2bhN/uvE=
-github.com/akhenakh/hunspellgo v0.0.0-20160221122622-9db38fa26e19/go.mod h1:HcqyLXmWoESd/vPSbCPqvgw5l5cMM5PtoqFOnXLjSeM=
 github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0=
 github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
 github.com/alecthomas/chroma/v2 v2.20.0 h1:sfIHpxPyR07/Oylvmcai3X/exDlE8+FA820NTz+9sGw=
@@ -108,8 +106,6 @@ github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0G
 github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
 github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
 github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
-github.com/chzchzchz/goword v0.0.0-20170907005317-a9744cb52b03 h1:0wUHjDfbCAROEAZ96zAJGwcNMkPIheFaIjtQyv3QqfM=
-github.com/chzchzchz/goword v0.0.0-20170907005317-a9744cb52b03/go.mod h1:uFE9hX+zXEwvyUThZ4gDb9vkAwc5DoHUnRSEpH0VrOs=
 github.com/ckaznocha/intrange v0.3.1 h1:j1onQyXvHUsPWujDH6WIjhyH26gkRt/txNlV7LspvJs=
 github.com/ckaznocha/intrange v0.3.1/go.mod h1:QVepyz1AkUoFQkpEqksSYpNpUo3c5W7nWh/s6SHIJJk=
 github.com/cloudflare/cfssl v1.6.5 h1:46zpNkm6dlNkMZH/wMW22ejih6gIaJbzL2du6vD7ZeI=
@@ -494,8 +490,6 @@ github.com/tomarrell/wrapcheck/v2 v2.11.0 h1:BJSt36snX9+4WTIXeJ7nvHBQBcm1h2SjQMS
 github.com/tomarrell/wrapcheck/v2 v2.11.0/go.mod h1:wFL9pDWDAbXhhPZZt+nG8Fu+h29TtnZ2MW6Lx4BRXIU=
 github.com/tommy-muehle/go-mnd/v2 v2.5.1 h1:NowYhSdyE/1zwK9QCLeRb6USWdoif80Ie+v+yU8u1Zw=
 github.com/tommy-muehle/go-mnd/v2 v2.5.1/go.mod h1:WsUAkMJMYww6l/ufffCD3m+P7LEvr8TnZn9lwVDlgzw=
-github.com/trustmaster/go-aspell v0.0.0-20200701131845-c2b1f55bec8f h1:92ZQJRegaqnKjz9HY9an696Sw5EmAqRv0eie/U2IE6k=
-github.com/trustmaster/go-aspell v0.0.0-20200701131845-c2b1f55bec8f/go.mod h1:wxUiQ1klFJmwnM41kQI7IT2g8jjOKbtuL54LdjkxAI0=
 github.com/ultraware/funlen v0.2.0 h1:gCHmCn+d2/1SemTdYMiKLAHFYxTYz7z9VIDRaTGyLkI=
 github.com/ultraware/funlen v0.2.0/go.mod h1:ZE0q4TsJ8T1SQcjmkhN/w+MceuatI6pBFSxxyteHIJA=
 github.com/ultraware/whitespace v0.2.0 h1:TYowo2m9Nfj1baEQBjuHzvMRbp19i+RCcRYrSWoFa+g=