Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP ReviewUnusedParameter: Search through child scope #1489

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Rules/ReviewUnusedParameter.cs
Original file line number Diff line number Diff line change
@@ -40,7 +40,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
IEnumerable<Ast> parameterAsts = scriptBlockAst.FindAll(oneAst => oneAst is ParameterAst, false);

// list all variables
IDictionary<string, int> variableCount = scriptBlockAst.FindAll(oneAst => oneAst is VariableExpressionAst, false)
IDictionary<string, int> variableCount = scriptBlockAst.FindAll(oneAst => oneAst is VariableExpressionAst, true)
.Select(variableExpressionAst => ((VariableExpressionAst)variableExpressionAst).VariablePath.UserPath)
.GroupBy(variableName => variableName, StringComparer.OrdinalIgnoreCase)
.ToDictionary(variableName => variableName.Key, variableName => variableName.Count(), StringComparer.OrdinalIgnoreCase);
20 changes: 20 additions & 0 deletions Tests/Rules/ReviewUnusedParameter.tests.ps1
Original file line number Diff line number Diff line change
@@ -23,6 +23,26 @@ Describe "ReviewUnusedParameter" {
$Violations.Count | Should -Be 1
}

It "traverses child scriptblock scope" {
$ScriptDefinition = 'param($Param1) { $Param1 }'
Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName | Should -BeNullOrEmpty
}

It "traverses child scriptblock scope within simple function" {
$ScriptDefinition = 'function foo($Param1) { { $Param1 } }'
Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName | Should -BeNullOrEmpty
}

It "traverses child scriptblock scope within a function that uses param" {
$ScriptDefinition = 'function foo { param($Param1) { $Param1 } }'
Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName | Should -BeNullOrEmpty
}

It "traverse child function within a function" {
$ScriptDefinition = 'function foo($Param1) { function bar() { { $Param1 } } }'
Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName | Should -BeNullOrEmpty
}

It "doesn't traverse scriptblock scope" {
$ScriptDefinition = '{ param ($Param1) }; { $Param1 }'
$Violations = Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName