Add codespell support (config, workflow to detect/not fix) and make it fix few typos #7798
Conversation
|
|
There was a problem hiding this comment.
Hi and thank you for this Pull Request and your interest in WEBKNOSSOS!
Codespell seems like a valuable addition to the development toolbox! Since many of our developers aren’t native English speakers, this will potentially catch a lot of small errors.
I added a couple of suggestions for the config file and some individual false positives that I’d like to revert.
Also, we decided that we do not want to run codespell on every push for the moment. We’ll have a look later at how to integrate it into our process in the best way.
Could you add these suggestions to the PR implementation? Then I’ll approve the CI run and we can hopefully merge this soon.
PS: Happy to see in your Github readme that you too enjoyed Survive Style 5+ ;-)
| @@ -60,7 +60,7 @@ trait BoxToResultHelpers extends I18nSupport with Formatter with RemoteOriginHel | |||
| private def jsonMessages(msgs: JsArray): JsObject = | |||
| Json.obj("messages" -> msgs) | |||
|
|
|||
| // Override this in your controller to add the CORS headers to thes results of its actions | |||
| // Override this in your controller to add the CORS headers to these results of its actions | |||
There was a problem hiding this comment.
| // Override this in your controller to add the CORS headers to these results of its actions | |
| // Override this in your controller to add the CORS headers to the results of its actions |
Co-authored-by: Florian M <fm3@users.noreply.github.com>
Co-authored-by: Florian M <fm3@users.noreply.github.com>
=== 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 ^^^
|
coolio, I have
|
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.