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.

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

Jump to bottom

Some fixes for README.md, UseSingularNouns.md #213

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Some fixes for README.md, UseSingularNouns.md #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: List of PSScriptAnalyzer rules
ms.custom: PSSA v1.22.0
ms.date: 02/13/2024
ms.date: 03/27/2024
ms.topic: reference
title: List of PSScriptAnalyzer rules
---
Expand Down Expand Up @@ -58,7 +58,7 @@ The PSScriptAnalyzer contains the following rule definitions.
| [ProvideCommentHelp](./ProvideCommentHelp.md) | Information | Yes | Yes |
| [ReservedCmdletChar](./ReservedCmdletChar.md) | Error | Yes | |
| [ReservedParams](./ReservedParams.md) | Error | Yes | |
| [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | |
| [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | Yes<sup>2</sup> |
| [ShouldProcess](./ShouldProcess.md) | Warning | Yes | |
| [UseApprovedVerbs](./UseApprovedVerbs.md) | Warning | Yes | |
| [UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning | Yes | |
Expand All @@ -84,5 +84,5 @@ The PSScriptAnalyzer contains the following rule definitions.

- <sup>1</sup> Rule is not available on all PowerShell versions, editions, or OS platforms. See the
rule's documentation for details.
- <sup>2</sup> The rule a configurable property, but the rule can't be disabled like other
- <sup>2</sup> The rule has a configurable property, but the rule can't be disabled like other
configurable rules.
16 changes: 8 additions & 8 deletions reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Cmdlet Singular Noun
ms.custom: PSSA v1.22.0
ms.date: 03/26/2024
ms.date: 03/27/2024
ms.topic: reference
title: UseSingularNouns
---
Expand All @@ -25,24 +25,24 @@ function Get-Elements {

```powershell
Rules = @{
UseSingularNouns = @{
NounAllowList = 'Data', 'Windows', 'Foos'
PSUseSingularNouns = @{
Enable = $true
NounAllowList = 'Data', 'Windows', 'Foos'
}
}
```

### Parameters

- `UseSingularNouns`: `string[]` (Default value is `{'Data', 'Windows'}`)

Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
excluded by default.

- `Enable`: `bool` (Default value is `$true`)

Enable or disable the rule during ScriptAnalyzer invocation.

- `NounAllowList`: `string[]` (Default value is `{'Data', 'Windows'}`)

Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
excluded by default.

## How

Change plurals to singular.
Expand Down