Avoid implicit Get-prefix corrections for DSC resource declarations

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Author: Copilot

Rules/AvoidAlias.cs

@@ -138,6 +138,11 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                     continue;
                 }
 
+                if (IsDscResourceDeclaration(cmdAst))
+                {
+                    continue;
+                }
+
                 var commdNameWithGetPrefix = $"Get-{commandName}";
                 var cmdletNameIfCommandWasMissingGetPrefix = Helper.Instance.GetCommandInfo(name: commdNameWithGetPrefix,
                     commandType: CommandTypes.Cmdlet | CommandTypes.Function | CommandTypes.Script);
@@ -186,6 +191,82 @@ private bool IgnoreCommandast(CommandAst cmdAst)
             return false;
         }
 
+        private bool IsDscResourceDeclaration(CommandAst cmdAst)
+        {
+            if (GetDscResourceBody(cmdAst) == null)
+            {
+                return false;
+            }
+
+            for (Ast parent = cmdAst.Parent; parent != null; parent = parent.Parent)
+            {
+                if (parent is ConfigurationDefinitionAst)
+                {
+                    return true;
+                }
+
+                if (parent is FunctionDefinitionAst || parent is HashtableAst)
+                {
+                    return false;
+                }
+
+                // Script resource properties contain executable code, not resource declarations.
+                if (parent is ScriptBlockExpressionAst scriptBlock)
+                {
+                    if (scriptBlock.Parent is CommandAst enclosingCommand)
+                    {
+                        if (GetDscResourceBody(enclosingCommand) != scriptBlock
+                            || !String.IsNullOrEmpty(Helper.Instance.GetCmdletNameFromAlias(enclosingCommand.GetCommandName()))
+                            || Helper.Instance.GetCommandInfo(enclosingCommand.GetCommandName()) != null)
+                        {
+                            return false;
+                        }
+                    }
+                    else if (!(scriptBlock.Parent is ConfigurationDefinitionAst)
+                        && !(scriptBlock.Parent is DynamicKeywordStatementAst)
+                        && !(scriptBlock.Parent is CommandExpressionAst))
+                    {
+                        return false;
+                    }
+                }
+            }
+
+            return false;
+        }
+
+        private ScriptBlockExpressionAst GetDscResourceBody(CommandAst cmdAst)
+        {
+            if (cmdAst.InvocationOperator != TokenKind.Unknown
+                || cmdAst.CommandElements.Count < 2
+                || !(cmdAst.CommandElements[1] is ExpressionAst)
+                || cmdAst.CommandElements[1].Extent.Text == "=")
+            {
+                return null;
+            }
+
+            if (cmdAst.CommandElements.Count == 3)
+            {
+                return cmdAst.CommandElements[2] as ScriptBlockExpressionAst;
+            }
+
+            // A resource's opening brace can be on the following line.
+            if (cmdAst.CommandElements.Count == 2 && cmdAst.Parent is PipelineAst pipeline)
+            {
+                var statements = (pipeline.Parent as NamedBlockAst)?.Statements
+                    ?? (pipeline.Parent as StatementBlockAst)?.Statements;
+                int index = statements == null ? -1 : statements.IndexOf(pipeline);
+                if (index >= 0 && index + 1 < statements.Count
+                    && statements[index + 1] is PipelineAst bodyPipeline
+                    && bodyPipeline.PipelineElements.Count == 1
+                    && bodyPipeline.PipelineElements[0] is CommandExpressionAst bodyExpression)
+                {
+                    return bodyExpression.Expression as ScriptBlockExpressionAst;
+                }
+            }
+
+            return null;
+        }
+
         /// <summary>
         /// For a command like "gci -path c:", returns the extent of "gci" in the command
         /// </summary>

Tests/Rules/AvoidUsingAlias.tests.ps1

@@ -33,6 +33,19 @@ Describe "AvoidUsingAlias" {
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition 'verb' | Where-Object { $_.RuleName -eq $violationName }
             $violations.Count | Should -Be 1
         }
+
+        It "still expands aliases with resource-shaped arguments" {
+            $target = 'icm Server01 { Get-Process }'
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $target -IncludeRule $violationName
+            $violations.Count | Should -Be 1
+            $violations[0].SuggestedCorrections[0].Text | Should -Be 'Invoke-Command'
+        }
+
+        It "still adds the Get prefix to ordinary commands with resource-shaped arguments" {
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition 'Verb Argument {}' -IncludeRule $violationName
+            $violations.Count | Should -Be 1
+            $violations[0].SuggestedCorrections[0].Text | Should -Be 'Get-Verb'
+        }
     }
 
     Context "Violation Extent" {
@@ -65,6 +78,69 @@ Configuration MyDscConfiguration {
                 Get-Count | `
                 Should -Be 0
         }
+
+        It "does not expand DSC resource names during formatting" -skip:($IsLinux -or $IsMacOS) {
+            $target = @'
+Configuration PackageTest {
+    Package PackageExample
+    {
+        Name = "TestPackage"
+    }
+}
+'@
+            $settings = @{ Rules = @{ PSAvoidUsingCmdletAliases = @{ Enable = $true } } }
+            Invoke-ScriptAnalyzer -ScriptDefinition $target -IncludeRule $violationName |
+                Get-Count | Should -Be 0
+            Invoke-Formatter -ScriptDefinition $target -Settings $settings | Should -Be $target
+        }
+    }
+
+    Context "DSC resource ASTs" {
+        It "ignores resource declarations but not executable commands" {
+            $target = @'
+{
+    Verb VerbExample {}
+    Verb NextLineExample
+    {
+    }
+    icm Server01 { Verb Argument {} }
+    & Verb Argument {}
+    function Get-Example {
+        Verb Argument {}
+    }
+    Node localhost
+    {
+        Verb NestedExample {}
+        Script ScriptExample {
+            SetScript = {
+                icm Server01 {}
+                Verb Argument {}
+            }
+        }
+    }
+    $scriptProperties = @{
+        SetScript = { Verb Argument {} }
+    }
+}
+'@
+            $ast = [System.Management.Automation.Language.Parser]::ParseInput($target, [ref]$null, [ref]$null)
+            $body = $ast.EndBlock.Statements[0].PipelineElements[0].Expression.Copy()
+            $configuration = [System.Management.Automation.Language.ConfigurationDefinitionAst]::new(
+                $ast.Extent, $body, 'Resource',
+                [System.Management.Automation.Language.StringConstantExpressionAst]::new($ast.Extent, 'Test', 'BareWord'))
+            $rule = [Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.AvoidAlias]::new()
+
+            $violations = @($rule.AnalyzeScript($configuration, $null))
+
+            $violations.Count | Should -Be 7
+            $violations[0].Extent.Text | Should -Be 'icm'
+            $violations[1].Extent.Text | Should -Be 'Verb'
+            $violations[2].Extent.Text | Should -Be 'Verb'
+            $violations[3].Extent.Text | Should -Be 'Verb'
+            $violations[4].Extent.Text | Should -Be 'icm'
+            $violations[5].Extent.Text | Should -Be 'Verb'
+            $violations[6].Extent.Text | Should -Be 'Verb'
+        }
     }
 
     Context "Settings file provides allowlist" {