feat: Rollout crate/typos for operators (#818)

* chore: Generated commit to update templated files since the last template run up to stackabletech/operator-templating@0f53eec

Reference-to: stackabletech/operator-templating@0f53eec (feat: Rollout crate/typos for operators)

* chore: Add typos.toml and fix spelling findings

---------

Co-authored-by: Maxi Wittich <maximilian.wittich@stackable.tech>

Author: stackable-bot

.pre-commit-config.yaml

@@ -7,6 +7,19 @@ default_language_version:
   node: system
 
 repos:
+  # The word lists live in a per-repo `typos.toml`, which is not templated.
+  # typos has no layered configuration (https://github.com/crate-ci/typos/issues/193).
+  # A templated config can currently not be extended locally.
+  - repo: https://github.com/crate-ci/typos
+    rev: 00f422f3b19c57bc6338715ebfe3316d38768461  # v1.50.3
+    hooks:
+      - id: typos
+        # Drop the upstream default `--write-changes` so the hook only
+        # reports failures instead of writing changes.
+        # Keep `--force-exclude` so the excludes in typos.toml still
+        # apply to the paths prek passes in.
+        args: ["--force-exclude"]
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c # 6.0.0
     hooks:

docs/modules/hbase/pages/getting_started/first_steps.adoc

@@ -75,7 +75,7 @@ include::example$getting_started/hbase.yaml[]
 
 To test the cluster, use the REST API to check its version and status, and to create and inspect a new table.
 Use Phoenix to create, populate and query a second new table, before listing all non-system tables in HBase.
-These actions wil be carried out from one of the HBase components, the REST server.
+These actions will be carried out from one of the HBase components, the REST server.
 
 First, check the cluster version with this callout:
 

tests/templates/kuttl/kerberos/02-create-kerberos-secretclass.yaml.j2

@@ -47,7 +47,7 @@ metadata:
   name: secret-operator-keytab
 data:
 {% if test_scenario['values']['kerberos-backend'] == 'mit' %}
-  # To create keytab. When promted enter password asdf
+  # To create keytab. When prompted enter password asdf
   # cat | ktutil << 'EOF'
   # list
   # add_entry -password -p stackable-secret-operator@CLUSTER.LOCAL -k 1 -e aes256-cts-hmac-sha384-192

tests/templates/kuttl/opa/02-create-kerberos-secretclass.yaml.j2

@@ -28,7 +28,7 @@ kind: Secret
 metadata:
   name: secret-operator-keytab
 data:
-  # To create keytab. When promted enter password asdf
+  # To create keytab. When prompted enter password asdf
   # cat | ktutil << 'EOF'
   # list
   # add_entry -password -p stackable-secret-operator@CLUSTER.LOCAL -k 1 -e aes256-cts-hmac-sha384-192

tests/templates/kuttl/shutdown/50-assert.yaml

@@ -2,9 +2,9 @@
 # This test works as follows:
 # - given
 #   - an HBase cluster with two region servers (0 and 1)
-#   - create a table + column familiy with 15 regions
+#   - create a table + column family with 15 regions
 #   - where region server 0 has some regions assigned to it
-# - restart server 0 (the region mover is triggerred by the shutdown)
+# - restart server 0 (the region mover is triggered by the shutdown)
 # - assert that server 1 now hosts all 15 regions
 apiVersion: kuttl.dev/v1beta1
 kind: TestAssert

typos.toml

@@ -0,0 +1,42 @@
+# Configuration for typos (https://github.com/crate-ci/typos), run via the prek
+# hook in .pre-commit-config.yaml.
+
+[files]
+# Bare `typos` skips hidden dirs by default, but prek passes explicit paths and
+# so does check them. Turn it off so both agree.
+ignore-hidden = false
+
+extend-exclude = [
+    # Ignore `.git`, which the above `ignore-hidden = false` would otherwise pull in.
+    ".git/",
+    # Generated by crate2nix (`make regenerate-nix`). Already skipped by the prek
+    # top-level `exclude`; listed here so a bare `typos` run agrees.
+    "Cargo.nix",
+    # Generated by `make regenerate-charts` from the Rust doc comments, which are
+    # checked at their source. The rest is Kubernetes' own schema documentation.
+    "extra/crds.yaml",
+]
+
+[default]
+# typos has no native suppression directive
+# (https://github.com/crate-ci/typos/issues/316), so these regexes provide one.
+# A marker must sit in a comment: after `#`, `//` or `;` (free text may follow),
+# or inside a closed `<!-- -->`, `/* */` or `{# #}` (free text may precede the
+# closer). An unterminated `typos:ignore-block-start` suppresses nothing.
+#
+# Use one of the following when the word is correct at one place but would still be a typo elsewhere:
+#
+#   # typos:ignore-line        at the end of the line it applies to
+#   # typos:ignore-next-line   on its own line, above the offending line
+#   # typos:ignore-block-start / typos:ignore-block-end   around a block
+extend-ignore-re = [
+    '(?Rm)^.*?(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-line\b.*|(?:<!--[ \t]*typos:ignore-line\b.*?-->|/\*[ \t]*typos:ignore-line\b.*?\*/|\{#[ \t]*typos:ignore-line\b.*?#\})[ \t]*)$',
+    '(?Rm)^[ \t]*(?:(?:#|//|;)[ \t]*typos:ignore-next-line\b.*|(?:<!--[ \t]*typos:ignore-next-line\b.*?-->|/\*[ \t]*typos:ignore-next-line\b.*?\*/|\{#[ \t]*typos:ignore-next-line\b.*?#\})[ \t]*)\r?\n.*$',
+    '(?ms)(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-block-start\b|<!--[ \t]*typos:ignore-block-start\b[^\n]*?-->|/\*[ \t]*typos:ignore-block-start\b[^\n]*?\*/|\{#[ \t]*typos:ignore-block-start\b[^\n]*?#\}).*?(?:(?:^|[^{])(?:#|//|;)[ \t]*typos:ignore-block-end\b|<!--[ \t]*typos:ignore-block-end\b[^\n]*?-->|/\*[ \t]*typos:ignore-block-end\b[^\n]*?\*/|\{#[ \t]*typos:ignore-block-end\b[^\n]*?#\})',
+]
+
+# Before adding an entry in here, consider an in-place marker instead.
+# Every entry below gets a one-line comment saying what the word is.
+[default.extend-words]
+# Azure Kubernetes Service
+aks = "aks"