Skip to content

New rule - ReviewUnusedParameter #1382

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.

Sign up for GitHub

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

Merged
merged 14 commits into from
Jan 15, 2020
Merged

New rule - ReviewUnusedParameter #1382

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
929ae14
New rule - ReviewUnusedParameter
mattmcnabb Dec 10, 2019
0b5cba3
Merge https://github.com/PowerShell/PSScriptAnalyzer
bergmeister Jan 3, 2020
d6b38f0
Fix test failures in AvoidAssignmentToAutomaticVariable by excluding …
bergmeister Jan 3, 2020
aaa4f41
Fix test failures in other tests when parameters are not used by excl…
bergmeister Jan 3, 2020
f360fdc
make linq query stop earlier for better performance, avoid redundant …
bergmeister Jan 3, 2020
cdbce04
format test file
bergmeister Jan 3, 2020
938a283
Style fixes for PR #1382
mattmcnabb Jan 5, 2020
79c24c7
fix merge conflict
mattmcnabb Jan 10, 2020
67b4846
Fix merge error by re-adding original change
Jan 13, 2020
34379ab
whitespace tidy
Jan 13, 2020
e8d56c1
Use OrderBy to get a dictionary of the variable Count for better perf…
Jan 13, 2020
9f61f2e
case insensitive dictionary and add test case
Jan 13, 2020
00d882d
re-trigger ci
Jan 14, 2020
8c06a41
case insensitive grouping
Jan 14, 2020
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
IDictionary<string, int> variableCount = scriptBlockAst.FindAll(oneAst => oneAst is VariableExpressionAst, false)
.Select(variableExpressionAst => ((VariableExpressionAst)variableExpressionAst).VariablePath.UserPath)
.GroupBy(variableName => variableName)
.ToDictionary(variableName => variableName.Key, variableName => variableName.Count());
.ToDictionary(variableName => variableName.Key, variableName => variableName.Count(), StringComparer.OrdinalIgnoreCase);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rjmholt Your recently added complex.psm1 test actually caught an edge case that happened when I first added StringComparer.OrdinalIgnoreCase only on .ToDictionary, which caused items of different cases (due to groupby originally being case sensitive) to to be added to the case insensitive dictionary, which then gave the error that the same item had already been added. Therefore I had to add it to GroupBy as well. Chapeau 👏

Copy link
Contributor

@rjmholt rjmholt Jan 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes me think that PowerShell and other PowerShell tools should have a few real-world test cases too


// all bets are off if the script uses PSBoundParameters
if (variableCount.ContainsKey("PSBoundParameters"))
Expand Down
8 changes: 7 additions & 1 deletion Tests/Rules/ReviewUnusedParameter.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,13 @@ Describe "ReviewUnusedParameter" {
}

It "has no violations when parameter is called in child scope" -skip {
$ScriptDefinition = 'function Param { param ($Param1) function Child { $Param1 } }'
$ScriptDefinition = 'function foo { param ($Param1) function Child { $Param1 } }'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would think of this as a violation. Since PowerShell has dynamic, rather than lexical, scope, Child's $Param1 reference is not guaranteed to be foo's $Param1 parameter.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather avoid violations that are going to be false positives in most cases in order to avoid similar problems to PSUseDeclaredVarsMoreThanAssignments

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think fair enough we want to not emit when at the boundary of our heuristic. Ideally we'd change this to an actual false case, but it's not that important.

$Violations = Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName
$Violations.Count | Should -Be 0
}

It "has no violations when case of parameter and variable usage do not match" -skip {
$ScriptDefinition = 'function foo { param ($Param1, $param2) $param1; $Param2}'
$Violations = Invoke-ScriptAnalyzer -ScriptDefinition $ScriptDefinition -IncludeRule $RuleName
$Violations.Count | Should -Be 0
}
Expand Down