Reduce string allocations in split operations where possible.

Author: mjr4077au

src/PSADT/PSADT.Interop/Utilities/ExceptionUtilities.cs

@@ -290,7 +290,7 @@ private static string GetStackTraceAtPrefix()
                 if (ex.StackTrace is string trace)
                 {
                     string marker = nameof(ExceptionUtilities) + "." + nameof(GetStackTraceAtPrefix);
-                    foreach (string line in trace.Split(['\r', '\n'], StringSplitOptions.RemoveEmptyEntries))
+                    foreach (string line in trace.Split(["\r\n", "\n"], StringSplitOptions.RemoveEmptyEntries))
                     {
                         string trimmed = line.TrimStart();
                         int idx = trimmed.IndexOf(marker, StringComparison.Ordinal);

src/PSADT/PSADT/Types/ShortcutLnk.cs

@@ -62,7 +62,7 @@ public bool IsValidHotkey()
             {
                 return false;
             }
-            string[] parts = Hotkey!.Split('+');
+            string[] parts = Hotkey!.Split(['+'], StringSplitOptions.RemoveEmptyEntries);
             if (parts.Length < 2)
             {
                 return false;

src/PSADT/PSADT/Utilities/MiscUtilities.cs

@@ -35,7 +35,7 @@ public static IReadOnlyList<string> TrimLeadingTrailingLines(IEnumerable<string>
         public static string TrimLeadingTrailingLines(string value)
         {
             ArgumentNullException.ThrowIfNull(value);
-            return string.Join(Environment.NewLine, TrimLeadingTrailingLines(value.Replace("\r", null).Split('\n')));
+            return string.Join(Environment.NewLine, TrimLeadingTrailingLines(value.Split(["\r\n", "\n"], StringSplitOptions.None)));
         }
 
         /// <summary>

src/PSADT/PSADT/WindowsInstaller/MsiUtilities.cs

@@ -285,7 +285,7 @@ public static IReadOnlyList<Guid> GetMspSupportedProductCodes(string szDatabaseP
             using MsiCloseHandleSafeHandle hSummaryInfo = GetSummaryInformation(szDatabasePath);
             return GetSummaryInfoStringProperty(hSummaryInfo, MSI_PROPERTY_ID.PID_TEMPLATE) is not string template || string.IsNullOrWhiteSpace(template)
                 ? throw new InvalidOperationException("The patch database did not contain a valid PID_TEMPLATE property with supported product codes.")
-                : (IReadOnlyList<Guid>)new ReadOnlyCollection<Guid>([.. template.Split(';').Select(static g => new Guid(g))]);
+                : (IReadOnlyList<Guid>)new ReadOnlyCollection<Guid>([.. template.Split([';'], StringSplitOptions.RemoveEmptyEntries).Select(static g => new Guid(g))]);
         }
 
         /// <summary>

src/PSADT/PSAppDeployToolkit/Logging/LogEntry.cs

@@ -47,7 +47,7 @@ internal LogEntry(DateTime timeStamp, string message, LogSeverity severity, stri
             CallerFileName = callerFileName;
             CallerSource = callerSource;
             LegacyLogLine = $"[{timeStamp:O}]{(scriptSection is not null ? $" [{scriptSection}]" : null)} [{source}] [{severity}] :: {LogUtilities.ReplaceInvalidSurrogates(Message)}";
-            CMTraceLogLine = $"<![LOG[{(scriptSection is not null && Message != LogUtilities.LogDivider ? $"[{scriptSection}] :: " : null)}{(Message.Contains('\n') ? (string.Join(Environment.NewLine, LogUtilities.ReplaceInvalidSurrogates(Message).Replace("\r", null).Split('\n').Select(static m => string.IsNullOrWhiteSpace(m) ? LeadingSpaceString : CMTraceFirstChar.Match(m).Index is int start && start > 0 ? string.Concat(new(LeadingSpaceChar, start), m.Substring(start)) : m)) + Environment.NewLine) : LogUtilities.ReplaceInvalidSurrogates(Message))}]LOG]!><time=\"{timeStamp.ToString(@"HH\:mm\:ss.fff", CultureInfo.InvariantCulture)}{(TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes >= 0 ? $"+{TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes}" : TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes.ToString(CultureInfo.InvariantCulture))}\" date=\"{timeStamp.ToString("M-dd-yyyy", CultureInfo.InvariantCulture)}\" component=\"{source}\" context=\"{AccountUtilities.CallerUsername}\" type=\"{(uint)severity}\" thread=\"{AccountUtilities.CallerProcessId}\" file=\"{callerFileName}\">";
+            CMTraceLogLine = $"<![LOG[{(scriptSection is not null && Message != LogUtilities.LogDivider ? $"[{scriptSection}] :: " : null)}{(Message.Contains('\n') ? (string.Join(Environment.NewLine, LogUtilities.ReplaceInvalidSurrogates(Message).Split(["\r\n", "\n"], StringSplitOptions.None).Select(static m => string.IsNullOrWhiteSpace(m) ? LeadingSpaceString : CMTraceFirstChar.Match(m).Index is int start && start > 0 ? string.Concat(new(LeadingSpaceChar, start), m.Substring(start)) : m)) + Environment.NewLine) : LogUtilities.ReplaceInvalidSurrogates(Message))}]LOG]!><time=\"{timeStamp.ToString(@"HH\:mm\:ss.fff", CultureInfo.InvariantCulture)}{(TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes >= 0 ? $"+{TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes}" : TimeZoneInfo.Local.BaseUtcOffset.TotalMinutes.ToString(CultureInfo.InvariantCulture))}\" date=\"{timeStamp.ToString("M-dd-yyyy", CultureInfo.InvariantCulture)}\" component=\"{source}\" context=\"{AccountUtilities.CallerUsername}\" type=\"{(uint)severity}\" thread=\"{AccountUtilities.CallerProcessId}\" file=\"{callerFileName}\">";
         }
 
         /// <summary>

src/PSAppDeployToolkit.Build/Private/Get-ADTInstalledModuleFromModulePath.ps1

@@ -77,7 +77,7 @@ function Get-ADTInstalledModuleFromModulePath
 
     # Get each individual ModulePath values. We reverse the array so we can return objects
     # in order of SystemDirectory/ProgramFiles/UserDirectory like PowerShellGet does.
-    $modulePaths = [System.Environment]::GetEnvironmentVariable('PSModulePath').Split(';', [System.StringSplitOptions]::RemoveEmptyEntries).Trim() | & {
+    $modulePaths = [System.Environment]::GetEnvironmentVariable('PSModulePath').Split(';', [System.StringSplitOptions]::RemoveEmptyEntries).Where({ ![System.String]::IsNullOrWhiteSpace($_) }).Trim() | & {
         begin
         {
             # Open collector to reverse at the end.

src/PSAppDeployToolkit.Build/Private/Invoke-ADTDocusaurusExport.ps1

@@ -21,7 +21,7 @@ function Invoke-ADTDocusaurusExport
             # Trim the file, fix hard-coded line breaks, and fix manually defined code fences.
             if (($content = [System.IO.File]::ReadAllText($file.FullName)) -ne ($newContent = $content.Trim().Replace('&lt;br /&gt;', '<br />').Replace('\{', '{').Replace('\}', '}') -replace '```\s+```powershell\s+```powershell\s+', "``````powershell`n"))
             {
-                [System.IO.File]::WriteAllLines($file.FullName, $newContent.Replace("`r", [System.Management.Automation.Language.NullString]::Value).Split(0x0A).TrimEnd())
+                [System.IO.File]::WriteAllLines($file.FullName, $newContent.Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).TrimEnd())
             }
         }
         Complete-ADTModuleBuildFunction

src/PSAppDeployToolkit.Build/Private/Invoke-ADTMarkdownExport.ps1

@@ -177,7 +177,7 @@ function Invoke-ADTMarkdownExport
             # Write the content back to disk if there's changes.
             if ($newContent -ne $content)
             {
-                [System.IO.File]::WriteAllLines($file.FullName, $newContent.Replace("`r", [System.Management.Automation.Language.NullString]::Value).Split(0x0A).TrimEnd())
+                [System.IO.File]::WriteAllLines($file.FullName, $newContent.Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).TrimEnd())
             }
         }
 
@@ -201,7 +201,7 @@ function Invoke-ADTMarkdownExport
         {
             for ($i = 0; $i -lt $MissingDocumentation.Count; $i++)
             {
-                $output = ($MissingDocumentation[$i] | Select-Object -Property FileName, LineNumber, Line | Format-List -Property * | Out-String -Width ([System.Int32]::MaxValue)).Replace("`r", [System.Management.Automation.Language.NullString]::Value).Trim().Split(0x0A).Trim() -replace '^', "> "
+                $output = ($MissingDocumentation[$i] | Select-Object -Property FileName, LineNumber, Line | Format-List -Property * | Out-String -Width ([System.Int32]::MaxValue)).Trim().Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).Trim() -replace '^', "> "
                 Write-ADTBuildLogEntry -Message "Output for missing documentation MatchInfo [$($i+1)/$($MissingDocumentation.Count)]" -ForegroundColor DarkRed
                 Write-ADTBuildLogEntry -Message $output -ForegroundColor DarkRed
             }

src/PSAppDeployToolkit.Build/Private/Show-ADTModuleInitArtwork.ps1

@@ -27,7 +27,7 @@ function Show-ADTModuleInitArtwork
     $null = if ($Script:ModuleConstants.InitializationArtwork.Style.Equals('Raster'))
     {
         # Get each line.
-        $Script:ModuleConstants.InitializationArtwork.Banner.Replace("`r", [System.Management.Automation.Language.NullString]::Value).Split(0x0A).ForEach({
+        $Script:ModuleConstants.InitializationArtwork.Banner.Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).ForEach({
                 # Print each line's character, then place a line feed before continuing.
                 $_.GetEnumerator().ForEach({
                         # Log the start time, write the character and spin until enough ticks have elapsed. 10000 ticks is 1 millisecond.
@@ -42,7 +42,7 @@ function Show-ADTModuleInitArtwork
     else
     {
         # Get each line and draw one-by-one.
-        $Script:ModuleConstants.InitializationArtwork.Banner.Replace("`r", [System.Management.Automation.Language.NullString]::Value).Split(0x0A).ForEach({
+        $Script:ModuleConstants.InitializationArtwork.Banner.Split([System.String[]]("`r`n", "`n"), [System.StringSplitOptions]::None).ForEach({
                 [System.Console]::WriteLine($_)
                 [System.Threading.Thread]::Sleep(125)
             })

src/PSAppDeployToolkit.Build/Private/Test-ADTBuildEnvironment.ps1

@@ -34,7 +34,7 @@ function Test-ADTBuildEnvironment
 
         # Confirm there's no conflicting module within the PSModulePath (i.e. installed from the gallery).
         Write-ADTBuildLogEntry -Message "Verifying $($Script:ModuleConstants.ModuleName) is not present within any PSModulePath directory."
-        if (Get-ChildItem -LiteralPath $env:PSModulePath.Split(';') -Filter $Script:ModuleConstants.ModuleName -ErrorAction Ignore)
+        if (Get-ChildItem -LiteralPath $env:PSModulePath.Split(';', [System.StringSplitOptions]::RemoveEmptyEntries).Where({ ![System.String]::IsNullOrWhiteSpace($_) }).Trim() -Filter $Script:ModuleConstants.ModuleName -ErrorAction Ignore)
         {
             throw "A conflicting $($Script:ModuleConstants.ModuleName) module was found within a PSModulePath directory. Please uninstall any $($Script:ModuleConstants.ModuleName) modules from the PSGallery and try again."
         }