Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix few typos#78

Open
yarikoptic wants to merge 8 commits into0atman:mainfrom
yarikoptic:enh-codespell
Open

Add codespell support (config, workflow to detect/not fix) and make it fix few typos#78
yarikoptic wants to merge 8 commits into0atman:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

Was lead here by a YouTube video... decided to check things out ;-)

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "git-sedi Svelt Svelte",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2 ./scripts/05-stop-writing-rust.md ./scripts/32-rust-is-written-in-rust.md",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
…agically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@0atman
Copy link
Copy Markdown
Owner

0atman commented Nov 29, 2024

interesting, how does it compare to languagetool?

@yarikoptic
Copy link
Copy Markdown
Author

dunno since I never used languagetool! But from its description of being a "spellchecker" I would assume that the principled difference is that codespell just corrects typos it has in its dictionaries, not all possible spell fixes. This way it achieves quite low false positives rate.

* origin/main:
  add rule & fix typo
  Introduce mental health discussion guidelines
  Update README.md
  Update README.md
  fix(typo): Spelling of "environment"
  public 43
  final 43
  bye bye blockchain
  plans
  Update scripts/43-ai-is-not-designed-for-you.md
  patreon 43
  translate file:35-adhd-a-left-handed-brain.md and image:tris-fake-wikipedia-contents.png
  Added Mandarin translation and set up readme file
…os automagically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@yarikoptic-test
Copy link
Copy Markdown

FWIW, merged master and reran fixes. Please let me know if interested or we should forget about it so in either case I could remove this heavy'ish repository (I wish git-lfs or git-annex was used for binary heavy files) from the drive.

@0atman
Copy link
Copy Markdown
Owner

0atman commented Jan 20, 2026

@yarikoptic-test @yarikoptic thanks again, leave this PR open but ignore it for now, this will remind me to integrate languagetool, which is what I use locally. (I'd rather have the same rules everywhere)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants