Fix a bunch of spelling errors across the project #4295

jsoref · 2020-01-19T07:12:57Z

Generated by https://github.com/jsoref/spelling f; to maintain your repo, please consider fchurn

I generally try to ignore upstream bits. I've accidentally included some items from the deps/ directory. I expect someone will give me a list of items to drop, I'm happy to drop whole files/directories, or to split the PR into multiple items (E.g. comments/locals/public).

Closes #4294

miniksa · 2020-02-04T17:25:58Z

Generated by jsoref/spelling f; to maintain your repo, please consider fchurn

@jsoref, is there a way we can run this as a part of our CI and make it fail on a typo like the clang-tidy style rules do?

miniksa

Only change requested specifically is that we undo the ones for the internal renderers (bgfx and wddmcon) and fork that into a new issue so I can fix it upstream in the driver header too.

Also, if you have an idea how we could make a script to enforce this in the CI on our Windows build agents, I'm all for it. I think it would be great to do this like our style checks.

miniksa · 2020-02-04T17:26:43Z

doc/ORGANIZATION.md

 		* `/src/cascadia/TerminalApp` - This DLL represents the implementation of the Windows Terminal application. This includes parsing settings, hosting tabs & panes with Terminals in them, and displaying other UI elements. This DLL is almost entirely UWP-like code, and shouldn't be doing any Win32-like UI work.
 		* `/src/cascadia/WindowsTerminal` - This EXE provides Win32 hosting for the TerminalApp. It will set up XAML islands, and is responsible for drawing the window, either as a standard window or with content in the titlebar (non-client area).
-		* `/src/cascadia/CasadiaPackage` - This is a project for packaging the Windows Terminal and its dependencies into an .appx/.msix for deploying to the machine.
+		* `/src/cascadia/CascadiaPackage` - This is a project for packaging the Windows Terminal and its dependencies into an .appx/.msix for deploying to the machine.


Whoops. Good catch.

miniksa · 2020-02-04T17:30:13Z

doc/specs/#1235 - Azure cloud shell connector/spec.md

@@ -53,7 +53,7 @@ This feature will not impact reliability of Windows Terminal.

 ### Compatibility

-With the implementation being mostly decoupled from the Windows Terminal app itself, no existing code/behaviours should break due to this feature. 
+With the implementation being mostly decoupled from the Windows Terminal app itself, no existing code/behaviors should break due to this feature. 


We would prefer to do the en-US just to be consistent, generally speaking.

We've had our share of en-UK from @bitcrazed dropped into assorted things, though. He very insistently says that Americans were given a perfectly good language that we decided to not use.

I don't mind the mix of them. But if you want to enforce one, lean toward en-US.

miniksa · 2020-02-04T17:32:26Z

src/cascadia/TerminalApp/AppLogic.h

@@ -57,7 +57,7 @@ namespace winrt::TerminalApp::implementation
        // the ctor, you're going to have a bad time. It'll mysteriously fail to
        // activate the AppLogic.
        // ALSO: If you add any UIElements as roots here, make sure they're
-        // updated in _AppLogiclyTheme. The root currently is _root.
+        // updated in _ApplyTheme. The root currently is _root.


Ugh. This was my fault. It was App --> AppLogic in an overzealous find/replace. I thought I fixed them all. So yeah. Apply is the correct revert.

miniksa · 2020-02-04T17:32:53Z

src/cascadia/TerminalApp/FixVisualStudioBug.targets

@@ -8,7 +8,7 @@
    not try to read it.

    Upstream problem report:
-    https://developercommunity.visualstudio.com/content/problem/629524/static-library-reference-causes-there-was-a-proble.html
+    https://developercommunity.visualstudio.com/content/problem/629524/static-library-reference-causes-there-was-a-problem.html


OK, good with me then.

miniksa · 2020-02-04T17:34:14Z

