feat(linter): add codespell linter

oxsecurity / megalinter

🦙 MegaLinter analyzes 50 languages, 22 formats, 21 tooling formats, excessive copy-pastes, spelling mistakes and security issues in your repository sources with a GitHub Action, other CI tools or locally.

https://ox.security

GNU Affero General Public License v3.0

1.97k stars 238 forks source link

feat(linter): add codespell linter #4143

Open ideaship opened 1 month ago

ideaship commented 1 month ago

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

[x] 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 commented 1 month ago

@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.

ideaship commented 3 weeks ago

@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 commented 2 weeks ago

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

ideaship commented 1 week ago

@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 commented 1 week ago

Hmm strange, i'll have a look :)