Updates for check-spelling v0.0.25 (#40386)

## Summary of the Pull Request

- #39572 updated check-spelling but ignored:
   > 🐣 Breaking Changes
[Code Scanning action requires a Code Scanning
Ruleset](https://github.com/check-spelling/check-spelling/wiki/Breaking-Change:-Code-Scanning-action-requires-a-Code-Scanning-Ruleset)
If you use SARIF reporting, then instead of the workflow yielding an 
when it fails, it will rely on [github-advanced-security
🤖](https://github.com/apps/github-advanced-security) to report the
failure. You will need to adjust your checks for PRs.

This means that check-spelling hasn't been properly doing its job 😦.

I'm sorry, I should have pushed a thing to this repo earlier,...

Anyway, as with most refreshes, this comes with a number of fixes, some
are fixes for typos that snuck in before the 0.0.25 upgrade, some are
for things that snuck in after, some are based on new rules in
spell-check-this, and some are hand written patterns based on running
through this repository a few times.

About the 🐣 **breaking change**: someone needs to create a ruleset for
this repository (see [Code Scanning action requires a Code Scanning
Ruleset: Sample ruleset

](https://github.com/check-spelling/check-spelling/wiki/Breaking-Change:-Code-Scanning-action-requires-a-Code-Scanning-Ruleset#sample-ruleset)).

The alternative to adding a ruleset is to change the condition to not
use sarif for this repository. In general, I think the github
integration from sarif is prettier/more helpful, so I think that it's
the better choice.

You can see an example of it working in:
- https://github.com/check-spelling-sandbox/PowerToys/pull/23

---------

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Co-authored-by: Mike Griese <migrie@microsoft.com>
Co-authored-by: Dustin L. Howett <dustin@howett.net>
This commit is contained in:
Josh Soref
2025-07-08 18:16:52 -04:00
committed by GitHub
parent f34735edeb
commit bf16e10baf
199 changed files with 950 additions and 697 deletions

View File

@@ -469,7 +469,7 @@ public class UWPApplication : IProgram
}
else
{
// for C:\Windows\MiracastView etc
// for C:\Windows\MiracastView, etc.
path = Path.Combine(Package.Location, "Assets", uri);
}

View File

@@ -827,7 +827,7 @@ public class Win32Program : IProgram
var paths = new HashSet<string>(defaultHashsetSize);
var runCommandPaths = new HashSet<string>(defaultHashsetSize);
// Parallelize multiple sources, and priority based on paths which most likely contain .lnks which are formatted
// Parallelize multiple sources, and priority based on paths which most likely contain .lnk files which are formatted
var sources = new (bool IsEnabled, Func<IEnumerable<string>> GetPaths)[]
{
(true, () => CustomProgramPaths(settings.ProgramSources, settings.ProgramSuffixes)),

View File

@@ -13,7 +13,7 @@ namespace Microsoft.CmdPal.Ext.Apps.Storage;
/// <summary>
/// The intent of this class is to provide a basic subset of 'list' like operations, without exposing callers to the internal representation
/// of the data structure. Currently this is implemented as a list for it's simplicity.
/// of the data structure. Currently this is implemented as a list for its simplicity.
/// </summary>
/// <typeparam name="T">typeof</typeparam>
public class ListRepository<T> : IRepository<T>, IEnumerable<T>

View File

@@ -92,7 +92,7 @@ internal sealed partial class PackageRepository : ListRepository<UWPApplication>
// InitializeAppInfo will throw if there is no AppxManifest.xml for the package.
// Note there are sometimes multiple packages per product and this doesn't necessarily mean that we haven't found the app.
// eg. "Could not find file 'C:\\Program Files\\WindowsApps\\Microsoft.WindowsTerminalPreview_2020.616.45.0_neutral_~_8wekyb3d8bbwe\\AppxManifest.xml'."
// e.g. "Could not find file 'C:\\Program Files\\WindowsApps\\Microsoft.WindowsTerminalPreview_2020.616.45.0_neutral_~_8wekyb3d8bbwe\\AppxManifest.xml'."
catch (System.IO.FileNotFoundException ex)
{
Logger.LogError(ex.Message);

View File

@@ -107,7 +107,7 @@ internal sealed partial class Win32ProgramRepository : ListRepository<Programs.W
// fix for https://github.com/microsoft/PowerToys/issues/34391
// the msi installer creates a shortcut, which is detected by the PT Run and ends up in calling this OnAppRenamed method
// the thread needs to be halted for a short time to avoid locking the new shortcut file as we read it, otherwise the lock causes
// the thread needs to be halted for a short time to avoid locking the new shortcut file as we read it; otherwise, the lock causes
// in the issue scenario that a warning is popping up during the msi install process.
await Task.Delay(1000).ConfigureAwait(false);
@@ -205,12 +205,12 @@ internal sealed partial class Win32ProgramRepository : ListRepository<Programs.W
}
// When a URL application is deleted, we can no longer get the HashCode directly from the path because the FullPath a Url app is the URL obtained from reading the file
[System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1309:Use ordinal string comparison", Justification = "Using CurrentCultureIgnoreCase since application names could be dependent on currentculture See: https://github.com/microsoft/PowerToys/pull/5847/files#r468245190")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1309:Use ordinal string comparison", Justification = "Using CurrentCultureIgnoreCase since application names could be dependent on current culture See: https://github.com/microsoft/PowerToys/pull/5847/files#r468245190")]
private Win32Program? GetAppWithSameNameAndExecutable(string name, string executableName)
{
foreach (Win32Program app in Items)
{
// Using CurrentCultureIgnoreCase since application names could be dependent on currentculture See: https://github.com/microsoft/PowerToys/pull/5847/files#r468245190
// Using CurrentCultureIgnoreCase since application names could be dependent on current culture See: https://github.com/microsoft/PowerToys/pull/5847/files#r468245190
if (name.Equals(app.Name, StringComparison.CurrentCultureIgnoreCase) && executableName.Equals(app.ExecutableName, StringComparison.CurrentCultureIgnoreCase))
{
return app;

View File

@@ -73,7 +73,7 @@ public static class CalculateHelper
private static string CheckScientificNotation(string input)
{
/**
* NOTE: By the time the expression gets to us, it's already in English format.
* NOTE: By the time that the expression gets to us, it's already in English format.
*
* Regex explanation:
* (-?(\d+({0}\d*)?)|-?({0}\d+)): Used to capture one of two types:

View File

@@ -42,7 +42,7 @@ public sealed partial class FallbackCalculatorItem : FallbackCommandItem
_copyCommand.Name = string.IsNullOrWhiteSpace(query) ? string.Empty : Resources.calculator_copy_command_name;
Title = result.Title;
// we have to make the subtitle the equation,
// we have to make the subtitle into an equation,
// so that we will still string match the original query
// Otherwise, something like 1+2 will have a title of "3" and not match
Subtitle = query;

View File

@@ -55,7 +55,7 @@ internal static partial class QueryHelper
/// <param name="query">The query that could contain parts</param>
/// <param name="queryKey">The key part of the query</param>
/// <param name="queryValueName">The value name part of the query</param>
/// <returns><see langword="true"/> when the query search for a key and a value name, otherwise <see langword="false"/></returns>
/// <returns><see langword="true"/> when the query search for a key and a value name; otherwise, <see langword="false"/></returns>
internal static bool GetQueryParts(in string query, out string queryKey, out string queryValueName)
{
var sanitizedQuery = SanitizeQuery(query);

View File

@@ -70,7 +70,7 @@ public class ShellListPageHelpers
var cmd = query;
if (string.IsNullOrEmpty(cmd))
{
results = ResultsFromlHistory();
results = ResultsFromHistory();
}
else
{
@@ -90,16 +90,16 @@ public class ShellListPageHelpers
public List<CommandContextItem> LoadContextMenus(ListItem listItem)
{
var resultlist = new List<CommandContextItem>
var resultList = new List<CommandContextItem>
{
new(new ExecuteItem(listItem.Title, _settings, RunAsType.Administrator)),
new(new ExecuteItem(listItem.Title, _settings, RunAsType.OtherUser )),
};
return resultlist;
return resultList;
}
private List<ListItem> ResultsFromlHistory()
private List<ListItem> ResultsFromHistory()
{
IEnumerable<ListItem> history = _settings.Count.OrderByDescending(o => o.Value)
.Select(m => new ListItem(new ExecuteItem(m.Key, _settings))

View File

@@ -158,7 +158,7 @@ internal static class TimeAndDateHelper
/// <param name="input">String with date/time</param>
/// <param name="timestamp">The new <see cref="DateTime"/> object</param>
/// <param name="inputParsingErrorMsg">Error message shown to the user</param>
/// <returns>True on success, otherwise false</returns>
/// <returns>True on success; otherwise, false</returns>
internal static bool ParseStringAsDateTime(in string input, out DateTime timestamp, out string inputParsingErrorMsg)
{
inputParsingErrorMsg = string.Empty;
@@ -309,7 +309,7 @@ internal static class TimeAndDateHelper
/// Test if input is special parsing for Unix time, Unix time in milliseconds, file time, ...
/// </summary>
/// <param name="input">String with date/time</param>
/// <returns>True if yes, otherwise false</returns>
/// <returns>True if yes; otherwise, false</returns>
internal static bool IsSpecialInputParsing(string input)
{
return _regexSpecialInputFormats.IsMatch(input);

View File

@@ -502,7 +502,7 @@ namespace Microsoft.CmdPal.Ext.TimeDate {
}
/// <summary>
/// Looks up a localized string similar to for; and; nor; but; or; so.
/// Looks up a localized string similar to "for; and; nor; but; or; so".
/// </summary>
public static string Microsoft_plugin_timedate_Search_ConjunctionList {
get {

View File

@@ -30,7 +30,7 @@ internal sealed partial class EndTaskCommand : InvokableCommand
/// Method to initiate killing the process of a window
/// </summary>
/// <param name="window">Window data</param>
/// <returns>True if the PT Run window should close, otherwise false.</returns>
/// <returns>True if the PT Run window should close; otherwise, false.</returns>
private static bool KillProcess(Window window)
{
// Validate process

View File

@@ -35,7 +35,7 @@ internal static class FuzzyMatching
text = text.ToLower(CultureInfo.CurrentCulture);
// Create a grid to march matches like
// eg.
// e.g.
// a b c a d e c f g
// a x x
// c x x

View File

@@ -8,7 +8,7 @@ namespace Microsoft.CmdPal.Ext.WindowWalker.Components;
/// <summary>
/// A class to represent a search string
/// </summary>
/// <remarks>Class was added inorder to be able to attach various context data to
/// <remarks>Class was added in order to be able to attach various context data to
/// a search string</remarks>
internal sealed class SearchString
{

View File

@@ -163,7 +163,7 @@ internal sealed class Window
{
if (!NativeMethods.ShowWindow(Hwnd, ShowWindowCommand.Restore))
{
// ShowWindow doesn't work if the process is running elevated: fallback to SendMessage
// ShowWindow doesn't work if the process is running elevated: fall back to SendMessage
_ = NativeMethods.SendMessage(Hwnd, Win32Constants.WM_SYSCOMMAND, Win32Constants.SC_RESTORE);
}
}

View File

@@ -993,7 +993,7 @@ public enum ExtendedWindowStyles : uint
/// <summary>
/// The window has generic "right-aligned" properties. This depends on the window class. This style has
/// an effect only if the shell language supports reading-order alignment, otherwise is ignored.
/// an effect only if the shell language supports reading-order alignment; otherwise, is ignored.
/// </summary>
WS_EX_RIGHT = 0x1000,

View File

@@ -103,7 +103,7 @@ public class VirtualDesktopHelper
var allDeskValue = (byte[]?)virtualDesktopKey.GetValue("VirtualDesktopIDs", null) ?? Array.Empty<byte>();
if (allDeskValue != null)
{
// We clear only, if we can read from registry. Otherwise we keep the existing values.
// We clear only, if we can read from registry. Otherwise, we keep the existing values.
_availableDesktops.Clear();
// Each guid has a length of 16 elements
@@ -134,7 +134,7 @@ public class VirtualDesktopHelper
else
{
// The registry value is missing when the user hasn't switched the desktop at least one time before reading the registry. In this case we can set it to desktop one.
// We can only set it to desktop one, if we have at least one desktop in the desktops list. Otherwise we keep the existing value.
// We can only set it to desktop one, if we have at least one desktop in the desktops list. Otherwise, we keep the existing value.
ExtensionHost.LogMessage(new LogMessage() { Message = "VirtualDesktopHelper.UpdateDesktopList() failed to read the id for the current desktop form registry." });
_currentDesktop = _availableDesktops.Count >= 1 ? _availableDesktops[0] : _currentDesktop;
}
@@ -236,7 +236,7 @@ public class VirtualDesktopHelper
/// Returns the number (position) of a desktop.
/// </summary>
/// <param name="desktop">The guid of the desktop.</param>
/// <returns>Number of the desktop, if found. Otherwise a value of zero.</returns>
/// <returns>Number of the desktop, if found. Otherwise, a value of zero.</returns>
public int GetDesktopNumber(Guid desktop)
{
if (_desktopListAutoUpdate)

View File

@@ -32,7 +32,7 @@ internal sealed partial class ServiceCommand : InvokableCommand
}
else
{
Icon = new IconInfo("\xEDB5"); // Playbadge12 icon
Icon = new IconInfo("\xEDB5"); // PlayBadge12 icon
}
}

View File

@@ -49,18 +49,18 @@ _You **can** combine them_
### Lists
**Inordered:**
**Unordered:**
* Milk
* Bread
* Wholegrain
* Whole grain
* Butter
Result:
* Milk
* Bread
* Wholegrain
* Whole grain
* Butter
**Ordered:**