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

Add codespell: config, workflow (to alert when new typos added) and get typos fixed #15437

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

yarikoptic
Copy link

This is my way to contribute back to projects I touch to use or told about (thus popular).

codespell: https://github.com/codespell-project/codespell to discover more

I spotted some code changes - but all looked good to be changed, but please review more.

I ignored 'unsecure' in a config setting connection.unsecure to not cause disturbance.

You can annotate lines to be ignored with e.g. /* pragma: codespell-ignore */ so you could even add suggestions right here in the diff as suggestions to expedite reversion back if needed.

@yarikoptic yarikoptic requested a review from a team as a code owner December 6, 2023 15:02
@CLAassistant
Copy link

CLAassistant commented Dec 6, 2023

CLA assistant check
All committers have signed the CLA.

@yarikoptic
Copy link
Author

macos-13 is failing also in https://github.com/iterate-ch/cyberduck/actions/runs/7120060984 for another PR

@dkocher
Copy link
Contributor

dkocher commented Dec 11, 2023

Our documentation would benefit from this build action a lot more.

@dkocher
Copy link
Contributor

dkocher commented Jan 3, 2024

Generated code from swagger-codegen should be excluded from spelling checks.

@yarikoptic
Copy link
Author

is it the swagger/ directories?

what is it generated from since it seems to have unique to it typos

❯ git grep beeing
storegate/src/main/java/ch/cyberduck/core/storegate/io/swagger/client/api/WebDavPasswordApi.java:   * Remove a WebDAV password to stop it from beeing used.
storegate/src/main/java/ch/cyberduck/core/storegate/io/swagger/client/api/WebDavPasswordApi.java:   * Remove a WebDAV password to stop it from beeing used.

@dkocher dkocher marked this pull request as draft February 28, 2024 15:02
@dkocher
Copy link
Contributor

dkocher commented Feb 28, 2024

is it the swagger/ directories?

what is it generated from since it seems to have unique to it typos

❯ git grep beeing
storegate/src/main/java/ch/cyberduck/core/storegate/io/swagger/client/api/WebDavPasswordApi.java:   * Remove a WebDAV password to stop it from beeing used.
storegate/src/main/java/ch/cyberduck/core/storegate/io/swagger/client/api/WebDavPasswordApi.java:   * Remove a WebDAV password to stop it from beeing used.

The data types are generated from an API specification (that includes the typos) outside the scope of this project.

…ut ignoring the failure due to ambigous typos

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== 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 ^^^
@yarikoptic
Copy link
Author

ok, ignored swagger, rebased and reran typos fixing.

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.

3 participants