ci: spelling: update to 0.0.16a; update advice #5922

jsoref · 2020-05-15T12:19:31Z

Summary of the Pull Request

Updates the check spelling action to 0.0.16-a

update advice -- sample -- I really do encourage others to adjust it as desired
rename expect (there are consumers who were not a fan of the whitelist nomenclature)
prune stale items
some patterns improvements to reduce the number of items in expect

⚠️ Anyone with an inflight addition of a new file to the whitelist directory will be moderately unhappy as the action would only use items from there if it didn't find expect (and this PR includes the rename).

References

PR Checklist

Closes #xxx
CLA signed. If not, go over here and sign the CLA
Tests added/passed
Requires documentation to be updated
I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

Runs should be ~30s faster.

I was hoping to be able to offer the ability to talk to the bot, but sadly that feature is still not quite ready -- and I suspect that I may want to let projects opt in/out of that feature.

Validation Steps Performed

I added a commit with misspellings: jsoref@57fc13f ❌ and ran the command it suggested (in bash).
The commit itself passes its own testing ✔️

The commands were never cmd/psh friendly. This iteration is designed to make it easier for a bot to parse and eventually do the work in response to a GitHub request, sadly that feature is behind schedule.

* rename expect * prune stale items * add some patterns

jsoref · 2020-05-15T12:20:23Z

.github/actions/spell-check/expect/README.md

@@ -0,0 +1,13 @@
+The contents of each `.txt` file in this directory are merged together.


This is a rename, but Git thinks it's too different to qualify.

miniksa · 2020-05-27T21:20:04Z

@jsoref, can you resolve conflicts here whenever you get a chance?

DHowett

thank you for this; also, thanks for the rename 😄 I definitely prefer expect

jsoref · 2020-05-27T23:14:48Z

I started resolving the conflicts earlier today. Lemme finish it now...

DHowett · 2020-05-27T23:46:48Z

.github/actions/spell-check/expect/expect.txt

@@ -224,11 +203,8 @@ CARETBLINKINGENABLED
 CARRIAGERETURN
 cascadia
 catid
-carlos


so in this case, we preemptively added Carlos/Zamora because he keeps getting flagged on his specifications 😄

You want to add him in the dictionary/ directory -- specifically dictionary/names.txt

ah, great. thanks.

Is there something I can do to the advice to make that clearer? -- Since we're trying to update that file here...

jsoref · 2020-05-27T23:57:10Z

(I really was trying to avoid this having lots of force pushes, I did a whole bunch where I only force pushed the test commit and not the actual commit... But, sigh.)

Ok. All done.

@j4james : I hope this doesn't cause your pattern update too much pain. I didn't end up changing that line, although at some point I really do want to update [Ll]? to [Ll]{0,2} -- to handle long long.

DHowett · 2020-05-28T00:03:32Z

We squash the HECC out of pull requests, so if it's easier for you to go wild and commit stuff like zadjii-msft does, do!

jsoref · 2020-05-28T00:08:25Z

Mostly I'm trying to avoid burning CPU cycles on the build system; partially it's I don't really need people to see my embarrassing mistakes; partially I like the idea of making commits that only part of the environment sees -- specifically it's sufficient for me to push my commits on a branch to GitHub to get the spell checker to run -- I don't need to update the PR itself for that -- this is a designed feature.

n.b.: I'm working on getting act to work so one could easily run the spell checker locally. It involves playing w/ Go and a certain amount of divination... I'm hoping to have that working + well documented by the next release or so.
I really want to get the comment to apply feature finished too. I might try to sprint on it over the weekend....

j4james · 2020-05-28T00:51:15Z

@j4james : I hope this doesn't cause your pattern update too much pain. I didn't end up changing that line, although at some point I really do want to update [Ll]? to [Ll]{0,2} -- to handle long long.

No worries. I expect I'll have to rebase that PR a few more times anyway. And I forgot you asked to do the long long update. I can still add that next time I rebase if you want.

jsoref · 2020-05-28T12:55:52Z

@DHowett: well, squash / rebase away ;-)

ghost · 2020-05-28T13:00:25Z

