Skip to content

Spell Check Phase 2 #2794

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.

Sign up for GitHub

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

Merged
danieljurek merged 3 commits into from
Aug 26, 2021
Merged

Spell Check Phase 2 #2794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16d6a39
Formatting
danieljurek Aug 25, 2021
255a0c2
Add cpp to dictionaries, comment to words section, and opted-out path…
danieljurek Aug 25, 2021
c3a1891
Enable blocking of PRs on spelling error
danieljurek Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 42 additions & 9 deletions .vscode/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,27 @@
"version": "0.1",
"language": "en",
"languageId": "cpp",
"dictionaries": ["powershell"],
"ignorePaths": ["vcpkg/**/*", "*.exe", "*.a", "*.lib", ".vscode/cspell.json", "json.hpp", "*nlohmann-json*"],
"dictionaries": [
"powershell",
"cpp"
],
"ignorePaths": [
"vcpkg/**/*",
"*.exe",
"*.a",
"*.lib",
".vscode/cspell.json",
"eng/common/**/*",
"json.hpp",
"*nlohmann-json*",
"sdk/identity/**/*",
"sdk/core/**/*",
"sdk/keyvault/**/*",
"sdk/storage/**/*"
],
// * Unless configured otherwise, these words are not case sensitive
// * Alphabetize the list when making changes so the list is easier for future
// users to maintain and reason about.
"words": [
"ABFS",
"ABNF",
Expand Down Expand Up @@ -85,28 +104,42 @@
"overrides": [
{
"filename": "**/eng/pipelines/templates/jobs/archetype-sdk-client.yml",
"words": ["lcov", "iname"]
"words": [
Copy link
Member

@weshaggard weshaggard Sep 1, 2021

Choose a reason for hiding this comment

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

Is it worth keeping these overrides for each file or should we just add them to the word list?

"lcov",
"iname"
]
},
{
"filename": "**/sdk/storage/azure-storage-common/src/crypt.cpp",
"words": ["wdata"]
"words": [
"wdata"
]
},
{
"filename": "**/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_options.hpp",
"words": ["dacl"]
"words": [
"dacl"
]
},
{
"filename": "**/sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/protocol/blob_rest_client.hpp",
"words": ["xmsblobsequencenumber"]
"words": [
"xmsblobsequencenumber"
]
},
{
"filename": "**/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_models.hpp",
"words": ["SECG", "SECP"]
"words": [
"SECG",
"SECP"
]
},
{
"filename": "**/sdk/storage/azure-storage-common/test/test_base.hpp",
"words": ["FQJQ"]
"words": [
"FQJQ"
]
}
],
"allowCompoundWords": true
}
}
2 changes: 2 additions & 0 deletions eng/pipelines/templates/jobs/archetype-sdk-client.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ jobs:
VCPKG_DEFAULT_TRIPLET: 'x64-windows-static'
steps:
- template: /eng/common/pipelines/templates/steps/check-spelling.yml
parameters:
ContinueOnError: false

- template: /eng/common/pipelines/templates/steps/verify-links.yml
parameters:
Expand Down