Skip to content

Convert UseSingularNouns to configurable rule and add Windows to allowlist #1858

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 6 commits into from
Jan 18, 2024
Merged

Convert UseSingularNouns to configurable rule and add Windows to allowlist #1858

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
936f37a
Add Windows to the UseSingularNouns allow list
MJVL Nov 6, 2022
5489f4c
Add test case for Windows verb
MJVL Nov 6, 2022
ae9f6f9
Refactor UseSingularNouns to configurable rule and add tests
MJVL Nov 8, 2022
3866245
Update UseSingularNouns docs with configuration information
MJVL Nov 8, 2022
474e130
Remove extra test code
MJVL Nov 8, 2022
e54153c
Merge branch 'master' into nounFix
bergmeister Jan 18, 2024
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
3 changes: 2 additions & 1 deletion Rules/UseSingularNouns.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ public class CmdletSingularNoun : IScriptRule

private readonly string[] nounAllowList =
{
"Data"
"Data",
"Windows"
};

/// <summary>
Expand Down
14 changes: 14 additions & 0 deletions Tests/Rules/UseSingularNounsReservedVerbs.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,20 @@ Write-Output "Adding some data"
-OutVariable violations
$violations.Count | Should -Be 0
}

It "ignores function name ending with Windows" {
$nounViolationScript = @'
Function Test-Windows
{
Write-Output "Testing Microsoft Windows"
}
'@
Invoke-ScriptAnalyzer -ScriptDefinition $nounViolationScript `
-IncludeRule "PSUseSingularNouns" `
-OutVariable violations
$violations.Count | Should -Be 0
}

}

Context "When there are no violations" {
Expand Down