Add codespell support (config, workflow to detect/not fix) and make it fix few typos #449
Conversation
github-actions
bot
requested review from
akhanf,
Bradley-Karat,
mcespedes99,
myousif9 and
pvandyken
typings/ruamel/yaml/emitter.pyi
Outdated
| @@ -128,7 +128,7 @@ class Emitter: | |||
| indicator: Any, | |||
| need_whitespace: Any, | |||
| whitespace: bool = ..., | |||
| indention: bool = ..., | |||
| indentation: bool = ..., | |||
There was a problem hiding this comment.
generated file, so might need to get to the "source" and skip this one?
There was a problem hiding this comment.
This file represents 3rd party code, so nothing I can do for this. Anything in typings should actually be ignored
There was a problem hiding this comment.
ok, added typings to be skipped, redid codespell, forcepushed!
|
Thanks, this should be fine. I'll take a look when I get a chance |
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"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 ^^^
yarikoptic
force-pushed
the
enh-codespell
branch
from
178d060 to
b73a7e2
Compare
pvandyken
added
the
maintenance
|
Looks like there's some linting errors (line length). Seems to be in docstrings, so I don't think ruff will fix automatically, they'll need to be reshaped with a line wrap tool. |
not poetry or ruff user, so your contribution to this PR would be most appreciated ;) ❯ poetry run ruff format snakebids
Skipping virtualenv creation, as specified in config file.
warning: `ruff format` is a work-in-progress, subject to change at any time, and intended only for experimentation.
ruff failed
Cause: TOML parse error at line 215, column 12
|
215 | [tool.ruff.lint]
| ^^^^
unknown field `lint`, expected one of `allowed-confusables`, `builtins`, `cache-dir`, `dummy-variable-rgx`, `exclude`, `extend`, `extend-exclude`, `extend-include`, `extend-ignore`, `extend-select`, `extend-fixable`, `extend-unfixable`, `external`, `fix`, `fix-only`, `fixable`, `output-format`, `force-exclude`, `ignore`, `ignore-init-module-imports`, `include`, `line-length`, `tab-size`, `logger-objects`, `required-version`, `respect-gitignore`, `select`, `show-source`, `show-fixes`, `src`, `namespace-packages`, `target-version`, `preview`, `task-tags`, `typing-modules`, `unfixable`, `flake8-annotations`, `flake8-bandit`, `flake8-bugbear`, `flake8-builtins`, `flake8-comprehensions`, `flake8-copyright`, `flake8-errmsg`, `flake8-quotes`, `flake8-self`, `flake8-tidy-imports`, `flake8-type-checking`, `flake8-gettext`, `flake8-implicit-str-concat`, `flake8-import-conventions`, `flake8-pytest-style`, `flake8-unused-arguments`, `isort`, `mccabe`, `pep8-naming`, `pycodestyle`, `pydocstyle`, `pyflakes`, `pylint`, `pyupgrade`, `format`, `per-file-ignores`, `extend-per-file-ignores`or give me a hand here how to tame the poetry etc. |
Of course! Didn't want to touch your branch without your permission, but I'm happy to finish it off from here! |
|
FWIW for above -- I have ancient ruff system wide... installed recent one in venv, but |
Yeah, ruff won't touch docstrings or comments, so I just use a random line re-wrapping extension in my IDE. |
|
Also the checks will probably fail because of some issue that came up in the nightly. Still have to look into this. But I know this PR doesn't change any code, so I'll just merge either way UPDATE: I have the fix for the above ready to go, so I'll just wait for that PR |
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.