edk2 icon indicating copy to clipboard operation
edk2 copied to clipboard

Pytool: SpellCheck: Supporting dictionaries files

Open bkarstens opened this issue 1 year ago • 2 comments

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.

  • [ ] Breaking change?
    • Breaking change - Does this PR cause a break in build or boot behavior?
    • Examples: Does it add a new library class or move a module to a different repo.
  • [ ] Impacts security?
    • Security - Does this PR have a direct security impact?
    • Examples: Crypto algorithm change or buffer overflow fix.
  • [ ] Includes tests?
    • Tests - Does this PR include any explicit test code?
    • Examples: Unit tests or integration tests.

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 where lots of words are in the ExtendWords config: move words to a dictionary file and add the workspace-relative path of the dictionary file to the ExtraDictionaries config.

bkarstens avatar Sep 25 '24 19:09 bkarstens

WARNING: Cannot add some reviewers: A user specified as a reviewer for this PR is not a collaborator of the repository. Please add them as a collaborator to the repository so they can be requested in the future.

Non-collaborators requested:

  • @javagedes

Attn Admins:

  • @jljusten
  • @bcran
  • @lgao4
  • @mdkinney
  • @vincent-j-zimmer
  • @jkmathews
  • @miki-intel-work

Admin Instructions:

  • Add the non-collaborators as collaborators to the appropriate team(s) listed in teams
  • If they are no longer needed as reviewers, remove them from Maintainers.txt

WARNING: Cannot add some reviewers: A user specified as a reviewer for this PR is not a collaborator of the repository. Please add them as a collaborator to the repository so they can be requested in the future.

Non-collaborators requested:

  • @javagedes

Attn Admins:

  • @jljusten
  • @bcran
  • @lgao4
  • @mdkinney
  • @vincent-j-zimmer
  • @jkmathews
  • @miki-intel-work

Admin Instructions:

  • Add the non-collaborators as collaborators to the appropriate team(s) listed in teams
  • If they are no longer needed as reviewers, remove them from Maintainers.txt

@mdkinney am I missing from a collaborators group? If so, can you add me? Thanks!!

Javagedes avatar Sep 25 '24 19:09 Javagedes

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] avatar Nov 29 '24 23:11 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.

github-actions[bot] avatar Dec 07 '24 23:12 github-actions[bot]