Migrate spelling-0.0.19 changes from main

# Conflicts:
#	src/cascadia/UnitTests_TerminalCore/ConptyRoundtripTests.cpp
#	src/host/screenInfo.cpp

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

@@ -1,17 +0,0 @@
-<details>
-<summary>
-:pencil2: Contributor please read this
-</summary>
-
-* If the items listed above are names, please add them to `.github/actions/spell-check/dictionary/names.txt`.
-* If they're APIs, you can add them to a file in `.github/actions/spell-check/dictionary/`.
-* If they're just things you're using, please add them to an appropriate file in `.github/actions/spell-check/whitelist/`.
-* If you need to use a specific token in one place and it shouldn't generally be used, you can
-add an item in an appropriate file in `.github/actions/spell-check/patterns/`.
-
-See the `README.md` in each directory for more information.
-</details>
-
-#### :warning: Reviewers
-At present, the action that triggered this message will not show its :x: in this PR unless the branch is within this repository.
-Thus, you **should** make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

.github/actions/spell-check/dictionary/apis.txt

@@ -1,4 +0,0 @@
-ICustom
-IObject
-LCID
-rfind

.github/actions/spell-check/dictionary/math.txt

@@ -1,3 +0,0 @@
-powf
-sqrtf
-isnan

.github/actions/spell-check/dictionary/microsoft.txt

@@ -1,7 +0,0 @@
-mfcribbon
-microsoft
-microsoftonline
-osgvsowi
-powershell
-tdbuildteamid
-visualstudio

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

