Skip to content

Update cspell.json #2725

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

Closed
danieljurek wants to merge 2 commits into from
Closed

Update cspell.json #2725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86cdd50
Update cspell.json, include documentation, add eng/common to exclusio…
danieljurek Aug 10, 2021
42f76ae
Template parameter: fail on spelling error
danieljurek Aug 16, 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
9 changes: 7 additions & 2 deletions .vscode/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
// See https://aka.ms/azsdk/engsys/spellcheck to learn about spell check
// configuration options including dealing with false positives.
{
"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", "json.hpp", "*nlohmann-json*", "eng/common/**/*"],
// * 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
5 changes: 5 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 @@ -20,6 +20,9 @@ parameters:
- name: CoverageReportPath
type: string
default: 'sdk/*/*/*cov_xml.xml'
- name: FailOnSpellingErrors
type: boolean
default: false
Copy link
Member

@weshaggard weshaggard Aug 16, 2021

Choose a reason for hiding this comment

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

Is there a reason to add this until we ready to set it to true in at lease one place?

Also we seem to be adding in some double negatives (i.e. not(Fail..)) I wonder if we if we should call this ContinueOnSpellingErrors just to align with what we are passing it to.

Copy link
Member Author

@danieljurek danieljurek Aug 16, 2021

Choose a reason for hiding this comment

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

I had other names which were worse... ContinueOnSpellingErrors is much better than anything I had this morning.

Copy link
Member Author

@danieljurek danieljurek Aug 16, 2021

Choose a reason for hiding this comment

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

Also, the reason to add this is to give people the ability to opt into it when ready.


jobs:
- job: Validate
Expand Down Expand Up @@ -240,6 +243,8 @@ jobs:
VCPKG_DEFAULT_TRIPLET: 'x64-windows-static'
steps:
- template: /eng/common/pipelines/templates/steps/check-spelling.yml
parameters:
ContinueOnError: ${ not(parameters.FailOnSpellingErrors) }

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