Bugfix script parse whitespace (#1457)

PowerShell · Oct 25, 2023 · 91d5c46 · 91d5c46
1 parent 122cdcb
commit 91d5c46
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 4 deletions.
diff --git a/src/code/PSScriptFileInfo.cs b/src/code/PSScriptFileInfo.cs
@@ -127,15 +127,15 @@ internal static bool TryParseScriptFileContents(
             {
                 string line = fileContents[i];
 
-                if (line.StartsWith("<#PSScriptInfo"))
+                if (line.Trim().StartsWith("<#PSScriptInfo"))
                 {
                     int j = i + 1; // start at the next line
                     // keep grabbing lines until we get to closing #>
                     while (j < fileContents.Length)
                     {
                         string blockLine = fileContents[j];
                         psScriptInfoCommentContent.Add(blockLine);
-                        if (blockLine.StartsWith("#>"))
+                        if (blockLine.Trim().StartsWith("#>"))
                         {
 
                             reachedPSScriptInfoCommentEnd = true;
@@ -157,7 +157,7 @@ internal static bool TryParseScriptFileContents(
                         return false;
                     }
                 }
-                else if (line.StartsWith("<#"))
+                else if (line.Trim().StartsWith("<#"))
                 {
                     // The next comment block must be the help comment block (containing description)
                     // keep grabbing lines until we get to closing #>
@@ -166,7 +166,7 @@ internal static bool TryParseScriptFileContents(
                     {
                         string blockLine = fileContents[j];
 
-                        if (blockLine.StartsWith("#>"))
+                        if (blockLine.Trim().StartsWith("#>"))
                         {
                             reachedHelpInfoCommentEnd = true;
                             i = j + 1;

diff --git a/test/PSScriptFileInfoTests/TestPSScriptFile.Tests.ps1 b/test/PSScriptFileInfoTests/TestPSScriptFile.Tests.ps1
@@ -88,4 +88,11 @@ Describe "Test Test-PSScriptFileInfo" -tags 'CI' {
 
         Test-PSScriptFileInfo $scriptFilePath | Should -Be $true
     }
+
+    It "determine script with whitespace before closing comment is valid" {
+        $scriptName = "ScriptWithWhitespaceBeforeClosingComment.ps1"
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+
+        Test-PSScriptFileInfo $scriptFilePath | Should -Be $true
+    }
 }
diff --git a/test/testFiles/testScripts/ScriptWithWhitespaceBeforeClosingComment.ps1 b/test/testFiles/testScripts/ScriptWithWhitespaceBeforeClosingComment.ps1
@@ -0,0 +1,42 @@
+
+<#PSScriptInfo
+
+.VERSION 1.0
+
+.GUID 3951be04-bd06-4337-8dc3-a620bf539fbd
+
+.AUTHOR annavied
+
+.COMPANYNAME
+
+.COPYRIGHT
+
+.TAGS
+
+.LICENSEURI
+
+.PROJECTURI
+
+.ICONURI
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS
+
+.EXTERNALSCRIPTDEPENDENCIES
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+#>
+
+<# 
+
+.DESCRIPTION 
+ this is a test for a script that will be published remotely 
+
+ #> 
+Param()
+