Add spell checker #1667
Add spell checker #1667
Conversation
Add a spellchecker for Markdown files. Resolves #1639.
martincostello
added
enhancement
documentation
CI/build
dependencies
Add a wordlist of things to not mark as misspelled.
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1667 +/- ##
=======================================
Coverage 84.63% 84.63%
=======================================
Files 306 306
Lines 6819 6819
Branches 1045 1045
=======================================
Hits 5771 5771
Misses 839 839
Partials 209 209
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
Ignore the benchmark files.
Remove the HTML checking.
Restore the HTML filter.
Ignore doesn't seem to work, so just check the root, any README file, docs and .github.
|
I'll come back to this later. The process is working, but it's picking up a lot of false positives, like GitHub logins and .NET method names etc. |
Add setting to see if that fixes issues with code in codefences being spell-checked.
Bump rojopolis/spellcheck-github-actions to v0.34.0.
Try ignoring CHANGELOG from the spellchecker.
- Fix more typos. - Add more words to the wordlist.
As ignoring a file doesn't seem to work, cherry-pick the files from the repo-root to ignore CHANGELOG.
Try another Markdown extension - maybe it will ignore inline codefences.
- Fix more typos. - Update wordlist further.
Try ignoring text that's in a pair of backticks.
Fix context filter indentation.
- Wrap more words in backticks. - Fix more typos. - Extend wordlist further.
|
I've fixed (or "fixed") a bunch more errors so there's a lot fewer now. Most of what's left are type names or GitHub user logins. I might need to ignore a few more files rather than add everyone to the wordlist file, but ignoring files seems to be a bit of a faff: rojopolis/spellcheck-github-actions#176 Will come back to this again later. |
Otherwise the spellcheck files due to all the technical terms and the GitHub logins in these two files.
- Wrap more words in backticks. - Add more terms to the wordlist.
Reword the sentence to avoid needing to add a GitHub login to the wordlist file.
Add a spell checker for Markdown files.
Resolves #1639.