|
| 1 | +# Configuration for typos (https://github.com/crate-ci/typos), run via the prek |
| 2 | +# hook in .pre-commit-config.yaml. |
| 3 | +# |
| 4 | +# Before adding an entry here, consider an in-place marker instead. Use one when |
| 5 | +# the word is correct at this one site and would still be a typo elsewhere: |
| 6 | +# |
| 7 | +# # spellchecker:disable-line at the end of the line it applies to |
| 8 | +# # spellchecker:ignore-next-line on its own line, above the offending line |
| 9 | +# # spellchecker:off / :on around a block |
| 10 | +# |
| 11 | +# Every entry below gets a one-line comment saying what the word is. |
| 12 | + |
| 13 | +[files] |
| 14 | +# Bare `typos` skips hidden dirs by default, but prek passes explicit paths and |
| 15 | +# so does check them. Turn it off so both agree. |
| 16 | +ignore-hidden = false |
| 17 | + |
| 18 | +extend-exclude = [ |
| 19 | + # `.git` itself, which ignore-hidden = false would otherwise pull in. |
| 20 | + ".git/", |
| 21 | + # Generated by generate-embeddings-local.py from a crawl of |
| 22 | + # docs.stackable.tech. Typos in it belong to the documentation repository. |
| 23 | + "demos/opensearch-rag/embeddings/stackable-docs-embeddings.json", |
| 24 | + # Base64-encoded demo key material, not prose. |
| 25 | + "stacks/argo-cd-git-ops/secrets/sealed-secrets-key.yaml", |
| 26 | +] |
| 27 | + |
| 28 | +[default] |
| 29 | +# typos has no native suppression directive |
| 30 | +# (https://github.com/crate-ci/typos/issues/316), so these regexes provide one. |
| 31 | +# They cover `#`, `//`, `<!-- -->`, `;`, `/* */` and Jinja `{# #}` comments, |
| 32 | +# which spans every file type in this repo. |
| 33 | +# |
| 34 | +# Both failure modes are safe: |
| 35 | +# * unterminated `:off` suppresses nothing rather than swallowing the rest of the file. |
| 36 | +# * `disable-line` only matches when the marker ends the line. |
| 37 | +extend-ignore-re = [ |
| 38 | + "(?Rm)^.*(#|//|<!--|;|/\\*)\\s*spellchecker:disable-line\\s*(-->|#\\}|\\*/)?\\s*$", |
| 39 | + "(#|//|<!--|;|/\\*)\\s*spellchecker:ignore-next-line\\s*(-->|#\\}|\\*/)?\\s*\\n.*", |
| 40 | + "(?s)(#|//|<!--|;|/\\*|\")\\s*spellchecker:off\\s*(-->|#\\}|\\*/|\")?.*?(#|//|<!--|;|/\\*|\")\\s*spellchecker:on\\s*(-->|#\\}|\\*/|\")?", |
| 41 | + # Random Kafka topic IDs in `kafka-topics.sh --describe` output. They sit |
| 42 | + # inside AsciiDoc listing blocks, where a marker would render verbatim. |
| 43 | + "TopicId:\\s*\\S+", |
| 44 | +] |
| 45 | + |
| 46 | +[type.jupyter] |
| 47 | +# Random notebook cell IDs. JSON has no comments, so no marker can go here. |
| 48 | +extend-ignore-re = [ |
| 49 | + "\"id\": \"[0-9a-z]+\"", |
| 50 | +] |
| 51 | + |
| 52 | +[default.extend-words] |
| 53 | +# Azure Kubernetes Service. Appears in docs/modules/demos/pages/argo-cd-git-ops.adoc. |
| 54 | +# A single lowercase entry covers every casing, so no separate `AKS` entry is needed. |
| 55 | +aks = "aks" |
| 56 | +# Apache Druid's ingestion row-stats field name, referenced verbatim in the |
| 57 | +# Druid demo docs. |
| 58 | +unparseable = "unparseable" |
0 commit comments