Skip to content

[web] Add cspell: a spell checker for code#448

Merged
dgdavid merged 6 commits intomasterfrom
cspell
Mar 3, 2023
Merged

[web] Add cspell: a spell checker for code#448
dgdavid merged 6 commits intomasterfrom
cspell

Conversation

@dgdavid
Copy link
Contributor

@dgdavid dgdavid commented Mar 2, 2023

Problem

While working in #443, I found few typos in the code, a bunch of them sent by myself 😅 Sadly, typos are easy to type but so hard to spot. And not only for me, read https://www.scienceabc.com/humans/why-is-it-so-difficult-to-spot-your-own-typos.html.

Solution

Add a spell checker to help us to detect them. Specifically cspell.

Notes

  • Changes were made on top of add-missing-sections branch. If we're willing to include them in master, I can adapt them after mentioned branch got merged.
  • There is an eslint plugin that could help to spot typos while executing the linter or even right away in your editor if it's properly configured. However, I'm proposing to use just a plain npm task for checking the CSS files too. There is not a stylelint plugin yet.
  • In my opinion, this change does not deserve an entry in the changes file.

Image borrowed from the article.

@coveralls
Copy link

coveralls commented Mar 2, 2023

Coverage Status

Coverage: 79.671%. Remained the same when pulling e19e35f on cspell into 05e4674 on master.

@imobachgs
Copy link
Contributor

It looks good. We can merge once #443 is merged. Thanks!

Base automatically changed from add-missing-sections to master March 3, 2023 11:31
@imobachgs imobachgs marked this pull request as ready for review March 3, 2023 11:45
@dgdavid dgdavid merged commit 652cb97 into master Mar 3, 2023
@dgdavid dgdavid deleted the cspell branch March 3, 2023 12:00
dgdavid added a commit that referenced this pull request Mar 14, 2025
## Problem

Although [it was
introduced](#448) to help
keep the code free of spelling typos, it [has been deactivated for a
while](dc83f67)
at CI.

*Short description of the original problem.*

- *Bugzilla link*
- *openQA link*
- *Links to other related pull requests*


## Solution

While still useful for spotting spelling mistakes (see
#2157), developers can run it
locally with their own configuration if desired.

## Additional note


https://github.com/agama-project/agama/blob/master/web/src/assets/fonts.scss
file still having a cspell:ignore comment because the file is actually
dead code that will be removed in a separated pull request.
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