coreinfrastructure / best-practices-badge

🏆Open Source Security Foundation (OpenSSF) Best Practices Badge (formerly Core Infrastructure Initiative (CII) Best Practices Badge)
https://www.bestpractices.dev
MIT License
1.22k stars 202 forks source link

codespell: take it to the next level #2167

Open szepeviktor opened 2 months ago

szepeviktor commented 2 months ago

typos works a bit better.

./.rubocop.yml:127:44: `diffult` -> `difficult`
./app/assets/javascripts/project-form.js:161:19: `requrired` -> `required`
./config/initializers/rack_attack.rb:77:27: `sercurity` -> `security`
./lib/tasks/default.rake:495:3: `Ths` -> `The`, `This`
./lib/tasks/default.rake:695:34: `runnning` -> `running`
./db/migrate/20170626143755_add_prequisites_to_criteria.rb:20: `prequisites` -> `prerequisites`
./db/migrate/20170626143755_add_prequisites_to_criteria.rb:3:10: `Prequisites` -> `Prerequisites`
./docs/background.md:1612:46: `caculation` -> `calculation`
./docs/background.md:1618:53: `caculation` -> `calculation`
./docs/background.md:1618:97: `caculation` -> `calculation`
./docs/design.md:307:8: `Contoller` -> `Controller`
./docs/design.md:418:16: `satifying` -> `satisfying`
./docs/assurance-case.md:3383:39: `antoher` -> `another`
./docs/other.md:1590:47: `Occurence` -> `Occurrence`
./test/controllers/project_stats_controller_test.rb:186:8: `Projets` -> `Projects`
./.github/dependabot.yml:29:67: `licnese` -> `license`

Would you upgrade?

david-a-wheeler commented 2 months ago

I presume you mean https://github.com/crate-ci/typos

That's also OSS, so I can certainly consider it. We'd have to change what we invoke in our workflow. We'll also have to do some reconfiguring, since we have a number of non-English files.

No matter what, we should fix the typos noted. They aren't a BIG deal, but it'd be nice to do so.

szepeviktor commented 2 months ago

have to do some reconfiguring,

Here is .typos.toml for you.

[files]
extend-exclude = [
    ".git/",
    ".codespellignore",
    "config/locales/",
    "test/vcr_cassettes/*.yml",
]
ignore-hidden = false

[default]
extend-ignore-re = [
    "[0-9A-Za-z/+]{76}",
    "Synopsys' Protecode",
    "Jonathan Suh",
    "mis à jour",
    "du site Web du projet",
    "les projets de logiciel",
]

[default.extend-words]
# No such English word
requestor = "requestor"

[default.extend-identifiers]
HELO = "HELO"
WXwindows = "WXwindows"

# Typos
#"Github" = "GitHub"