Merged
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.
Member
Author
|
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. |
IEvangelist
approved these changes
Sep 29, 2023
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.
Member
Author
|
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.
This was referenced Sep 29, 2025
This was referenced Jan 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a spell checker for Markdown files.
Resolves #1639.