Add typos - Source code spell checker

[ameknite]

Objective

• Avoid misspellings throughout the codebase by using typos in CI

Inspired by gfx-rs/wgpu#5191

Typos is a minimal code speller written in rust that finds and corrects spelling mistakes among source code.

• Fast enough to run on monorepos
• Low false positives so you can run on PRs

Solution

• Use typos-action in CI
• Add how to use typos in the Contribution Guide

[mockersf]

prior attempt: #8324

[alice-i-cecile]

Honestly I'm very impressed with the results. All of the fixes look real. How do we add false positives to an allow list?

Can you split the fixes out of this PR? I'd really like to merge them ASAP so they don't go stale: adding a spellchecker to CI is likely to be much more contentious than just fixing typos :)

[ameknite]

How do we add false positives to an allow list?

in typos.toml

you can add words:

[default.extend-words]
# Things that aren't typos
LOD = "LOD" # Level of detail

or just ignore them in :

extend-ignore-identifiers-re = [
  "NDK", # NDK - Native  Development Kit
]

[doonv]

Bevy has a lot more typos than I thought. This seems like a great addition to the CI!

Will fixing the typos be in the scope of this PR? I suggest you create another PR that fixes all the typos, merge that first, then merge this one.

[mockersf]

Will fixing the typos be in the scope of this PR? I suggest you create another PR that fixes all the typos, merge that first, then merge this one.

#12038

[mockersf]

is it possible to have the configuration file not in the root directory?

[ameknite]

with typos-cli you can do this:
typos --config <CUSTOM_CONFIG>

but you will need to specify the path every time, I don't like it

[alice-i-cecile]

I'm in favor of this at this point: I'm impressed with how easy this is to configure, and the very low rate of false positives.

I'm not 100% keen on adding another root-level file for this, but unless IDE support works with it elsewhere I think we should keep it. I don't mind at all having to specify a different path in CI.

However: I'd like to add this to the ci utility in the tools crate (which probably changes how the action works). Being able to invoke "check everything locally" is very helpful.

[ameknite]

Every action in the ci utility uses cargo, is ok that just panic if the user doesn't have typos installed?

Idk about adding typos to the ci utility. We also don't have the toml and markdown formatting there.

And I honestly don't understand the concern of adding a new file to the root-level, isn't that just aesthetic or is there some limitation that I don't know about?

[alice-i-cecile]

Idk about adding typos to the ci utility. We also don't have the toml and markdown formatting there.

Hmm okay. Leave it as is then.

And I honestly don't understand the concern of adding a new file to the root-level, isn't that just aesthetic or is there some limitation that I don't know about?

Yeah, this is just aesthetic clutter. It makes it harder to orient yourself when visiting the repo, especially for the first time. Ideally it would be in .github.

[soqb]

always wished for a cross-platform secondary default, something like project/etc/typos.toml but alas.

[soqb]

it looks like there are still some changes to CHANGELOG.md and assets/textures/rpg/ui/**; other than that i think this is really useful.

[ameknite]

true, I messed up.
fixed

[NiklasEi]

This is awesome 👍

[ameknite]

I'm not familair with the code in bevy_mikktspace.
"iFO",
"vOt",
"fLenOt",
idk what these variables mean so I leave them without a comment.

[alice-i-cecile]

Yeah bevy_mikktspace is something of a disaster zone: it's machine-translated unsafe C code that we adopted. That's a fine solution for now.

[alice-i-cecile]

Merging. I'm going to leave this as an optional CI check for a while until we get a sense of the false positives and robustness (and to give older PRs a grace period where they don't need to be rebased). Once we're happy with it, I'll add it to our branch protection checks.