Upgrade cspell #53501
Upgrade cspell #53501
Conversation
danieljurek
force-pushed
the
djurek/upgrade-cspell-net
branch
from
5aec8e0 to
8790a5b
Compare
danieljurek
requested review from
ArcturusZhang,
ArthurMa1978,
benbp,
hallipr,
jsquire,
m-nash and
weshaggard
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the cspell configuration by moving service-specific word overrides from the central .vscode/cspell.json file to individual cspell.yaml files at the SDK service level. This decentralizes spell check configuration and allows each service to manage its own custom dictionary. The PR also updates the spell check invocation logic to use file lists instead of glob patterns and adds exclusion of cspell.yaml files from spell checking.
- Extracts service-specific word overrides to individual
cspell.yamlfiles for 10 SDK services - Updates spell check scripts to use
-FileListparameter instead of-ScanGlobs - Adds
cspell.yamlto the ignore patterns in the central config
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/resourceconnector/cspell.yaml | Adds service-specific spell check config with 4 custom words |
| sdk/recoveryservices-siterecovery/cspell.yaml | Adds service-specific spell check config with 10 custom words |
| sdk/recoveryservices-datareplication/cspell.yaml | Adds service-specific spell check config with 3 unique custom words (contains duplicate) |
| sdk/recoveryservices-backup/cspell.yaml | Adds service-specific spell check config with 4 unique custom words (contains duplicate) |
| sdk/provisioning/cspell.yaml | Adds service-specific spell check config with 2 custom words |
| sdk/postgresql/cspell.yaml | Adds service-specific spell check config with 2 custom words |
| sdk/hybridaks/cspell.yaml | Adds service-specific spell check config with 3 custom words |
| sdk/fleet/cspell.yaml | Adds service-specific spell check config with 1 custom word for 2 file patterns |
| sdk/desktopvirtualization/cspell.yaml | Adds service-specific spell check config with 4 unique custom words (contains duplicate) |
| sdk/connectedvmwarevsphere/cspell.yaml | Adds service-specific spell check config with 13 custom words |
| eng/scripts/Export-API.ps1 | Updates spell check invocation to use -FileList instead of -ScanGlobs |
| eng/pipelines/aggregate-reports.yml | Updates spell check invocation to use -FileList instead of -ScanGlobs |
| .vscode/cspell.json | Removes service-specific overrides and adds cspell.yaml to ignore patterns |
| &"$PSScriptRoot/../common/spelling/Invoke-Cspell.ps1" ` | ||
| -CSpellConfigPath "$PSScriptRoot/../../.vscode/cspell.json" ` | ||
| -ScanGlobs "sdk/$ServiceDirectory/*/api/*.cs" | ||
| -FileList $apiListingFiles.FullName |
There was a problem hiding this comment.
The Invoke-Cspell.ps1 script does not have a -FileList parameter. It only accepts -ScanGlobs. This will cause a runtime error when the script is executed. Change -FileList to -ScanGlobs to match the script's actual parameter signature.
| -FileList $apiListingFiles.FullName | |
| -ScanGlobs $apiListingFiles.FullName |
| ."eng/common/spelling/Invoke-Cspell.ps1" ` | ||
| -CSpellConfigPath "./.vscode/cspell.json" ` | ||
| -ScanGlobs "sdk/*/*/api/*.cs" | ||
| -FileList $files.FullName |
There was a problem hiding this comment.
The Invoke-Cspell.ps1 script does not have a -FileList parameter. It only accepts -ScanGlobs. This will cause a runtime error when the pipeline is executed. Change -FileList to -ScanGlobs to match the script's actual parameter signature.
| -FileList $files.FullName | |
| -ScanGlobs $files.FullName |
| - mware | ||
| - nics | ||
| - reprotect | ||
| - nics |
There was a problem hiding this comment.
The word 'nics' is duplicated on lines 7 and 9. Remove the duplicate entry on line 9.
| - nics |
| - mware | ||
| - xcool | ||
| - xsmb | ||
| - kpis |
There was a problem hiding this comment.
The word 'kpis' is duplicated on lines 7 and 11. Remove the duplicate entry on line 11.
| - kpis |
| - adfs | ||
| - logix | ||
| - msix | ||
| - msix |
There was a problem hiding this comment.
The word 'msix' is duplicated on lines 8 and 9. Remove the duplicate entry on line 9.
| - msix |
| - filename: '**/sdk/desktopvirtualization/**/*.cs' | ||
| words: | ||
| - adfs | ||
| - logix |
There was a problem hiding this comment.
The word 'logix' appears to be incomplete. This should likely be 'fslogix' based on the original configuration that was removed from .vscode/cspell.json (line 442), which included 'fslogix' for desktopvirtualization.
| - logix | |
| - fslogix |
| - esxi | ||
| - mware | ||
| - nics | ||
| - orignal |
There was a problem hiding this comment.
The word 'orignal' appears to be a misspelling of 'original'. However, if this is intentionally added to allow the misspelling in the codebase, it should remain. Verify whether this is a legitimate technical term or a typo that should be corrected in the source code instead.
| - orignal |
| - payg | ||
| - reassociate | ||
| - reprotect | ||
| - seleted |
There was a problem hiding this comment.
The word 'seleted' appears to be a misspelling of 'selected'. However, if this is intentionally added to allow the misspelling in the codebase, it should remain. Verify whether this is a legitimate technical term or a typo that should be corrected in the source code instead.
| - seleted | |
| - selected |
| - ctlr | ||
| - lsilogic | ||
| - lsilogicsas | ||
| - nic |
There was a problem hiding this comment.
The word 'nic' is listed, but the original configuration in .vscode/cspell.json only included 'nics' (plural). If both singular and plural forms are needed, add 'nics' to this list. Otherwise, verify whether 'nic' alone is sufficient or if it should be 'nics' instead.
| - nic | |
| - nic | |
| - nics |
| - pvscsi | ||
| - sesparse | ||
| - vcenter | ||
| - vm |
There was a problem hiding this comment.
The word 'vm' is added but was not in the original configuration for connectedvmwarevsphere in .vscode/cspell.json. Verify whether this addition is intentional or if it should be removed to maintain parity with the original configuration.
| - vm |
Warning
Service owners be advised: This is part of an update to cspell. For services that have spelling error detections in the new cspell version, I've moved service-specific overrides out of
.vscode/cspell.jsonand into a<service>/cspell.yamland added the new detected words .. Now you have more control over setting spelling overrides for your service.Partial Azure/azure-sdk-tools#9479
Once Azure/azure-sdk-tools#12569 merges this will pass CI.
Updates scripts and configs for new cspell version baseline.
Example PR blocked by spelling error: https://dev.azure.com/azure-sdk/public/public%20Team/_build/results?buildId=5508171&view=logs&j=c3e74943-23a9-5e82-9b42-8286fce989d4&t=e049197e-d864-58b1-c0e9-38458fd26878&l=1078
Example release blocked by spelling error: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=5508175&view=logs&j=b70e5e73-bbb6-5567-0939-8415943fadb9&t=c9190431-7417-53a5-3fc1-7c7e026cd79d
Example release build with no spelling error: https://dev.azure.com/azure-sdk/internal/internal%20Team/_build/results?buildId=5508526&view=logs&j=b70e5e73-bbb6-5567-0939-8415943fadb9&t=c9190431-7417-53a5-3fc1-7c7e026cd79d&l=831 (build failed, but that should be unrelated to spell checking)
Example PR build with no spelling error: https://dev.azure.com/azure-sdk/public/_build/results?buildId=5508525&view=logs&j=bc67675d-56bf-581f-e0a2-208848ba68ca&t=bc67675d-56bf-581f-e0a2-208848ba68ca (failed because of eng/common changes needed to do testing)