.pytool/SpellCheck: Fix silent cspell run error #11822
Open
+10
−0
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
In the implementation of the SpellCheck prior to this commit, the logic
assumed that if it was able to successfully call
cspell --versiontoget the version, then any future usage of cspell would work without
error. PR #11783 brought to light an issue in this logic where if the
node version was too out of date,
cspellcould successfully runcspell --versionbut would hit a runtime error when actuallyperforming a spell check on a package. This ultimetly resulted in
cspell not running for any package but still reporting a "Success".
This commit updates the error handling logic in the SpellCheck when
running cspell to ensure that when cspell error lines were reported, at
least one misspelled word must be found. In the scenario where error
lines are reported, but no misspelled words were found, we now assume a
runtime error occurred in cspell, log it, and fail the plugin.
How This Was Tested
Continious Integration
Integration Instructions
N/A