@@ -1,12 +0,0 @@
-https://(?:(?:[-a-zA-Z0-9?&=]*\.|)microsoft\.com)/[-a-zA-Z0-9?&=_\/.]*
-https://aka\.ms/[-a-zA-Z0-9?&=\/_]*
-https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
-(?:0[Xx]|U\+|#)[a-f0-9A-FGgRr]{2,}[Uu]?[Ll]?\b
-\{[0-9A-FA-F]{8}-(?:[0-9A-FA-F]{4}-){3}[0-9A-FA-F]{12}\}
-\d+x\d+Logo
-Scro\&ll
-# selectionInput.cpp
- :\\windows\\syste\b
-TestUtils::VerifyExpectedString\(tb, L"[^"]+"
-hostSm\.ProcessString\(L"[^"]+"
-\b([A-Za-z])\1{3,}\b

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

@@ -1,7 +0,0 @@
-The contents of each `.txt` file in this directory are merged together.
-
-* [alphabet](alphabet.txt) is a sample for alphabet related items
-* [web](web.txt) is a sample for web/html related items
-* [whitelist](whitelist.txt) is the main whitelist -- there is nothing
-particularly special about the file name (beyond the extension which is
-important).

.github/actions/spell-check/whitelist/web.txt

@@ -1,4 +0,0 @@
-http
-td
-www
-ecma

.github/actions/spelling/advice.md

@@ -0,0 +1,50 @@
+<!-- markdownlint-disable MD033 MD041 -->
+<details>
+<summary>
+:pencil2: Contributor please read this
+</summary>
+
+By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.
+
+:warning: The command is written for posix shells. You can copy the contents of each `perl` command excluding the outer `'` marks and dropping any `'"`/`"'` quotation mark pairs into a file and then run `perl file.pl` from the root of the repository to run the code. Alternatively, you can manually insert the items...
+
+If the listed items are:
+
+* ... **misspelled**, then please *correct* them instead of using the command.
+* ... *names*, please add them to `.github/actions/spelling/allow/names.txt`.
+* ... APIs, you can add them to a file in `.github/actions/spelling/allow/`.
+* ... just things you're using, please add them to an appropriate file in `.github/actions/spelling/expect/`.
+* ... tokens you only need in one place and shouldn't *generally be used*, you can add an item in an appropriate file in `.github/actions/spelling/patterns/`.
+
+See the `README.md` in each directory for more information.
+
+:microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:
+
+<details><summary>:clamp: If you see a bunch of garbage</summary>
+
+If it relates to a ...
+<details><summary>well-formed pattern</summary>
+
+See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.
+
+If not, try writing one and adding it to a `patterns/{file}.txt`.
+
+Patterns are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
+
+Note that patterns can't match multiline strings.
+</details>
+<details><summary>binary-ish string</summary>
+
+Please add a file path to the `excludes.txt` file instead of just accepting the garbage.
+
+File paths are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
+
+`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
+../tree/HEAD/README.md) (on whichever branch you're using).
+</details>
+
+</details>
+
+</details>

.github/actions/spelling/allow/README.md

@@ -1,6 +1,6 @@
-# Dictionaries are lists of words to accept unconditionally
+# Allow files are lists of words to accept unconditionally
 
-While check spelling will complain about a whitelisted word
+While check spelling will complain about an expected word
 which is no longer present, you can include things here even if
 they are not otherwise present in the repository.
 
@@ -8,13 +8,14 @@ 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
+## Files
 
 | File | Description |
 | ---- | ----------- |
-| [Dictionary](dictionary.txt) | Primary US English dictionary |
+| [Allow](allow.txt) | Supplements to the 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 |
+| [Colors](colors.txt) | Names of color |

.github/actions/spelling/allow/allow.txt

@@ -0,0 +1,77 @@
+apc
+calt
+ccmp
+changelog
+cybersecurity
+Apc
+clickable
+clig
+copyable
+dalet
+dcs
+Dcs
+dialytika
+dje
+downside
+downsides
+dze
+dzhe
+Enum'd
+Fitt
+formattings
+ftp
+fvar
+geeksforgeeks
+ghe
+gje
+hostname
+hostnames
+hyperlink
+hyperlinking
+hyperlinks
+img
+It'd
+kje
+liga
+lje
+locl
+lorem
+Llast
+Lmid
+Lorigin
+maxed
+mkmk
+mru
+noreply
+nje
+ogonek
+ok'd
+overlined
+postmodern
+ptys
+qof
+qps
+rclt
+reimplementation
+reserialization
+reserialize
+reserializes
+rlig
+runtimes
+shcha
+slnt
+Sos
+timestamped
+TLDR
+tokenizes
+tonos
+tshe
+uiatextrange
+UIs
+und
+unregister
+versioned
+We'd
+wildcards
+yeru
+zhe

.github/actions/spelling/allow/apis.txt

@@ -0,0 +1,194 @@
+ACCEPTFILES
+ACCESSDENIED
+alignas
+alignof
+APPLYTOSUBMENUS
+bitfield
+bitfields
+BUILDBRANCH
+BUILDMSG
+BUILDNUMBER
+BYPOSITION
+charconv
+CLASSNOTAVAILABLE
+cmdletbinding
+COLORPROPERTY
+colspan
+COMDLG
+comparand
+cstdint
+CXICON
+CYICON
+dataobject
+dcomp
+DERR
+dlldata
+DONTADDTORECENT
+DWORDLONG
+enumset
+environstrings
+EXPCMDFLAGS
+EXPCMDSTATE
+filetime
+FILTERSPEC
+FORCEFILESYSTEM
+FORCEMINIMIZE
+frac
+fullkbd
+futex
+GETDESKWALLPAPER
+GETHIGHCONTRAST
+Hashtable
+HIGHCONTRASTON
+HIGHCONTRASTW
+hotkeys
+href
+hrgn
+IActivation
+IApp
+IAppearance
+IAsync
+IBind
+IBox
+IClass
+IComparable
+IComparer
+IConnection
+ICustom
+IDialog
+IDirect
+IExplorer
+IFACEMETHOD
+IFile
+IInheritable
+IMap
+IObject
+iosfwd
+IPackage
+IPeasant
+isspace
+ISetup
+IStorage
+istream
+IStringable
+ITab
+ITaskbar
+IUri
+IVirtual
+KEYSELECT
+LCID
+llabs
+llu
+localtime
+lround
+LSHIFT
+MENUCOMMAND
+MENUDATA
+MENUINFO
+memicmp
+mptt
+mov
+msappx
+MULTIPLEUSE
+NCHITTEST
+NCLBUTTONDBLCLK
+NCRBUTTONDBLCLK
+NIF
+NIN
+NOAGGREGATION
+NOASYNC
+NOCHANGEDIR
+NOPROGRESS
+NOREDIRECTIONBITMAP
+NOREPEAT
+NOTIFYBYPOS
+NOTIFYICON
+NOTIFYICONDATA
+ntprivapi
+oaidl
+ocidl
+ODR
+offsetof
+osver
+OSVERSIONINFOEXW
+otms
+OUTLINETEXTMETRICW
+overridable
+PAGESCROLL
+PICKFOLDERS
+pmr
+rcx
+REGCLS
+RETURNCMD
+rfind
+roundf
+RSHIFT
+schandle
+semver
+serializer
+SETVERSION
+SHELLEXECUTEINFOW
+shobjidl
+SHOWMINIMIZED
+SHOWTIP
+SINGLEUSE
+SIZENS
+smoothstep
+snprintf
+spsc
+sregex
+SRWLOC
+SRWLOCK
+STDCPP
+STDMETHOD
+strchr
+strcpy
+streambuf
+strtoul
+Stubless
+Subheader
+Subpage
+syscall
+TASKBARCREATED
+TBPF
+THEMECHANGED
+tlg
+tmp
+tolower
+toupper
+TTask
+TVal
+UChar
+UPDATEINIFILE
+userenv
+wcsstr
+wcstoui
+winmain
+wmemcmp
+wpc
+wsregex
+wwinmain
+xchg
+XDocument
+XElement
+xfacet
+xhash
+XIcon
+xiosbase
+xlocale
+xlocbuf
+xlocinfo
+xlocmes
+xlocmon
+xlocnum
+xloctime
+XMax
+xmemory
+XParse
+xpath
+xstddef
+xstring
+xtree
+xutility
+YIcon
+YMax

.github/actions/spelling/allow/colors.txt

@@ -0,0 +1,117 @@
+alice
+aliceblue
+antiquewhite
+blanchedalmond
+blueviolet
+burlywood
+cadetblue
+cornflowerblue
+cornsilk
+cyan
+darkblue
+darkcyan
+darkgoldenrod
+darkgray
+darkgreen
+darkgrey
+darkkhaki
+darkmagenta
+darkolivegreen
+darkorange
+darkorchid
+darkred
+darksalmon
+darkseagreen
+darkslateblue
+darkslategray
+darkslategrey
+darkturquoise
+darkviolet
+deeppink
+deepskyblue
+dimgray
+dimgrey
+dodgerblue
+firebrick
+floralwhite
+forestgreen
+gainsboro
+ghostwhite
+greenyellow
+hotpink
+indian
+indianred
+lavenderblush
+lawngreen
+lemonchiffon
+lightblue
+lightcoral
+lightcyan
+lightgoldenrod
+lightgoldenrodyellow
+lightgray
+lightgreen
+lightgrey
+lightpink
+lightsalmon
+lightseagreen
+lightskyblue
+lightslateblue
+lightslategray
+lightslategrey
+lightsteelblue
+lightyellow
+limegreen
+mediumaquamarine
+mediumblue
+mediumorchid
+mediumpurple
+mediumseagreen
+mediumslateblue
+mediumspringgreen
+mediumturquoise
+mediumvioletred
+midnightblue
+mintcream
+mistyrose
+navajo
+navajowhite
+navyblue
+oldlace
+olivedrab
+orangered
+palegoldenrod
+palegreen
+paleturquoise
+palevioletred
+papayawhip
+peachpuff
+peru
+powderblue
+rebecca
+rebeccapurple
+rosybrown
+royalblue
+saddlebrown
+sandybrown
+seagreen
+sienna
+skyblue
+slateblue
+slategray
+slategrey
+springgreen
+steelblue
+violetred
+webgray
+webgreen
+webgrey
+webmaroon
+webpurple
+whitesmoke
+xaroon
+xray
+xreen
+xrey
+xurple
+yellowgreen

.github/actions/spelling/allow/fonts.txt

@@ -1,8 +1,10 @@
 Consolas
 emoji
+emojis
 Extralight
 Gabriola
 Iosevka
 MDL
 Monofur
 Segoe
+wght

.github/actions/spelling/allow/math.txt

@@ -0,0 +1,11 @@
+atan
+CPrime
+HBar
+HPrime
+isnan
+LPrime
+LStep
+powf
+RSub
+sqrtf
+ULP

.github/actions/spelling/allow/microsoft.txt

@@ -0,0 +1,78 @@
+ACLs
+ADMINS
+advapi
+altform
+altforms
+appendwttlogging
+appx
+appxbundle
+appxerror
+appxmanifest
+ATL
+backplating
+bitmaps
+BOMs
+CPLs
+cpptools
+cppvsdbg
+CPRs
+cryptbase
+DACL
+DACLs
+diffs
+disposables
+dotnetfeed
+DTDs
+DWINRT
+enablewttlogging
+Intelli
+IVisual
+LKG
+LOCKFILE
+Lxss
+mfcribbon
+microsoft
+microsoftonline
+MSAA
+msixbundle
+MSVC
+muxc
+netcore
+osgvsowi
+PFILETIME
+pgc
+pgo
+pgosweep
+powerrename
+powershell
+propkey
+pscustomobject
+QWORD
+regedit
+robocopy
+SACLs
+sdkddkver
+Shobjidl
+Skype
+SRW
+sxs
+Sysinternals
+sysnative
+systemroot
+taskkill
+tasklist
+tdbuildteamid
+unvirtualized
+VCRT
+vcruntime
+Virtualization
+visualstudio
+vscode
+VSTHRD
+winsdkver
+wlk
+wslpath
+wtl
+wtt
+wttlog
+Xamarin

.github/actions/spelling/allow/names.txt

@@ -3,55 +3,78 @@ austdi
 Ballmer
 bhoj
 Bhojwani
+carlos
 dhowett
 Diviness
 dsafa
 duhowett
+ekg
 ethanschoonover
 Firefox
 Gatta
+glsl
+Gravell
 Grie
 Griese
 Hernan
 Howett
 Illhardt
+iquilezles
 jantari
 jerrysh
 Kaiyu
 kimwalisch
 KMehrain
+KODELIFE
+Kodelife
 Kourosh
 kowalczyk
 leonmsft
 Lepilleur
+lhecker
+lukesampson
 Manandhar
 mbadolato
 Mehrain
+menger
 mgravell
 michaelniksa
+michkap
 migrie
 mikegr
 mikemaccana
+miloush
 miniksa
 niksa
+nvaccess
+nvda
 oising
 oldnewthing
+opengl
 osgwiki
+pabhojwa
+panos
 paulcam
 pauldotknopf
+PGP
 Pham
 Rincewind
 rprichard
 Schoonover
+shadertoy
 Somuah
 sonph
 sonpham
 stakx
+thereses
 Walisch
+Wellons
 Wirt
 Wojciech
 zadjii
 Zamor
+Zamora
+zamora
 Zoey
 zorio
 Zverovich

.github/actions/spelling/excludes.txt

@@ -1,3 +1,4 @@
+(?:(?i)\.png$)
 (?:^|/)dirs$
 (?:^|/)go\.mod$
 (?:^|/)go\.sum$
@@ -35,7 +36,6 @@ SUMS$
 \.pbxproj$
 \.pdf$
 \.pem$
-\.png$
 \.psd$
 \.runsettings$
 \.sig$
@@ -45,17 +45,35 @@ SUMS$
 \.tar$
 \.tgz$
 \.ttf$
+\.vsdx$
 \.woff
 \.xcf$
 \.xls
 \.xpm$
 \.yml$
 \.zip$
+^consolegit2gitfilters\.json$
 ^dep/
+^doc/reference/master-sequence-list.csv$
 ^doc/reference/UTF8-torture-test\.txt$
+^oss/
+^src/host/ft_uia/run\.bat$
+^src/host/runft\.bat$
+^src/host/runut\.bat$
 ^src/interactivity/onecore/BgfxEngine\.
 ^src/renderer/wddmcon/WddmConRenderer\.
+^src/terminal/adapter/ut_adapter/run\.bat$
+^src/terminal/parser/delfuzzpayload\.bat$
+^src/terminal/parser/ft_fuzzer/run\.bat$
 ^src/terminal/parser/ft_fuzzer/VTCommandFuzzer\.cpp$
+^src/terminal/parser/ft_fuzzwrapper/run\.bat$
+^src/terminal/parser/ut_parser/run\.bat$
+^src/tools/integrity/packageuwp/ConsoleUWP\.appxSources$
+^src/tools/lnkd/lnkd\.bat$
+^src/tools/pixels/pixels\.bat$
+^src/tools/texttests/fira\.txt$
 ^src/tools/U8U16Test/(?:fr|ru|zh)\.txt$
-^\.github/actions/spell-check/
+^src/types/ut_types/UtilsTests.cpp$
+^\.github/actions/spelling/
 ^\.gitignore$
+^\XamlStyler.json$

.github/actions/spelling/expect/README.md

@@ -0,0 +1,13 @@
+The contents of each `.txt` file in this directory are merged together.
+
+* [alphabet](alphabet.txt) is a sample for alphabet related items
+* [web](web.txt) is a sample for web/html related items
+* [expect](expect.txt) is the main list of expected items -- there is nothing
+particularly special about the file name (beyond the extension which is
+important).
+
+These terms are things which temporarily exist in the project, but which
+aren't necessarily words.
+
+If something is a word that could come and go, it probably belongs in a
+[dictionary](../dictionary/README.md).

.github/actions/spelling/expect/alphabet.txt

@@ -1,3 +1,9 @@
+AAAa
+AAAAA
+AAAAAAAAAAAAA
+AAAAAABBBBBBCCC
+AAAAABBBBBBCCC
+abcd
 abcd
 abcde
 abcdef
@@ -5,12 +11,22 @@ ABCDEFG
 ABCDEFGH
 ABCDEFGHIJ
 abcdefghijk
+ABCDEFGHIJKLMNO
 abcdefghijklmnop
 ABCDEFGHIJKLMNOPQRST
-ABCDEFGHIJKLMNOPQRSTQ
 abcdefghijklmnopqrstuvwxyz
-ABCDEFGHIJPQRST
-ABCDEFGHIJPQRSTQ
+ABCG
+ABE
+abf
+BBBBB
+BBBBBBBB
+BBBBBBBBBBBBBBDDDD
+BBBBBCCC
+BBBBCCCCC
+BBGGRR
+CCE
+EFG
+EFGh
 QQQQQQQQQQABCDEFGHIJ
 QQQQQQQQQQABCDEFGHIJKLMNOPQRSTQQQQQQQQQ
 QQQQQQQQQQABCDEFGHIJKLMNOPQRSTQQQQQQQQQQ
@@ -19,6 +35,7 @@ qrstuvwxyz
 qwerty
 QWERTYUIOP
 qwertyuiopasdfg
+YYYYYYYDDDDDDDDDDD
 ZAAZZ
 ZABBZ
 ZBAZZ
@@ -28,3 +45,4 @@ ZYXWVUT
 ZZBBZ
 ZZZBB
 ZZZBZ
+ZZZZZ

.github/actions/spelling/expect/web.txt

@@ -0,0 +1,19 @@
+http
+www
+easyrgb
+php
+ecma
+rapidtables
+WCAG
+freedesktop
+ycombinator
+robertelder
+kovidgoyal
+leonerd
+fixterms
+winui
+appshellintegration
+mdtauk
+cppreference
+gfycat
+Guake

.github/actions/spelling/patterns/patterns.txt

@@ -0,0 +1,27 @@
+https://(?:(?:[-a-zA-Z0-9?&=]*\.|)microsoft\.com)/[-a-zA-Z0-9?&=_#\/.]*
+https://aka\.ms/[-a-zA-Z0-9?&=\/_]*
+https://www\.itscj\.ipsj\.or\.jp/iso-ir/[-0-9]+\.pdf
+https://www\.vt100\.net/docs/[-a-zA-Z0-9#_\/.]*
+https://www.w3.org/[-a-zA-Z0-9?&=\/_#]*
+https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
+https://(?:[a-z-]+\.|)github(?:usercontent|)\.com/[-a-zA-Z0-9?%&=_\/.]*
+https://www.xfree86.org/[-a-zA-Z0-9?&=\/_#]*
+[Pp]ublicKeyToken="?[0-9a-fA-F]{16}"?
+(?:[{"]|UniqueIdentifier>)[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}(?:[}"]|</UniqueIdentifier)
+(?:0[Xx]|\\x|U\+|#)[a-f0-9A-FGgRr]{2,}[Uu]?[Ll]{0,2}\b
+microsoft/cascadia-code\@[0-9a-fA-F]{40}
+\d+x\d+Logo
+Scro\&ll
+# selectionInput.cpp
+ :\\windows\\syste\b
+TestUtils::VerifyExpectedString\(tb, L"[^"]+"
+(?:hostSm|mach)\.ProcessString\(L"[^"]+"
+\b([A-Za-z])\g{-1}{3,}\b
+0x[0-9A-Za-z]+
+Base64::s_(?:En|De)code\(L"[^"]+"
+VERIFY_ARE_EQUAL\(L"[^"]+"
+"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\+/"
+std::memory_order_[\w]+
+D2DERR_SHADER_COMPILE_FAILED
+TIL_FEATURE_[0-9A-Z_]+
+vcvars\w*

.github/actions/spelling/reject.txt

@@ -0,0 +1,22 @@
+^attache$
+^attacher$
+^attachers$
+^spae$
+^spaebook$
+^spaecraft$
+^spaed$
+^spaedom$
+^spaeing$
+^spaeings$
+^spae-man$
+^spaeman$
+^spaer$
+^Spaerobee$
+^spaes$
+^spaewife$
+^spaewoman$
+^spaework$
+^spaewright$
+^wether$
+^wethers$
+^wetherteg$

.github/workflows/spelling.yml

@@ -1,20 +0,0 @@
-name: Spell checking
-on:
-  push:
-  schedule:
-    # * is a special character in YAML so you have to quote this string
-    - cron: '15 * * * *'
-
-jobs:
-  build:
-    name: Spell checking
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2.0.0
-      with:
-        fetch-depth: 5
-    - uses: check-spelling/check-spelling@0.0.14-alpha
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        bucket: .github/actions
-        project: spell-check

.github/workflows/spelling2.yml

@@ -0,0 +1,20 @@
+# spelling.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-g86g-chm8-7r2p
+name: Spell checking
+on:
+  pull_request_target:
+  push:
+
+jobs:
+  spelling:
+    name: Spell checking
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout-merge
+      if: "contains(github.event_name, 'pull_request')"
+      uses: actions/checkout@v2
+      with:
+        ref: refs/pull/${{github.event.pull_request.number}}/merge
+    - name: checkout
+      if: "!contains(github.event_name, 'pull_request')"
+      uses: actions/checkout@v2
+    - uses: check-spelling/check-spelling@v0.0.19

src/buffer/out/textBuffer.cpp

@@ -2074,7 +2074,7 @@ HRESULT TextBuffer::Reflow(TextBuffer& oldBuffer,
             // Only do so if we were not forced to wrap. If we did
             // force a word wrap, then the existing line break was
             // only because we ran out of space.
-            if (iRight < cOldColsTotal && !charRow.WasWrapForced())
+            if (iRight <= cOldColsTotal && !charRow.WasWrapForced())
             {
                 if (iRight == cOldCursorPos.X && iOldRow == cOldCursorPos.Y)
                 {

src/cascadia/UnitTests_TerminalCore/ConptyRoundtripTests.cpp

@@ -192,6 +192,8 @@ class TerminalCoreUnitTests::ConptyRoundtripTests final
 
     TEST_METHOD(ScrollWithMargins);
 
+    TEST_METHOD(ExactWrapResize);
+
 private:
     bool _writeCallback(const char* const pch, size_t const cch);
     void _flushFirstFrame();
@@ -2359,3 +2361,143 @@ void ConptyRoundtripTests::BreakLinesOnCursorMovement()
 
     verifyBuffer(termTb, term->_mutableViewport.ToInclusive());
 }
+
+void ConptyRoundtripTests::ExactWrapResize()
+{
+    // This is a test for GH#3088
+
+    BEGIN_TEST_METHOD_PROPERTIES()
+        TEST_METHOD_PROPERTY(L"Data:dx", L"{0, 1, 10}")
+        TEST_METHOD_PROPERTY(L"Data:cursorMovementMode", L"{1, 2, 4}")
+    END_TEST_METHOD_PROPERTIES();
+
+    constexpr int MoveCursorWithCUP = 0;
+    constexpr int MoveCursorWithCR_LF = 1;
+    constexpr int MoveCursorWithLF_CR = 2;
+    constexpr int MoveCursorWithVPR_CR = 3;
+    constexpr int MoveCursorWithCUB_LF = 4;
+    constexpr int MoveCursorWithCUD_CR = 5;
+
+    INIT_TEST_PROPERTY(int, dx, L"Controls how much we increase the width by");
+    INIT_TEST_PROPERTY(int, cursorMovementMode, L"Controls how we move the cursor, either with CUP, newline/carriage-return, or some other VT sequence");
+
+    Log::Comment(L"This test will write two lines of text that are exactly the"
+                 L" width of the buffer to the terminal. We'll manually break"
+                 L" these lines. Then we'll increase the width of the terminal"
+                 L" & host. When the re-wrap is complete, the lines should remain broken");
+    VERIFY_IS_NOT_NULL(_pVtRenderEngine.get());
+
+    auto& g = ServiceLocator::LocateGlobals();
+    auto& renderer = *g.pRender;
+    auto& gci = g.getConsoleInformation();
+    auto& si = gci.GetActiveOutputBuffer();
+    auto& hostSm = si.GetStateMachine();
+    auto* hostTb = &si.GetTextBuffer();
+    auto* termTb = term->_buffer.get();
+
+    _flushFirstFrame();
+
+    auto verifyBuffer = [&](const TextBuffer& tb,
+                            const til::rectangle viewport,
+                            const bool afterResize = false) {
+        const auto top = viewport.top<short>();
+
+        const til::point expectedCursor{ 0, top + 2 };
+        VERIFY_ARE_EQUAL(expectedCursor, til::point{ tb.GetCursor().GetPosition() });
+        VERIFY_IS_TRUE(tb.GetCursor().IsVisible());
+
+        // Helper to check that the given row is full of 80 of the provided
+        // character, and the rest of the row is spaces.
+        auto checkRow = [&](const auto row, const auto wch) {
+            VERIFY_IS_FALSE(tb.GetRowByOffset(top).GetCharRow().WasWrapForced());
+            auto iter = TestUtils::VerifyExpectedString(tb,
+                                                        std::wstring(TerminalViewWidth, wch),
+                                                        til::point{ 0, row });
+            if (afterResize && dx > 0)
+            {
+                TestUtils::VerifyExpectedString(std::wstring(dx, L' '), iter);
+            }
+        };
+
+        checkRow(top, L'X');
+        checkRow(top + 1, L'Y');
+    };
+
+    // We're _not_ checking the conpty output during this test, only the side effects.
+    _logConpty = true;
+    _checkConptyOutput = false;
+
+    // Fill the 0'th row with exactly enough 'X's to fill the row.
+    hostSm.ProcessString(std::wstring(TerminalViewWidth, L'X'));
+
+    // Break the line manually. This next section is adapted from
+    // ConptyRoundtripTests::BreakLinesOnCursorMovement. We specifically care
+    // about the \r\n case, because that's how apps usually move the cursor to
+    // the next line, but these are all different ways an application could move
+    // the cursor to the second line.
+    //
+    // Unlike BreakLinesOnCursorMovement, we're only testing the cases where a
+    // cursor movement actaully broke the line. This test would be much too
+    // complicated if we had to try and check the reflowed contents of wrapped
+    // lines.
+
+    // Vim uses CUP to position the cursor on the first cell of each row, every row.
+    // As an additional test, try breaking lines manually with \r\n
+    if (cursorMovementMode == MoveCursorWithCR_LF)
+    {
+        hostSm.ProcessString(L"\r\n");
+    }
+    // As an additional test, try breaking lines manually with \n\r
+    else if (cursorMovementMode == MoveCursorWithLF_CR)
+    {
+        hostSm.ProcessString(L"\n\r");
+    }
+    // As an additional test, move the cursor back with CUB, then down with LF
+    else if (cursorMovementMode == MoveCursorWithCUB_LF)
+    {
+        hostSm.ProcessString(L"\x1b[80D");
+        hostSm.ProcessString(L"\n");
+    }
+
+    // Print a second line of 'Y's. This is important, GH#3088 won't repro if
+    // there isn't a second line in the buffer.
+    hostSm.ProcessString(std::wstring(TerminalViewWidth, L'Y'));
+
+    // We don't care so much about how the second line is broken, we mostly just
+    // care that the line is _there at all_.
+    hostSm.ProcessString(L"\r\n");
+
+    Log::Comment(L"========== Checking the host buffer state before the resize ==========");
+    verifyBuffer(*hostTb, si.GetViewport().ToInclusive());
+
+    Log::Comment(L"Painting the frame");
+    VERIFY_SUCCEEDED(renderer.PaintFrame());
+
+    Log::Comment(L"========== Checking the terminal buffer state before the resize ==========");
+
+    verifyBuffer(*termTb, term->_mutableViewport.ToInclusive());
+
+    Log::Comment(L"========== Resize the Terminal and conpty here ==========");
+    const COORD newViewportSize{
+        ::base::saturated_cast<short>(TerminalViewWidth + dx),
+        ::base::saturated_cast<short>(TerminalViewHeight)
+    };
+
+    auto resizeResult = term->UserResize(newViewportSize);
+    VERIFY_SUCCEEDED(resizeResult);
+    _resizeConpty(newViewportSize.X, newViewportSize.Y);
+
+    // After we resize, make sure to get the new textBuffers
+    hostTb = &si.GetTextBuffer();
+    termTb = term->_buffer.get();
+
+    Log::Comment(L"========== Checking the host buffer state after the resize ==========");
+    verifyBuffer(*hostTb, si.GetViewport().ToInclusive(), true);
+
+    Log::Comment(L"Painting the frame");
+    VERIFY_SUCCEEDED(renderer.PaintFrame());
+
+    Log::Comment(L"========== Checking the terminal buffer state after the resize ==========");
+
+    verifyBuffer(*termTb, term->_mutableViewport.ToInclusive(), true);
+}