SpellCheck Plugin: Supporting dictionary files

[bkarstens]

Description

Added support for dictionary files to the SpellCheck plugin. This separates extra words from actual configuration, and allows for integration with other cspell plugins like vscode's Code Spell Checker plugin.

• [ ] Impacts functionality?
• [ ] Impacts security?
• [ ] Breaking change?
• [ ] Includes tests?
• [x] Includes documentation? New setting documented in Readme.md.

How This Was Tested

Ran stuart_ci_build on a platform with the words moved to a dictionary file. Compared the generated cspell_actual_config.json to a version generated before moving the words: contents matched.

Integration Instructions

Optional: In places lots of words are in the ExtendWords config, move words to dictionary file and add the workspace-relative path to the ExtraDictionaries config.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 1.59%. Comparing base (a952e84) to head (70f52ad).

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           

Flag	Coverage Δ
MdeModulePkg	0.68% <ø> (ø)
MdePkg	5.42% <ø> (ø)
NetworkPkg	0.55% <ø> (ø)
PolicyServicePkg	30.41% <ø> (ø)
UefiCpuPkg	4.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[Javagedes]

Should this go up to edk2 first?

[makubacki]

Should this go up to edk2 first?

I think so.

[makubacki]

@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.

[bkarstens]

@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: https://github.com/tianocore/edk2/pull/6238

[github-actions[bot]]

This PR has been automatically marked as stale because it has not had activity in 60 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[github-actions[bot]]

This pull request has been automatically been closed because it did not have any activity in 60 days and no follow up within 7 days after being marked stale. Thank you for your contributions.