codespell: config, github action (to detect new typos), and 2 typos fixed #65
Conversation
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Codecov Report
@@ Coverage Diff @@
## main #65 +/- ##
=======================================
Coverage 66.80% 66.80%
=======================================
Files 10 10
Lines 946 946
Branches 198 198
=======================================
Hits 632 632
Misses 291 291
Partials 23 23
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Hi @yarikoptic, thanks for the contribution. However, I am not comfortable adding a new CI element that I'm not familiar with. can you point to a way to run this spell checker locally? |
This PR isolates the typo fixes proposed in #65. I'm still not comfortable to add a new CI script without an explanation of how to run it locally, so this just takes the concrete changes from that PR. --------- Co-authored-by: Yaroslav Halchenko <[email protected]>
|
I upstreamed the typo fixes from this PR in #75 then tried to switch from using the proposed GitHub Action to something explicit in my tox configuration. Now, they are in the Tests / Lint action. However, I'm getting some false positives. How should I go about addressing these? |
|
sorry, missed initial comment! FWIW I like the strategy of encoding running as for false positives, depends on the kind. Checkout https://github.com/codespell-project/codespell/blob/main/README.rst#ignoring-words , and you have that |
| [tool.codespell] | ||
| skip = '.git,*.pdf,*.svg' | ||
| # | ||
| # ignore-words-list = '' |
There was a problem hiding this comment.
| # ignore-words-list = '' | |
| # ignore-words-list = '' | |
| ignore-regex = "\bassertIn\b" |
For case sensitive matching IIRC (adding whole on mobile)
There was a problem hiding this comment.
I'm just wondering if this will always be something I have to chase. How does it deal with function names, which might be out of my control if they don't match?
There was a problem hiding this comment.
there is such a common fear ;) in the projects using CamelCase or some other mixedCase, I just add regex to catch those, smth like (pick your poison)
❯ grep ignore-regex.*A-Z */.codespellrc
alphafold/.codespellrc:ignore-regex = (^\s*"image/\S+": ".*|\b[A-Z]+\b)
citation-file-format/.codespellrc:ignore-regex = ["`][A-Z][A-Z]["`]
gdcm-gdcm/.codespellrc:ignore-regex = \b([A-Z]+|[A-Z][a-z]*)\b
hpc-toolkit/.codespellrc:ignore-regex = HETATM -e CONECT|\([A-Z]\)[a-z]+
hugo/.codespellrc:ignore-regex = .*TE\?MP.*|.*codespell-ignore.*|[A-Z]?[a-z]*[A-Z][a-zA-Z]*|/extras/crossreferences/|Januar 2023|\\ndoes|.*ä.*
lazydocker/.codespellrc:ignore-regex = (\b[A-Za-z][a-z]*[A-Z]\S+\b|\.edn\b|\S+…|\\nd\b)
lazygit/.codespellrc:ignore-regex = (\b[A-Za-z][a-z]*[A-Z]\S+\b|\.edn\b|\S+…|\\nd\b)
NeuroML-Documentation/.codespellrc:ignore-regex = ^\s*"image/\S+": ".*|\b[a-z]*[A-Z][a-zA-Z]*\b
qlever/.codespellrc:ignore-regex = \b([A-Z]*[a-z]+[A-Z][a-zA-Z]*)\b|.*(Lorem ipsum|eleifend|feugait|codespell-ignore).*
quarto/.codespellrc:ignore-regex = \b[a-z]+[A-Z][A-Za-z]*\b
remark/.codespellrc:ignore-regex = \b(Hart|[A-Z]+)\b|.{300,}.*
saunafs/.codespellrc:ignore-regex = \b[A-Z]*[a-z]+[A-Z][A-Za-z]*\b|/mnt/[a-z0-9]+|.*\bcodespell-ignore\b.*
scidata/.codespellrc:ignore-regex = .*[úáüéè].*|\b[A-Z]+\b|\bvalue=".."
webknossos/.codespellrc:ignore-regex = \b(Manuel|[a-z]+[A-Z][a-zA-Z]*|H Mattern|Nat Commun|couldn't)\bbut as you can see here it was just a single hit, so I personally would not sweat for now. ;-) generally it is better to avoid names (variables, arguments, or functions alike) coming close to typos.
No description provided.