.typos.toml

# https://github.com/crate-ci/typos
# install:  cargo install typos-cli
# run:      typos

[files]
extend-exclude = [
  ".typos.toml",
  "*.snap",
  "crates/viewer/re_ui/src/design_tokens.rs",
  "examples/assets",
  "rerun_cpp/src/rerun/archetypes/image.hpp", # TODO(emilk): remove once we remove from_greyscale8
  "rerun_cpp/src/rerun/archetypes/image_ext.cpp", # TODO(emilk): remove once we remove from_greyscale8
  "rerun_cpp/src/rerun/third_party/cxxopts.hpp",
  "*.png",
  "*.mp4",
  "*.rrd",
]

[default.extend-words]
FUL = "FUL" # forward-up-left coordinate system
Isse = "Isse" # It's a name
lod = "lod" # level-of-detail
ND = "ND" # np.NDArray
opf = "opf" # Open Photogrammetry Format (OPF) file
somes = "somes" # many `Some`
teh = "teh" # part of @teh-cmc
trak = "trak" # mp4 crate spelling
typ = "typ" # We cannot write "type" in rust
writeable = "writeable" # NumPy's attribute is `ndarray.flags.writeable`, not `writable`
ws = "ws" # web-sockets, as in "ws://…"
Yoh = "Yoh" # Part of @YohDeadfall

# Use the more common spelling
adaptor = "adapter"
adaptors = "adapters"

# For consistency we prefer American English:
aeroplane = "airplane"
analogue = "analog"
analyse = "analyze"
appetiser = "appetizer"
arbour = "arbor"
armour = "armor"
artefact = "artifact"
authorise = "authorize"
behaviour = "behavior"
calibre = "caliber"
#cancelled = "canceled" # allow 'cancelled' since Arrow uses it.
candour = "candor"
capitalise = "capitalize"
catalogue = "catalog"
centre = "center"
characterise = "characterize"
chequerboard = "checkerboard"
chequered = "checkered"
civilise = "civilize"
clamour = "clamor"
colonise = "colonize"
colour = "color"
coloured = "colored"
cosy = "cozy"
criticise = "criticize"
defence = "defense"
demeanour = "demeanor"
dialogue = "dialog"
distil = "distill"
doughnut = "donut"
dramatise = "dramatize"
draught = "draft"
emphasise = "emphasize"
endeavour = "endeavor"
enrol = "enroll"
epilogue = "epilog"
equalise = "equalize"
favour = "favor"
favourite = "favorite"
fibre = "fiber"
flavour = "flavor"
fulfil = "fufill"
gaol = "jail"
grey = "gray"
greys = "grays"
greyscale = "grayscale"
harbour = "habor"
honour = "honor"
humour = "humor"
instalment = "installment"
instil = "instill"
jewellery = "jewelry"
kerb = "curb"
labour = "labor"
litre = "liter"
lustre = "luster"
meagre = "meager"
metre = "meter"
mobilise = "mobilize"
monologue = "monolog"
naturalise = "naturalize"
neighbour = "neighbor"
neighbourhood = "neighborhood"
normalise = "normalize"
normalised = "normalized"
odour = "odor"
offence = "offense"
organise = "organize"
parlour = "parlor"
plough = "plow"
popularise = "popularize"
pretence = "pretense"
programme = "program"
prologue = "prolog"
rancour = "rancor"
realise = "realize"
recognise = "recognize"
recognised = "recognized"
rigour = "rigor"
rumour = "rumor"
sabre = "saber"
satirise = "satirize"
saviour = "savior"
savour = "savor"
sceptical = "skeptical"
sceptre = "scepter"
sepulchre = "sepulcher"
serialisation = "serialization"
serialise = "serialize"
serialised = "serialized"
skilful = "skillful"
sombre = "somber"
specialisation = "specialization"
specialise = "specialize"
specialised = "specialized"
splendour = "splendor"
standardise = "standardize"
sulphur = "sulfur"
symbolise = "symbolize"
theatre = "theater"
tonne = "ton"
travelogue = "travelog"
tumour = "tumor"
valour = "valor"
vaporise = "vaporize"
vigour = "vigor"
# End of American English section

# null-terminated is the name of the wikipedia article!
# https://en.wikipedia.org/wiki/Null-terminated_string
nullterminated = "null-terminated"
zeroterminated = "null-terminated"
zero-terminated = "null-terminated"

[default]
extend-ignore-re = [
  # Work around for typos inside of hashes. These show up inside of ipynb.
  # e.g. "f4e1caf9" -> `caf` should be `calf`
  # Specifically limit ourselves to exactly 8 chars in a quoted string, or
  # 16 character hashses following a leading underscore.
  # Just don't spell "defaced" wrong.
  "\"[a-f0-9]{8}\"",
  "_[a-f0-9]{16}",


  "np.arange", # Stands for "array range" and isn't a misspelling of "arrange".
  "phc_[a-zA-Z0-9]*", # Posthog public key
  "PNG.?", # Workaround for https://github.com/crate-ci/typos/issues/967

  "_LEVL_", # Used in air_traffic_data.py

  "thrEEone", # Used in a test

  "notify_seeked", # Used in the `mcap` crate.

  # There's a crate with this name.
  "cros_codecs",
  "cros-codecs",

  "Secur32", # Referring to `Secur32.dll` on Windows.

  "muh_scalars", # Weird name introduced in `crates/viewer/re_view_time_series/tests/basic.rs` introduced in https://github.com/rerun-io/rerun/pull/10713

  "isse", # Name

  "@[a-zA-Z]+", # GitHub user names

  "\\[[a-f0-9]{7}\\]\\(https://github\\.com/rerun-io/rerun/commit/", # Commit SHA links in changelog

  "SELECTed", # Past tense of SQL SELECT
]