Hello @zadjii-msft!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

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 (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2020-05-28T13:00:40Z

Apologies, I am afraid I am encountering technical difficulties that might have hampered my ability to assist with merging this pull request. I will continue to try to assist if there are further changes to this pull request.

zadjii-msft · 2020-05-28T13:02:14Z

Well that was weird. Anywho, thanks again for the contribution!

## Summary of the Pull Request Updates the check spelling action to [0.0.16-a](https://github.com/check-spelling/check-spelling/releases/tag/0.0.16-alpha) * update advice -- [sample](jsoref@57fc13f#commitcomment-39489723) -- I really do encourage others to adjust it as desired * rename `expect` (there are consumers who were not a fan of the `whitelist` nomenclature) * prune stale items * some `patterns` improvements to reduce the number of items in `expect`  :warning: Anyone with an inflight addition of a new file to the `whitelist` directory will be moderately unhappy as the action would only use items from there if it didn't find `expect` (and this PR includes the rename). ## References  ## PR Checklist * [ ] Closes #xxx * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Requires documentation to be updated * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx  ## Detailed Description of the Pull Request / Additional comments Runs should be ~30s faster. I was hoping to be able to offer the ability to talk to the bot, but sadly that feature is still not quite ready -- and I suspect that I may want to let projects opt in/out of that feature.  ## Validation Steps Performed * I added a commit with misspellings: jsoref@57fc13f ❌ and ran the command it suggested (in bash). * The commit [itself passes its own testing](jsoref@78df00d) ✔️ The commands were never `cmd`/`psh` friendly. This iteration is designed to make it easier for a bot to parse and eventually do the work in response to a GitHub request, sadly that feature is behind schedule.

ci: spelling: update to 0.0.16a; update advice

78df00d

* rename expect * prune stale items * add some patterns

jsoref commented May 15, 2020

View reviewed changes

zadjii-msft approved these changes May 15, 2020

View reviewed changes

zadjii-msft added the Needs-Second It's a PR that needs another sign-off label May 20, 2020

ghost requested review from miniksa, carlos-zamora and leonMSFT May 20, 2020 19:51

miniksa approved these changes May 27, 2020

View reviewed changes

DHowett approved these changes May 27, 2020

View reviewed changes

jsoref force-pushed the spell-check branch from a887482 to 7b55b89 Compare May 27, 2020 23:42

DHowett reviewed May 27, 2020

View reviewed changes

jsoref force-pushed the spell-check branch 3 times, most recently from 66334a6 to 78df00d Compare May 27, 2020 23:56

zadjii-msft added the AutoMerge Marked for automatic merge by the bot when requirements are met label May 28, 2020

zadjii-msft merged commit cc472c2 into microsoft:master May 28, 2020

jsoref deleted the spell-check branch May 28, 2020 14:39

KalleOlaviNiemitalo mentioned this pull request Dec 29, 2020

Changing a phrase to "expected" #8677

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: spelling: update to 0.0.16a; update advice #5922

ci: spelling: update to 0.0.16a; update advice #5922

jsoref commented May 15, 2020 •

edited

Loading

jsoref May 15, 2020

miniksa commented May 27, 2020

DHowett left a comment

jsoref commented May 27, 2020

DHowett May 27, 2020

jsoref May 27, 2020 •

edited

Loading

DHowett May 27, 2020

jsoref May 27, 2020

jsoref commented May 27, 2020 •

edited

Loading

DHowett commented May 28, 2020

jsoref commented May 28, 2020

j4james commented May 28, 2020

jsoref commented May 28, 2020

ghost commented May 28, 2020

ghost commented May 28, 2020

zadjii-msft commented May 28, 2020

		@@ -0,0 +1,13 @@
		The contents of each `.txt` file in this directory are merged together.

ci: spelling: update to 0.0.16a; update advice #5922

ci: spelling: update to 0.0.16a; update advice #5922

Conversation

jsoref commented May 15, 2020 • edited Loading

Summary of the Pull Request

References

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

jsoref May 15, 2020

Choose a reason for hiding this comment

miniksa commented May 27, 2020

DHowett left a comment

Choose a reason for hiding this comment

jsoref commented May 27, 2020

DHowett May 27, 2020

Choose a reason for hiding this comment

jsoref May 27, 2020 • edited Loading

Choose a reason for hiding this comment

DHowett May 27, 2020

Choose a reason for hiding this comment

jsoref May 27, 2020

Choose a reason for hiding this comment

jsoref commented May 27, 2020 • edited Loading

DHowett commented May 28, 2020

jsoref commented May 28, 2020

j4james commented May 28, 2020

jsoref commented May 28, 2020

ghost commented May 28, 2020

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 (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented May 28, 2020

zadjii-msft commented May 28, 2020

jsoref commented May 15, 2020 •

edited

Loading

jsoref May 27, 2020 •

edited

Loading

jsoref commented May 27, 2020 •

edited

Loading

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 (`@msftbot`) and give me an instruction to get started! Learn more here.