Skip to content

Commit

Permalink
ci: run spell check in CI, fix remaining issues (#4799)
Browse files Browse the repository at this point in the history 
This commit introduces a github action to check our spelling and fixes
the following misspelled words so that we come up green.

It also renames TfEditSes to TfEditSession, because Ses is not a word.

currently, excerpt, fallthrough, identified, occurred, propagate,
provided, rendered, resetting, separate, succeeded, successfully,
terminal, transferred, adheres, breaks, combining, preceded,
architecture, populated, previous, setter, visible, window, within,
appxmanifest, hyphen, control, offset, powerpoint, suppress, parsing,
prioritized, aforementioned, check in, build, filling, indices, layout,
mapping, trying, scroll, terabyte, vetoes, viewport, whose
  • Loading branch information
@jsoref
jsoref authored Mar 25, 2020
1 parent 48480e6 commit 5de9fa9
Show file tree
Hide file tree
Showing 67 changed files with 483,055 additions and 77 deletions.
20 changes: 20 additions & 0 deletions .github/actions/spell-check/dictionary/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dictionaries are lists of words to accept unconditionally

While check spelling will complain about a whitelisted word
which is no longer present, you can include things here even if
they are not otherwise present in the repository.

E.g., you could include a list of system APIs here, or potential
contributors (so that if a future commit includes their name,
it'll be accepted).

### Files

| File | Description |
| ---- | ----------- |
| [Dictionary](dictionary.txt) | Primary US English dictionary |
| [Chinese](chinese.txt) | Chinese words |
| [Japanese](japanese.txt) | Japanese words |
| [Microsoft](microsoft.txt) | Microsoft brand items |
| [Fonts](fonts.txt) | Font names |
| [Names](names.txt) | Names of people |
5 changes: 5 additions & 0 deletions .github/actions/spell-check/dictionary/chinese.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
CHINESEBIG
choseong
Jongseong
Jungseong
ssangtikeut
Loading

4 comments on commit 5de9fa9

@github-actions
Copy link

Choose a reason for hiding this comment

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

New misspellings found, please review:

  • defterm
  • INLINEPREFIX
  • Inplace
  • kimwalisch
  • libpopcnt
  • msys
  • pinam
  • SPACEBAR
  • Walisch
  • Wojciech
To accept these changes, run the following commands 
(
echo "
defterm
INLINEPREFIX
Inplace
kimwalisch
libpopcnt
msys
pinam
SPACEBAR
Walisch
Wojciech
"
) | sort -u -f | perl -ne 'next unless /./; print' > new_whitelist.txt && mv new_whitelist.txt '.github/actions/spell-check/whitelist/5de9fa9cf375e9b5bdc582d8d166604eeb519844.txt'

@DHowett-MSFT
Copy link
Contributor

Choose a reason for hiding this comment

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

@jsoref WOW IT'S SO COOL

@jsoref
Copy link
Contributor Author

@jsoref jsoref commented on 5de9fa9 Mar 25, 2020

Choose a reason for hiding this comment

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

Its advice is generic. If you guys think it's worth teaching it to make suggestions about choosing between adding to dictionaries/patterns/whitelist, I can think that through.

I'm still slowly iterating on it, so there will be new releases periodically. I haven't looked into how to let consumers know about them. I'll probably just make periodic PRs to update the tag.

Thanks for working with me on it.

@DHowett-MSFT
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for working with me on it

Hey, thanks for working with us on it! I'm likely to propose to my partner teams that they onboard as well 😄

Please sign in to comment.