Migrate cspell config to per-service files ***NO_CI***#48094
Conversation
|
Azure Pipelines: Successfully started running 3 pipeline(s). 7 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
|
Reference: this migration follows the Azure SDK spellcheck guidance — Migrating from |
0d7b82b to
b14f83c
Compare
|
Updated to fix the spell-check failure seen in the earlier CI run Root cause: the initial version kept service words inside per-file Fix: follow the guidance literally — one |
Adopt the latest Azure SDK spellcheck guidance (https://github.com/Azure/azure-sdk-tools/blob/main/doc/common/spellcheck.md#migrating-from-vscodecspelljson-to-sdkservicecspellyaml): - Move service-scoped `overrides` out of the central .vscode/cspell.json into one per-service sdk/<service>/cspell.yaml that `import`s the central config (the import is required). - Convert and consolidate all legacy per-service/per-package cspell.json and cspell.yaml files into that single service-level file. - Flatten every service word to top-level `words` (no per-file `overrides`). A single config per service both keeps words scoped to the service (cspell uses the nearest config) and lets the cspell.yaml self-cover when CI spell checks the file itself, so no ignorePaths entry is needed. - Alphabetize word lists (case-insensitive) and dedupe. Cross-cutting words remain in the central config. Validated with cspell 10 that no words were lost, every generated cspell.yaml passes a self-lint, and affected source files still pass. ***NO_CI*** to avoid a repo-wide build storm from a config-only change. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 65188144-106d-4960-b150-a8faa13eef33
b14f83c to
5d9e8d8
Compare
What
Adopt the latest Azure SDK spellcheck guidance
(spellcheck.md):
overridesout of the central.vscode/cspell.jsoninto per-service
sdk/<service>/cspell.yamlfiles thatimportthe centralconfig (the
importis required).cspell.json→cspell.yaml, add the missingimportto existing per-servicecspell.yamlfiles, and consolidate eachservice down to a single
sdk/<service>/cspell.yaml.Cross-cutting words stay in the central config (they have no reliable
per-service attribution).
Why
Keeping service words in per-service files reduces merge conflicts in the hot
central file and makes the lists easier to read — exactly what the guidance now
recommends.
Safety / validation
cspelluses the nearest config for each file, so consolidating packageconfigs up to the service directory preserves coverage (verified empirically
with cspell 10, the pinned version).
before and after — 0 words lost.
cosmos sources) still report 0 issues.
CI
Config-only change across many packages, so the commit is tagged
***NO_CI***to avoid a repo-wide build storm. Opened as a draft.