Add -ReplaceVariablesInComments switch to Expand-SqlCmdDirectives.

Author: sharpjs

CHANGES.md

@@ -13,6 +13,7 @@ Most lines should begin with one of these words:
 - Change `Cmdlet`, renaming to `PSqlCmdlet`.
 - Remove `IConsole`, replacing it with a simpler `ISqlMessageLogger`.
 - Update Microsoft.Data.SqlClient to [5.2.2](https://github.com/dotnet/SqlClient/blob/main/release-notes/5.2/5.2.2.md)
+- Add `-ReplaceVariablesInComments` switch to `Expand-SqlCmdDirectives`.
 - Add retries on transient failures.
 - Fix `EncryptionMode.Default` requiring certificate validation for local
   connections.

PSql.Engine/SqlCmdPreprocessor.cs

@@ -19,6 +19,13 @@ public SqlCmdPreprocessor()
         _preprocessor = new();
     }
 
+    /// <inheritdoc cref="Prequel.SqlCmdPreprocessor.EnableVariableReplacementInComments"/>
+    public bool EnableVariableReplacementInComments
+    {
+        get => _preprocessor.EnableVariableReplacementInComments;
+        set => _preprocessor.EnableVariableReplacementInComments = value;
+    }
+
     /// <summary>
     ///   Defines the specified <c>sqlcmd</c> variables.
     /// </summary>

PSql/Commands/ExpandSqlCmdDirectivesCommand.cs

@@ -27,6 +27,17 @@ public class ExpandSqlCmdDirectivesCommand : PSqlCmdlet
     [Parameter(Position = 1)]
     public Hashtable? Define { get; set; }
 
+    /// <summary>
+    ///   <b>-ReplaceVariablesInComments</b>
+    ///   Perform SQLCMD variable replacement inside SQL comments.
+    /// </summary>
+    [Parameter]
+    public SwitchParameter ReplaceVariablesInComments
+    {
+        get => _preprocessor.EnableVariableReplacementInComments;
+        set => _preprocessor.EnableVariableReplacementInComments = value;
+    }
+
     private readonly E.SqlCmdPreprocessor _preprocessor;
 
     /// <summary>

PSql/en-US/PSql.dll-help.xml

@@ -222,6 +222,9 @@
           <maml:name>Define</maml:name>
           <command:parameterValue required="true">hashtable</command:parameterValue>
         </command:parameter>
+        <command:parameter required="false" position="named" pipelineInput="False" globbing="false">
+          <maml:name>ReplaceVariablesInComments</maml:name>
+        </command:parameter>
       </command:syntaxItem>
     </command:syntax>
 
@@ -251,6 +254,18 @@
         <dev:defaultValue>None</dev:defaultValue>
       </command:parameter>
 
+      <command:parameter required="false" position="named" pipelineInput="False" globbing="false" aliases="none">
+        <maml:name>ReplaceVariablesInComments</maml:name>
+        <maml:description>
+          <maml:para>Perform SQLCMD variable replacement inside SQL comments.</maml:para>
+        </maml:description>
+        <command:parameterValue required="false">SwitchParameter</command:parameterValue>
+        <dev:type>
+          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
+        </dev:type>
+        <dev:defaultValue>False</dev:defaultValue>
+      </command:parameter>
+
     </command:parameters>
 
     <command:inputTypes>