Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SpellCheck Plugin: Supporting dictionary files #1161

Open
wants to merge 2 commits into
base: dev/202405
Choose a base branch
from

Conversation

bkarstens
Copy link
Contributor

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?
  • 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.

@github-actions github-actions bot added impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation labels Sep 24, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Javagedes
Copy link
Contributor

Should this go up to edk2 first?

@makubacki
Copy link
Member

Should this go up to edk2 first?

I think so.

@makubacki
Copy link
Member

makubacki commented Sep 25, 2024

@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 closed this Sep 25, 2024
@bkarstens
Copy link
Contributor Author

@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

@bkarstens bkarstens reopened this Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants