typos.toml

# 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]*?#\})',
    # Random draw.io cell IDs in `.drawio.svg` files, both in the rendered SVG
    # (`data-cell-id="..."`) and in the embedded diagram source (`id=&quot;...&quot;`).
    '(?:id|source|target|parent)=(?:"|&quot;)[A-Za-z0-9_-]{20}-\d+',
    # Random OpenSearch node and ephemeral IDs, as in `DiscoveryNode{...}{jcXCasAwSf6wTxND431bnw}`
    # log lines in docs and test fixtures.
    '\{[A-Za-z0-9_-]{22}\}',
]

# 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"