src/cascadia/TerminalConnection/ConptyConnection.cpp

            {
                const auto now = std::chrono::high_resolution_clock::now();
                const std::chrono::duration<double> delta = now - _startTime;

 #pragma warning(suppress : 26477 26485 26494 26482 26446) // We don't control TraceLoggingWrite
                TraceLoggingWrite(g_hTerminalConnectionProvider,
-                                  "RecievedFirstByte",
-                                  TraceLoggingDescription("An event emitted when the connection recieves the first byte"),
+                                  "ReceivedFirstByte",


Nnnnn. @amit-msft, does this mess up reporting if we correct the typo? Or can you glue the two together on the back-end?

miniksa · 2020-02-04T17:39:55Z

src/host/ut_host/TextBufferTests.cpp

-    const auto bbutton = L"\xD83C\xDD71";
-    position = bbutton;
+    const auto bButton = L"\xD83C\xDD71";
+    position = bButton;


I think the author was trying to avoid it looking like the hungarian notation for "boolean Button" as bButton. But it's a test, so I don't mind either way.

miniksa · 2020-02-04T17:40:33Z

src/inc/CppCoreCheck/warnings.h

@@ -57,7 +57,7 @@ enum ECppCoreCheckWarningCodes
    WARNING_NO_CONST_CAST_UNNECESSARY = 26465,                          // Don't use const_cast to cast away const. const_cast is not required; constness or volatility is not being removed by this conversion (type.3: http://go.microsoft.com/fwlink/p/?LinkID=620419).
    WARNING_NO_STATIC_DOWNCAST_POLYMORPHIC = 26466,                     // Don't use static_cast downcasts. A cast from a polymorphic type should use dynamic_cast (type.2: http://go.microsoft.com/fwlink/p/?LinkID=620418).
    WARNING_NO_REINTERPRET_CAST_FROM_VOID_PTR = 26471,                  // Don't use reinterpret_cast. A cast from void* can use static_cast (type.1: http://go.microsoft.com/fwlink/p/?LinkID=620417).
-    WARNING_NO_CASTS_FOR_ARITHMETIC_CONVERSION = 26472,                 // Don't use a static_cast for arithmetic conversions. Use brace initialization, gsl::narrow_cast or gsl::narow (type.1: http://go.microsoft.com/fwlink/p/?LinkID=620417).
+    WARNING_NO_CASTS_FOR_ARITHMETIC_CONVERSION = 26472,                 // Don't use a static_cast for arithmetic conversions. Use brace initialization, gsl::narrow_cast or gsl::narrow (type.1: http://go.microsoft.com/fwlink/p/?LinkID=620417).


This was imported from somewhere, but it's fine to fix the typo.

Looks like it came out of C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\VS\include\CppCoreCheck\warnings.h but the typo looks fixed at least of VS 16.4.4 on my system.

miniksa · 2020-02-04T17:44:08Z

src/renderer/wddmcon/WddmConRenderer.cpp

@@ -248,10 +248,10 @@ bool WddmConEngine::IsInitialized()
            NewChar = &_displayState[rowIndex]->New[colIndex];

            OldChar->Character = NewChar->Character;
-            OldChar->Atribute = NewChar->Atribute;
+            OldChar->Attribute = NewChar->Attribute;


Nnnn. This one goes upstream. Can you revert and file a separate issue for any Atribute to Attribute that is on WddmCon* or Bgfx* related files (that is, any of them that are off of a CD_IO_CHARACTER struct as I have to go fix that in the driver declaration inside Windows too.)

This is now #4469

@miniksa: Are all renderers in this same boat? In trying to rebase I ended up w/ additional changes to files as part of b4e4c86

No, just those two (WddmConEngine and BgfxEngine) because they're special to bring-up editions of Windows that we don't ship. The other renderers don't run data through the driver in the CD_IO_CHARACTER interface.

src/renderer/wddmcon/main.cxx

src/interactivity/onecore/BgfxEngine.cpp

jsoref · 2020-02-04T17:50:23Z

@miniksa : yes, for an example of this integration, see: https://github.com/checkstyle/checkstyle/blob/master/.ci/test-spelling-unknown-words.sh

Note: You also need to pick a dictionary. (For licensing reasons, I don't host my own.)

Ideally you want some sort of bucket which stores your previous set of whitelisted words. For checkstyle, that's: https://github.com/checkstyle/checkstyle/blob/master/.ci/jsoref-spellchecker/whitelist.words

The right place to store the whitelist is probably a bucket (AWS S3/Azure Blob Storage/GCloud Bucket) -- You don't really want to version the whitelist in the repo as it's a large ever changing file that your users don't actually care about.

I haven't written that code yet (I need to do it for my employer's project).

miniksa · 2020-02-04T17:51:37Z

whole fies/directories,

files

Heheheh...

Also

I've accidentally included some items from the deps/ directory.

Be sure you leave those out, for the most part. They come from somewhere else. If you want to make a list of the dependencies that have spelling errors, we can file issues to get them fixed upstream and in here at the same time.

miniksa · 2020-02-04T17:55:02Z

@miniksa : yes, for an example of this integration, see: https://github.com/checkstyle/checkstyle/blob/master/.ci/test-spelling-unknown-words.sh

Note: You also need to pick a dictionary. (For licensing reasons, I don't host my own.)

Ideally you want some sort of bucket which stores your previous set of whitelisted words. For checkstyle, that's: https://github.com/checkstyle/checkstyle/blob/master/.ci/jsoref-spellchecker/whitelist.words

The right place to store the whitelist is probably a bucket (AWS S3/Azure Blob Storage/GCloud Bucket) -- You don't really want to version the whitelist in the repo as it's a large ever changing file that your users don't actually care about.

I haven't written that code yet (I need to do it for my employer's project).

Hm, OK.

We have a bucket in the form of the bucket we use to store our NuGet packages. We could keep a list there.

We would also need to adapt your BASH script to likely a PowerShell one as that's what we'd have to run in the Windows Server CI.

As for a dictionary, maybe we can use one that's installed with Visual Studio? I'd bet there's one in there somewhere and it'll already be on the build agents.

Let's capture this stuff into another work item.

jsoref · 2020-02-04T17:55:57Z

I think at this point I've successfully dropped deps/ unless there are similar things hiding elsewhere.

I can resurrect older versions of my changes to identify the things that could use fixing later once this is merged.

I won't have any time to work on this until tonight. (It looks like it's dropping
53f3966, rebasing, and resolving merge conflicts.)

carlos-zamora

The main thing I was worried about was TraceLoggingWrite() and that's getting tracked by @miniksa's block. I'll approve so that once his comments get resolved, this can just go in. Thanks!

miniksa · 2020-02-04T18:27:57Z

I think at this point I've successfully dropped deps/ unless there are similar things hiding elsewhere.

I can resurrect older versions of my changes to identify the things that could use fixing later once this is merged.

I won't have any time to work on this until tonight. (It looks like it's dropping
53f3966, rebasing, and resolving merge conflicts.)

