-
Notifications
You must be signed in to change notification settings - Fork 183
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
Add spell check tools to eng/common #1421
Conversation
The following pipelines have been queued for testing: |
The following pipelines have been queued for testing: |
The following pipelines have been queued for testing: |
tools/notification-configuration/common/Services/AzureDevOpsService.cs
Outdated
Show resolved
Hide resolved
0ae03b3
to
3b79a5f
Compare
* Use common approach to resolving base branch name * Eliminate default base branch "master" as this will be changed later, providing no default and using a mandatory parameter means a dev must provide the value * Check for existence of $CspellConfigPath * No need to Set-Location if run from the root of the repo (most common scenario) * -join
3b79a5f
to
b7ddb14
Compare
This reverts commit 88b382a.
The following pipelines have been queued for testing: |
…Add reference to spelling docs, exit 0, Rename to check-spelling-in-changed-files.ps1,
The following pipelines have been queued for testing: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couple small clean-up comments but otherwise looks good.
… validation farther down that will also catch these errors), Update comments and script name
The following pipelines have been queued for testing: |
Hello @azure-sdk! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
See example run in Embedded C repo -- https://dev.azure.com/azure-sdk/public/_build/results?buildId=739511&view=logs&j=a129effc-2dd1-54d1-fb5a-ad7bdc0e851d&t=7b4713e3-e110-5049-e231-cc8a1e664c68
Logs:
Pipeline warnings:
check-spelling.yml
master
branch) of the PR.. this takes some work as the git config in DevOps is not set to match branch names the way a typicalgit clone
wouldTest-Spelling.ps1
Test-Spelling.ps1 is designed to run on a dev box as well as in DevOps. It will advise if there are errors.
I would have preferred to put
cspell.json
in theeng/
folder in each repo. However the configuration in the vcsode plugin searches only in the root of the repo, the.vscode
folder, or specific preferences set in.vscode/settings.json
(or at a user level). If we want to keep the root of the repo less cluttered then it makes sense to putcspell.json
into.vscode
(see demo PR).Of note: there are notes in the vscode extension repo about possibly using a
cspell.configLocation
setting but that functionality does not yet exist.