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

Improve codespell support: adjust and concentrate config to pyproject.toml and fix more typos #2583

Merged
merged 4 commits into from
Aug 6, 2024

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Jul 26, 2024

  • Concentrates codespell configuration in pyproject.toml instead of pre-commit configuration so user could simply run codespell and get it all clean
  • Do codespell .json files (but not package-lock.json)
  • Two typos fixed
  • Highly related: add typos spell checker to pre-commit #2568 . Apparently more typos to add to codespell ;-)

TODOs:

  • Check if CI workflow is actually needed -- may be pre-commit would pick up typo in that TEMP commit. pre-commit fixes it, so no CI to just detect typos is needed per se (well, pre-commit runs on changed only files AFAIK, with upgrade of codespell in pre-commit might require a run on all files... probably nothing new in procedures)

@yarikoptic yarikoptic changed the title Add codespell support (config, workflow to detect/not fix) and make it fix few typos Improve codespell support: adjust and concentrate config to pyproject.toml and fix more typos Jul 26, 2024
@yarikoptic
Copy link
Contributor Author

yarikoptic commented Jul 26, 2024

No CI workflow detected a typo, that's odd... I will try once again with slightly adjusted/extended configuration/fixes of typos.

edit: dang -- of cause, it is pre-commit autofixing it, dang... ok, removing custom CI and TEMP commit

@yarikoptic yarikoptic marked this pull request as ready for review July 26, 2024 18:05
…te on all dictionaries

Also no longer exclude all .json files as they are worth to check/fix

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
@yarikoptic
Copy link
Contributor Author

resolved conflict (now there is tool.typos config as well). FWIW: as long as codespell is used in pre-commit (and why not typos there?) -- IMHO worth having configuration for it and thus considering this PR.

@Adam-D-Lewis Adam-D-Lewis self-requested a review August 6, 2024 15:44
@Adam-D-Lewis
Copy link
Member

LGTM, thanks @yarikoptic

@Adam-D-Lewis Adam-D-Lewis merged commit d6675be into nebari-dev:develop Aug 6, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

2 participants