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

Set new baseline for cspell #32171

Merged
merged 4 commits into from
Jan 16, 2025

Conversation

danieljurek
Copy link
Member

@danieljurek danieljurek commented Jan 15, 2025

What's changed

  • Overrides migrated from cSpell.json to service-specific cspell.yaml files
  • Other spell check detections moved to service-specific cspell.yaml files
  • "Popular" words placed in root cspell.yaml words array
  • Words lower case, sorted alphabetically in all YAML files
  • Bulk of settings now live in cspell.yaml and a legacy cspell.json file points to the cspell.yaml. The legacy cspell.json file is required because of how check-spelling-in-changed-files.ps1 generates the file list for spell checking
  • Documentation updates (including a cspell.yaml for checking spelling in the documentation folder) see preview here

Tests

SpellCheck

No spelling errors (success): https://github.com/Azure/azure-rest-api-specs/actions/runs/12796679864/job/35676868333?pr=32171

image

With spelling errors (expected fail): https://github.com/danieljurek/azure-rest-api-specs/actions/runs/12797877686/job/35680746239?pr=6

image

Warning: check-spelling-in-changed-files.ps1 includes the first link (https://aka.ms/azsdk/engsys/spellcheck)... I have a PR out to add a Note section to the page to redirect folks to REST API specs. We can harmonize how the advice is documented or called out in CI later.

SpellCheck - All

No spelling errors (success): https://github.com/danieljurek/azure-rest-api-specs/actions/runs/12798095199/job/35681400703

With spelling errors (expected fail): https://github.com/danieljurek/azure-rest-api-specs/actions/runs/12797885971

image

Copy link

openapi-pipeline-app bot commented Jan 15, 2025

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

Copy link

openapi-pipeline-app bot commented Jan 15, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

Copy link
Member

@weshaggard weshaggard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments but otherwise looks reasonable.

@danieljurek danieljurek force-pushed the djurek/cspell-baseline-2 branch from 5ca869f to ab31fb4 Compare January 16, 2025 18:25
@danieljurek danieljurek merged commit dee7146 into Azure:main Jan 16, 2025
22 of 35 checks passed
ZhidaLiu pushed a commit to ZhidaLiu/azure-rest-api-specs that referenced this pull request Jan 22, 2025
* Set cspell baseilne

* Update documentation/cspell.yaml to remove compound words

* pwsh
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants