Add Spell Checking in CI (#12)

metal-stack · Jan 10, 2025 · 0995543 · 0995543
1 parent b4ba1c9
commit 0995543
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -24,3 +24,6 @@ jobs:
 
       - name: Run Linter
         uses: golangci/golangci-lint-action@v6
+
+      - name: Check spelling
+        uses: crate-ci/typos@master
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,16 @@
+[default]
+extend-ignore-re = [
+    # This enables # spellchecker:disable-line
+    "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+    # This enables # spellchecker:off/on
+    "(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on",
+]
+
+[default.extend-words]
+
+
+[files]
+extend-exclude = [
+    "go.mod",
+    "go.sum",
+]
diff --git a/internal/controller/metalstackcluster_controller.go b/internal/controller/metalstackcluster_controller.go
@@ -120,7 +120,7 @@ func (r *MetalStackClusterReconciler) Reconcile(ctx context.Context, req ctrl.Re
 		if statusErr != nil {
 			err = errors.Join(err, fmt.Errorf("unable to update status: %w", statusErr))
 		} else if !reconciler.infraCluster.Status.Ready {
-			err = errors.New("cluster is not yet ready, requeueing")
+			err = errors.New("cluster is not yet ready, requeuing")
 		}
 	}()
 

diff --git a/internal/controller/metalstackmachine_controller.go b/internal/controller/metalstackmachine_controller.go
@@ -145,7 +145,7 @@ func (r *MetalStackMachineReconciler) Reconcile(ctx context.Context, req ctrl.Re
 		if statusErr != nil {
 			err = errors.Join(err, fmt.Errorf("unable to update status: %w", statusErr))
 		} else if !reconciler.infraMachine.Status.Ready {
-			err = errors.New("machine is not yet ready, requeueing")
+			err = errors.New("machine is not yet ready, requeuing")
 		}
 	}()