treefmt: init typos check

[qweered]

• Built on platform:
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• Tested, as applicable:
  • NixOS tests in nixos/tests.
  • Package tests at passthru.tests.
  • Tests in lib/tests or pkgs/test for functions and "core" functionality.
• Ran nixpkgs-review on this PR. See nixpkgs-review usage.
• Tested basic functionality of all binary files, usually in ./result/bin/.
• Nixpkgs Release Notes
  • Package update: when the change is major or breaking.
• NixOS Release Notes
  • Module addition: when adding a new NixOS module.
  • Module update: when the change is significant.
• Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

---

Add a 👍 reaction to pull requests you find important.

[qweered]

Ok so the process is pretty straightforward now, i dont expect architectural changes. i'll finish nixos directory and call it quits for now, pkgs directory may be enabled in future prs

[qweered]

Renamed because of typos error

[qweered]

We should aggree on this

Type: String (en, en-us, en-gb, en-ca, en-au)
Default: en
English dialect to correct to.

If set to en, words will be corrected to the closest spelling, regardless of which dialect that correction is part of.

[qweered]

Very strange, nix fmt or nix develop --command treefmt doesnt show any errors locally

[sternenseemann]

Blocking merges on minor misspellings doesn't make sense to me.

[RossComputerGuy]

This seems trivial to have and is effectively another linter. Now, spelling isn't the most important thing in the world but it does scratch that itch that some people may have when they notice typos.

[SigmaSquadron]

I feel like the downsides outweigh the benefits here. A large section of files are blocklisted by default, and another large section of files will need constant # typos: ignore-next-line comments that do nothing but clutter code. Having a separate config file hidden away in ci/ is also horrible UX for new contributors who happen to add a new file that has an unrecognised but correctly spelled noun in it.

Finally, I don't know if there's a tangible benefit for any of this. Most people using NixOS won't be reading the corrected code comments anyways. The only benefit I see from a typos linter is if it's restricted to option descriptions in nixos/modules, meta.{longD,d}escription attributes for packages and .md files in {,nixos/}doc, as that's where most people would see typos anyway.

[hsjobeki]

I'm leaning towards the direction of @SigmaSquadron.
Let's enable typo checking where it matters most first.
That is documentation. Smallest subset being .md files.

We can extend that later to options and doc-comments, which also lands in documentation.

On the devX part there should be a good way to execute our linters locally.

[qweered]

Aggree, will think about ways how no implement that