Replace misspell with cspell and perform spelling fixes #4728 #4754
Conversation
|
An extension to this PR could be to add in https://textlint.github.io/ also similar to otel.io but out of scope. |
.cspell.yaml
Outdated
| - name: CodeBlock | ||
| pattern: | | ||
| / | ||
| ^(\s*[~`]{3,}) # code-block start |
There was a problem hiding this comment.
are ~ code blocks a thing?
| ^(\s*[~`]{3,}) # code-block start | |
| ^(\s*[`]{3,}) # code-block start |
There was a problem hiding this comment.
Based on the docs they are https://www.markdownguide.org/extended-syntax/#fenced-code-blocks & it is also the regex from otel.io.
.cspell.yaml
Outdated
| ([~`]) | ||
| [^~`]*? |
There was a problem hiding this comment.
same question here
| ([~`]) | |
| [^~`]*? | |
| ([`]) | |
| [^`]*? |
There was a problem hiding this comment.
As above but this is in addition to otel.io
|
|
||
| # Attempt to fix issues / regenerate tables. | ||
| .PHONY: fix | ||
| fix: misspell-correction |
There was a problem hiding this comment.
Does CSPELL have an autocorrect function?
If not I'd prefer not to move to CSPELL. My opinion on lints in general is if you can't get a tool to automatically do it, it's just a hassle for everyone. While misspell may not have the same feature-set of cspell, I don't want to switch until fix works.
There was a problem hiding this comment.
I do agree that cspell in the community repo can sometimes be annoying (maintaining the dictionary).
That said, it did catch a lot of misspellings in this PR!
A couple of thoughts:
- we could avoid running it on PRs and instead have a nightly job that opens an issue if it fails, so any issues can be fixed async (possibly by assigning the issue to copilot)
- we could start running copilot (or other code reviewer) on all PRs which should catch spelling mistakes going forward without relying on cspell
4 participants
Fixes #4728
Changes
This makes an attempt to replace misspell with cspell.
Cspell was selected due to:
While working through the switch, corrections to text was made as necessary or added to dictionary. Note i started with the same dictionary as otel.io and extended it in 133810c
Note text within ` code blocks are automatically excluded hence text has been standardised.
For non-trivial changes, follow the change proposal process.
CHANGELOG.mdfile updated for non-trivial changes