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

feat(linter): add codespell linter #4143

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ideaship
Copy link
Contributor

Add the codespell linter which uses a dictionary of common misspellings and ignores unknown words.

Fixes #4140

Proposed Changes

Add the codespell linter which uses a dictionary of common misspellings and ignores unknown words.

Readiness Checklist

Author/Contributor

  • Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

@ideaship ideaship marked this pull request as draft October 16, 2024 08:48
@ideaship
Copy link
Contributor Author

@nvuillam The PR I created is failing for reasons that are not obvious to me. I will hopefully get around to take another look tomorrow. Hints welcome.

@@ -211,3 +211,39 @@ linters:
dockerfile:
- FROM lycheeverse/lychee:latest-alpine AS lychee
- COPY --link --from=lychee /usr/local/bin/lychee /usr/bin/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quality :)

@ideaship
Copy link
Contributor Author

ideaship commented Nov 6, 2024

@nvuillam It looks to me like the Tests + Deploy Docker Image - DEV check failed for reasons unrelated to the PR. I don't see why shfmt and markdown-link-check should fail.

The MegaLinter failed because cspell finds misspelled words in the .codespell_ignore I added to keep codespell from failing.

I am not sure whether I should add the words in .codespell_ignore to .cspell.json as well.

I can implement changes, but I need some guidance on how to proceed to match the project's expectations.

@nvuillam
Copy link
Member

nvuillam commented Nov 10, 2024

@ideaship you can disable codespell on MegaLinter on linting :)

Add the codespell linter which uses a dictionary of common misspellings
and ignores unknown words.

Signed-off-by: Roger Luethi <[email protected]>
@ideaship
Copy link
Contributor Author

@nvuillam I disabled the errors for codespell as you suggested. What remains are the v8r errors. I don't see how the changes I made would cause the errors v8r reports.

@nvuillam
Copy link
Member

Hmm strange, i'll have a look :)

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.

Add new linter: codespell
3 participants