Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

codespell: add config, action and fix some typos with it #720

Merged
merged 7 commits into from
Jul 30, 2023

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic requested a review from a team as a code owner April 6, 2023 14:28
@jasonkarns
Copy link
Member

Can you provide an explanation of what codespell is and why we'd want it? Currently this PR has no description explaining the problem, proposed solution or alternatives.

@yarikoptic
Copy link
Contributor Author

yarikoptic commented Apr 22, 2023

From the projects page https://github.com/codespell-project/codespell

Fix common misspellings in text files. It's designed primarily for checking misspelled words in source code, but it can be used with other files as well. It does not check for word membership in a complete dictionary, but instead looks for a set of common misspellings. Therefore it should catch errors like "adn", but it will not catch "adnasdfasdf". This also means it shouldn't generate false-positives when you use a niche term it doesn't know about.

As for efficiency and precision - diff in this PR speaks best of all. I have not investigated alternatives but did contribute to codespell while introducing it to all projects I participate in and dozens of projects I anyhow use or touch (eg as debian developer) in my life

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
martin-schulze-vireso added a commit to yarikoptic/bats-core that referenced this pull request Jul 30, 2023
@martin-schulze-vireso martin-schulze-vireso merged commit fb7d15b into bats-core:master Jul 30, 2023
53 checks passed
@martin-schulze-vireso
Copy link
Member

Thanks for your contribution.

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.

None yet

3 participants