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 spell checker to CI/CD pipeline #12727

Closed
spotlesscoder opened this issue Feb 4, 2024 · 3 comments
Closed

Add spell checker to CI/CD pipeline #12727

spotlesscoder opened this issue Feb 4, 2024 · 3 comments
Labels

Comments

@spotlesscoder
Copy link
Contributor

Feature Description

The spell checker in my vs code goes crazy because of unknown words like "playpos" etc. and I already found at least one real typo

I suggest adding cspell or something else to the project to reduce the likelihood of spelling mistakes in the projects.

At work I do this all the time as I have seen so many bugs caused by typos.
For example

  • typos in customer facing texts (which is not that big of a problem most of the time but a bit ugly)
  • config settings not being applied because of typing mismatch in expected config variable name and actual variable name (correct in ENV, wrong in code)
  • especially when using JavaScript / TypeScript, you might even lose data because of wrong spelling of object properties
@Holzhaus
Copy link
Member

Holzhaus commented Feb 4, 2024

We already have this in the form of the codespell hook for the pre-commit framework. These checks also run on CI.

See https://github.com/mixxxdj/mixxx/wiki/Using-Git#set-up-automatic-code-checking for details how to set it up.

@Holzhaus Holzhaus closed this as completed Feb 4, 2024
@spotlesscoder
Copy link
Contributor Author

Can I inspect the output of the codespell check?

It seems not to have caught this #12726

@Holzhaus
Copy link
Member

Holzhaus commented Feb 4, 2024

You can check it by setting up pre-commit locally and then trying to commit a typo or use pre-commit run -v. On CI you won't see output unless a hook fails.

In that case the issue is likely due to codespell-project/codespell#196.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants