Check Spelling
Testing & Qualitycheck-spellingCheck Spelling is an Agent Skill for testing & quality published in the Azure/azure-sdk-for-rust repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Check and fix spelling in project source files using cSpell.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/Azure/azure-sdk-for-rust/blob/HEAD/.github/skills/check-spelling/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/check-spelling, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Spell checking
Usage
Get all staged and unstaged non-deleted files, then pipe them to the spell check script:
{ git diff --staged --name-only --diff-filter=d; git diff --name-only --diff-filter=d; } | sort -u | ./eng/common/spelling/Invoke-Cspell.ps1
Configuration
The root configuration is .vscode/cspell.json, and CI runs cSpell with this config via eng/common/spelling/Invoke-Cspell.ps1.
Each service directory (e.g., sdk/{service-directory}) or crate directory (e.g., sdk/{service-directory}/{crate-directory}) can have a .cspell.json that should import either a parent .cspell.json or .vscode/cspell.json from the root of the repo. Per-directory configs are loaded based on the paths of files being checked.
Fix spelling
Show a summary of the misspellings to the user. Prompt the user for which words should be replaced and which should be ignored.
For words that should be replaced, fix the misspellings directly in the source files. If you cannot confidently determine the correct spelling, ask the user.
For words that should be ignored, add them to the ignoreWords array in a .cspell.json file under sdk/{service-directory} or lower. If the file doesn't exist, create it with an import of either a parent .cspell.json or ../../.vscode/cspell.json from the root of the repo.
Example sdk/keyvault/.cspell.json:
{
"import": [
"../../.vscode/cspell.json"
],
"ignoreWords": [
"ciphertext",
"purgeable"
]
}
Seldom used words can be ignored within the file they are used by adding an appropriate comment e.g.:
// cspell:ignore {word}
Testing
Run the same command again used to check spelling. All misspellings should be fixed.