SpellCheck Plugin: Supporting dictionary files #1161
Conversation
This file contains 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
github-actions
bot
added
impact:non-functional
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev/202405 #1161 +/- ##
===========================================
Coverage 1.59% 1.59%
===========================================
Files 1448 1448
Lines 362491 362491
Branches 5632 5632
===========================================
Hits 5776 5776
Misses 356608 356608
Partials 107 107
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Javagedes
approved these changes
Sep 24, 2024
|
Should this go up to edk2 first? |
I think so. |
|
@bkarstens, can you please make a PR for these changes in edk2? When that is completed, you can update this PR to be a cherry-pick of that commit. |
Here's the PR: tianocore/edk2#6238 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Added support for dictionary files to the
SpellCheckplugin. This separates extra words from actual configuration, and allows for integration with othercspellplugins like vscode's Code Spell Checker plugin.Readme.md.How This Was Tested
Ran
stuart_ci_buildon a platform with the words moved to a dictionary file. Compared the generatedcspell_actual_config.jsonto a version generated before moving the words: contents matched.Integration Instructions
Optional: In places lots of words are in the
ExtendWordsconfig, move words to dictionary file and add the workspace-relative path to theExtraDictionariesconfig.