Skip to content

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

Closed
yarikoptic wants to merge 4 commits intoschappim:masterfrom
yarikoptic:enh-codespell
Closed

Add codespell support (config, workflow to detect/not fix) and make it fix few typos#37
yarikoptic wants to merge 4 commits intoschappim:masterfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

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": "codespell -w -i 3 -C 2 ./README.md ./Pods/ArgumentParserKit/ArgumentParserKit/Classes/ArgumentParser.swift ./Pods/ArgumentParserKit/ArgumentParserKit/Classes/internal/Basic/ByteString.swift",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
schappim added a commit that referenced this pull request Apr 20, 2026
Credits:
- codespell config and workflow adapted from #37 by @yarikoptic
- Homebrew path documentation from #34 by @benwinding
@schappim
Copy link
Copy Markdown
Owner

Thank you for the thorough contribution, @yarikoptic! 🙏 I've adapted your codespell config and workflow in c0e71b2 on master (with Pods/ in the skip list since that's vendored). The typos in the README you spotted were fixed in earlier commits too. Credited in the commit message — really appreciate the care here.

@schappim schappim closed this Apr 20, 2026
@yarikoptic
Copy link
Copy Markdown
Author

glad it came of help!

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.

2 participants