No problem. No rush. We're slow about PRing when we get busy; take your time fixing it up. Thanks for your effort.

jsoref · 2020-02-05T17:28:43Z

Well, I rebased, and I still haven't had a single successful run. It looks like they're still timing out :-( -- on the bright side, that's already covered by #4295 (reference)

dep/CLI11/CLI11.hpp

miniksa · 2020-02-10T18:57:45Z

Well, I rebased, and I still haven't had a single successful run. It looks like they're still timing out :-( -- on the bright side, that's already covered by #4295 (reference)

I'm working on fixing the test runs. I'll go look at the one you split out next. Thanks.

Just the one comment left that CLI11 is an upstream dependency. So we should fix the typo there and consume (not here).

miniksa · 2020-02-10T19:20:44Z

Presuming the CI is happy now (tests should be better in master), I think we're good to go. Thank you.

ghost · 2020-02-10T20:24:37Z

Hello @DHowett-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.

DHowett-MSFT · 2020-04-08T19:59:43Z

🎉 Once again, thanks for the contribution!

This pull request was included in a set of conhost changes that was just
released with Windows Insider Build 19603.

jsoref added 30 commits January 18, 2020 20:32

spelling: abandon

6aeef6d

spelling: accommodate

27d48aa

spelling: actually

0ce8358

spelling: aforementioned

9bb7b51

spelling: after

3553cf5

spelling: aliases

05172ee

spelling: aligns

e2bbe4b

spelling: analysis

dc9e8ba

spelling: acquire

6b8c1d1

spelling: acquired

6bb4347

spelling: acquiring

06f5c6c

spelling: activities

11be454

spelling: available

8997dcf

spelling: background

1e251a1

spelling: bbutton

be39971

spelling: because

399070f

spelling: beginning

82e9235

spelling: behavior

8a3b562

spelling: build

6b0e7d5

spelling: button

e453638

spelling: calculated

2ec9ca4

spelling: callback

0dd59f6

spelling: cascadia

0207b35

spelling: character

ba36757

spelling: command

aaf392f

spelling: compatibility

cf5abab

spelling: compatible

04b275a

spelling: composition

42e5d9a

spelling: configured

9494e7e

spelling: constructs

4203801

miniksa requested changes Feb 4, 2020

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Feb 4, 2020

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Feb 4, 2020

carlos-zamora approved these changes Feb 4, 2020

View reviewed changes

jsoref mentioned this pull request Feb 5, 2020

spelling: attribute #4469

Closed

5 tasks

jsoref force-pushed the spelling branch from 2af78cb to df75e29 Compare February 5, 2020 00:55

jsoref added 2 commits February 4, 2020 19:58

spelling: attribute

61d7f8c

spelling: availability

6c8be68

jsoref force-pushed the spelling branch from df75e29 to e7732f7 Compare February 5, 2020 01:01

jsoref mentioned this pull request Feb 5, 2020

Consider adding spell checking to CI #4473

Closed

miniksa reviewed Feb 10, 2020

View reviewed changes

dep/CLI11/CLI11.hpp Outdated Show resolved Hide resolved

jsoref force-pushed the spelling branch from e7732f7 to f2cc47d Compare February 10, 2020 19:05

miniksa approved these changes Feb 10, 2020

View reviewed changes

Merge branch 'master' into spelling

137be08

DHowett-MSFT changed the title ~~Spelling~~ Fix a bunch of spelling errors across the project Feb 10, 2020

DHowett-MSFT added the AutoMerge Marked for automatic merge by the bot when requirements are met label Feb 10, 2020

ghost merged commit a13ccfd into microsoft:master Feb 10, 2020

jsoref deleted the spelling branch February 10, 2020 22:09

miniksa mentioned this pull request Feb 12, 2020

Update CLIUtils/CLI11 #4546

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix a bunch of spelling errors across the project #4295

Fix a bunch of spelling errors across the project #4295

jsoref commented Jan 19, 2020 •

edited by DHowett-MSFT

Loading

miniksa commented Feb 4, 2020

miniksa left a comment

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

miniksa Feb 4, 2020

jsoref Feb 5, 2020 •

edited

Loading

miniksa Feb 5, 2020

jsoref commented Feb 4, 2020

miniksa commented Feb 4, 2020

miniksa commented Feb 4, 2020

jsoref commented Feb 4, 2020

carlos-zamora left a comment

miniksa commented Feb 4, 2020

jsoref commented Feb 5, 2020

miniksa commented Feb 10, 2020

miniksa commented Feb 10, 2020

ghost commented Feb 10, 2020

DHowett-MSFT commented Apr 8, 2020

Fix a bunch of spelling errors across the project #4295

Fix a bunch of spelling errors across the project #4295

Conversation

jsoref commented Jan 19, 2020 • edited by DHowett-MSFT Loading

miniksa commented Feb 4, 2020

miniksa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref Feb 5, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented Feb 4, 2020

miniksa commented Feb 4, 2020

miniksa commented Feb 4, 2020

jsoref commented Feb 4, 2020

carlos-zamora left a comment

Choose a reason for hiding this comment

miniksa commented Feb 4, 2020

jsoref commented Feb 5, 2020

miniksa commented Feb 10, 2020

miniksa commented Feb 10, 2020

ghost commented Feb 10, 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.

DHowett-MSFT commented Apr 8, 2020

jsoref commented Jan 19, 2020 •

edited by DHowett-MSFT

Loading

jsoref Feb 5, 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.