adds a new spell-checking workflow to the repository (#5377)

spell checker

Co-authored-by: Gladwin Johnson <[email protected]>

Author: gladjohn

.codespellignore

@@ -0,0 +1,3 @@
+aci
+RefreshIn
+AKS

.github/workflows/spellcheck.yml

@@ -0,0 +1,20 @@
+# .github/workflows/spellcheck.yml
+name: Spell check
+on: [pull_request]
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true           # also scan file names
+          ignore_words_file: .codespellignore
+          skip: >
+            src/client/Microsoft.Identity.Client/json/**,
+            tests/**,
+            devapps/**,
+            build/**,
+            docs/**,
+            prototype/**

CHANGELOG.md

@@ -137,7 +137,7 @@ public event EventHandler<CacheChangedEventArgs> CacheChanged
                     }
                     catch (Exception e)
                     {
-                        logger.LogError("An error occured while reading the token cache: " + e);
+                        logger.LogError("An error occurred while reading the token cache: " + e);
                         logger.LogError("Deleting the token cache as it might be corrupt.");
                         tempCache.Clear(ignoreExceptions: true);
                     }

src/client/Microsoft.Identity.Client.Extensions.Msal/MsalCacheHelper.cs

@@ -41,7 +41,7 @@ public class AssertionRequestOptions {
         public IEnumerable<string> ClientCapabilities { get; set; }
 
         /// <summary>
-        /// FMI path to be used for client assertion. Tokens are assocaited with this path in the cache.
+        /// FMI path to be used for client assertion. Tokens are associated with this path in the cache.
         /// </summary>
         public string ClientAssertionFmiPath { get; set; }
     }

src/client/Microsoft.Identity.Client/AppConfig/AssertionRequestOptions.cs

@@ -19,26 +19,26 @@ When removing an account, a removal is performed on both the MSAL and the ADAL c
 
 If the accountId is not null (note that the account id comes from ClientInfo), then delete everything with the same 
 clientInfo and env. 
-Otherwise, delete everything with the same diplayable id (aka preferred username) and env.
+Otherwise, delete everything with the same displayable id (aka preferred username) and env.
 
 Note:
-- RemoveAdalUser is not scoped on ClientId, i.e. it will delete accoutns from different ClientIDs that match the criteria above
+- RemoveAdalUser is not scoped on ClientId, i.e. it will delete accounts from different ClientIDs that match the criteria above
 - GetAccounts and RemoveAccount do not work for ClientCredentail Grant
 
 ### Cache Schema
 
-The location, keys and values of the items stored in the cache are standardized to allow interop (Xamarin iOS <-> obj-c iOS; Xamarin Android <-> Android; interal C++ <-> other platforms). 
+The location, keys and values of the items stored in the cache are standardized to allow interop (Xamarin iOS <-> obj-c iOS; Xamarin Android <-> Android; internal C++ <-> other platforms). 
 The document is here:
 https://identitydivision.visualstudio.com/DevEx/DevEx%20Team/_git/AuthLibrariesApiReview/pullrequest/540?path=%2FUnifiedSchema%2FSchema.md&_a=files
 (we can make this document public on request, keeping it on VSTS just for ease of sharing internally)
 
 Key calculation is platform specific because there are specificities on iOS (multiple keys) and UWP (key size limit of 255 chars).
 
-To ensure key uniqueness, scopes must be normalized (lowercased and oredred alphabetically).
+To ensure key uniqueness, scopes must be normalized (lowercased and ordered alphabetically).
 
 ## Other notes
 
-MSAL is able able to retrieve objects of type IAccount from the MSAL cache. 
+MSAL is able to retrieve objects of type IAccount from the MSAL cache. 
 The token cache is scoped on Env and ClientId.
 When upgrading from ADALv3, the ClinetInfo is null because we do not request an IdToken;
 ClientCredetialGrant - there is also no IdToken -> no ClientInfo. However, this uses a different token cache (AppTokenCache instead of UserTokenCache). This token cache is not unified, i.e. AT obtained from MSAL will not be written back to ADAL (need to verify this statement).

src/client/Microsoft.Identity.Client/Cache/cache.readme.md

@@ -77,7 +77,7 @@ public static AbstractAcquireTokenParameterBuilder<T> WithAuthenticationExtensio
         {
             if (builder.CommonParameters.OnBeforeTokenRequestHandler != null && authenticationExtension.OnBeforeTokenRequestHandler != null)
             {
-                throw new InvalidOperationException("Cannot set both an AuthenticaitonOperation and an OnBeforeTokenRequestHandler");
+                throw new InvalidOperationException("Cannot set both an AuthenticationOperation and an OnBeforeTokenRequestHandler");
             }
 
             builder.CommonParameters.OnBeforeTokenRequestHandler = authenticationExtension.OnBeforeTokenRequestHandler;

src/client/Microsoft.Identity.Client/Extensibility/AbstractConfidentialClientAcquireTokenParameterBuilderExtension.cs

@@ -290,7 +290,7 @@ private AuthenticationResult CreateAuthenticationResultFromCache(MsalAccessToken
         }
 
         /// <summary>
-        /// Gets overriden scopes for client credentials flow
+        /// Gets overridden scopes for client credentials flow
         /// </summary>
         /// <param name="inputScopes"></param>
         /// <returns></returns>

src/client/Microsoft.Identity.Client/Internal/Requests/ClientCredentialRequest.cs

@@ -79,7 +79,7 @@ private async Task<UserAssertion> FetchAssertionFromWsTrustAsync()
                 //IWA is currently not supported in pure adfs environments. See https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/issues/2771
                 throw new MsalClientException(
                             MsalError.IntegratedWindowsAuthenticationFailed,
-                            "Integrated windows authenticaiton is not supported when using WithAdfsAuthority() to specify the authority in ADFS on premises environments"
+                            "Integrated windows authentication is not supported when using WithAdfsAuthority() to specify the authority in ADFS on premises environments"
                             + " See https://aka.ms/msal-net-iwa for more details.");
             }
 

src/client/Microsoft.Identity.Client/Internal/Requests/IntegratedWindowsAuthRequest.cs

@@ -168,7 +168,7 @@ private async Task<MsalTokenResponse> GetTokenResponseAsync(CancellationToken ca
                 _requestParams.ExtraQueryParameters[InstanceAwareParam] = "true";
             }
 
-            // Aligh with MSAL CPP: https://github.com/AzureAD/microsoft-authentication-library-for-cpp/blob/4fa774db2b38cdce9c9b94e3e686ab53fc24b948/source/xplat/requests/WebRequestManager.cpp#L566
+            // Align with MSAL CPP: https://github.com/AzureAD/microsoft-authentication-library-for-cpp/blob/4fa774db2b38cdce9c9b94e3e686ab53fc24b948/source/xplat/requests/WebRequestManager.cpp#L566
             // Always add 'haschrome=1' in the protocol to avoid unexpected back buttons on the first page.
             _requestParams.ExtraQueryParameters["haschrome"] = "1";