Merge pull request #55 from 4rivappa/spell-lint

feat: add spell check - misspell

Author: k8s-ci-robot

Makefile

@@ -87,9 +87,11 @@ test-e2e: chainsaw # Run e2e tests against the K8s cluster specified in ~/.kube/
 	$(CHAINSAW) test --values ./test/e2e/values.yaml
 
 .PHONY: lint
-lint: golangci-lint.client golangci-lint.controller golangci-lint.sidecar ## Run all linters (suggest `make -k`)
+lint: golangci-lint.client golangci-lint.controller golangci-lint.sidecar spell-lint ## Run all linters (suggest `make -k`)
 golangci-lint.%: golangci-lint
 	cd $* && $(GOLANGCI_LINT) run $(GOLANGCI_LINT_RUN_OPTS) --config $(CURDIR)/.golangci.yaml --new
+spell-lint:
+	git ls-files | grep -v -e CHANGELOG -e go.mod -e go.sum -e vendor | xargs $(SPELL_LINT) -i "Creater,creater,ect" -error -o stderr
 
 .PHONY: lint-fix
 lint-fix: golangci-lint-fix.client golangci-lint-fix.controller golangci-lint-fix.sidecar ## Run all linters and perform fixes where possible (suggest `make -k`)
@@ -167,6 +169,7 @@ GOLANGCI_LINT ?= $(TOOLBIN)/golangci-lint
 KIND          ?= $(TOOLBIN)/kind
 KUSTOMIZE     ?= $(TOOLBIN)/kustomize
 MDBOOK        ?= $(TOOLBIN)/mdbook
+SPELL_LINT    ?= $(TOOLBIN)/spell-lint
 
 # Tool Versions
 CHAINSAW_VERSION      ?= v0.2.12
@@ -176,6 +179,7 @@ GOLANGCI_LINT_VERSION ?= v1.64.7
 KIND_VERSION          ?= v0.27.0
 KUSTOMIZE_VERSION     ?= v5.6.0
 MDBOOK_VERSION        ?= v0.4.47
+SPELL_LINT_VERSION    ?= v0.6.0
 
 .PHONY: chainsaw
 chainsaw: $(CHAINSAW)-$(CHAINSAW_VERSION)
@@ -212,6 +216,11 @@ mdbook: $(MDBOOK)-$(MDBOOK_VERSION)
 $(MDBOOK)-$(MDBOOK_VERSION): $(TOOLBIN)
 	./hack/tools/install-mdbook.sh $(MDBOOK) $(MDBOOK_VERSION)
 
+.PHONY: spell-lint
+spell-lint: $(SPELL_LINT)-$(SPELL_LINT_VERSION)
+$(SPELL_LINT)-$(SPELL_LINT_VERSION): $(TOOLBIN)
+	./hack/tools/install-misspell-lint.sh $(TOOLBIN) $(SPELL_LINT) $(SPELL_LINT_VERSION)
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed

README.md

@@ -29,7 +29,7 @@ Create a new issue raising a RFC for the changes following this format:
 **Description:**
 > 1. Protocol:
 > 2. Fields Added:
-> 3. Why is this change neccessary?
+> 3. Why is this change necessary?
 >    ...(describe why here)...
 > 4. Which other COSI projects are affected by this change?
 > 5. Upgrade plan

hack/tools/install-misspell-lint.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -eu
+
+TOOLBIN="${1}"
+SPELL_LINT="${2}"
+SPELL_LINT_VERSION="${3}"
+
+# If it exists, do not redownload
+if [ -f "${SPELL_LINT}-${SPELL_LINT_VERSION}" ]; then
+  exit 0
+fi
+
+INSTALLER="https://raw.githubusercontent.com/golangci/misspell/master/install-misspell.sh"
+
+curl -sSfL "${INSTALLER}" | sh -s -- -b "${TOOLBIN}" "${SPELL_LINT_VERSION}"
+
+mv "${TOOLBIN}/misspell" "${SPELL_LINT}-${SPELL_LINT_VERSION}"
+ln -sf "${SPELL_LINT}-${SPELL_LINT_VERSION}" "${SPELL_LINT}"

sidecar/pkg/bucket/bucket_controller.go

@@ -264,7 +264,7 @@ func (b *BucketListener) Update(ctx context.Context, old, new *v1alpha1.Bucket)
 	return nil
 }
 
-// Delete attemps to delete a bucket. This function must be idempotent
+// Delete attempts to delete a bucket. This function must be idempotent
 // Delete function is called when the bucket was not able to add finalizers while creation.
 // Hence we will take care of removing the BucketClaim finalizer before deleting the Bucket object.
 // Return values

sidecar/pkg/bucketaccess/bucketaccess_controller.go

@@ -321,7 +321,7 @@ func (bal *BucketAccessListener) Update(ctx context.Context, old, new *v1alpha1.
 	return nil
 }
 
-// Delete attemps to delete a bucketAccess. This function must be idempotent
+// Delete attempts to delete a bucketAccess. This function must be idempotent
 // Return values
 //   - nil - BucketAccess successfully deleted
 //   - non-nil err - Internal error                                [requeue'd with exponential backoff]

test/e2e/chainsaw-test.yaml

@@ -253,7 +253,7 @@ spec:
                     items:
                     - key: BucketInfo
                       path: BucketInfo
-  - name: Check if ObjectStorage validation tool completed succesfully
+  - name: Check if ObjectStorage validation tool completed successfully
     try:
     - assert:
         resource: