Skip to content

Commit 95431c9

Browse files
authored
Document new optional parameters added in 1704
1 parent ae712f7 commit 95431c9

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/Rules/UseCorrectCasing.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,35 @@ This rule nonetheless ensures consistent casing for clarity and readability.
1616
Using lowercase keywords helps distinguish them from commands.
1717
Using lowercase operators helps distinguish them from parameters.
1818

19+
## Configuration
20+
21+
```powershell
22+
Rules = @{
23+
PS UseCorrectCasing = @{
24+
Enable = $true
25+
CheckCommands = $true
26+
CheckKeyword = $true
27+
CheckOperator = $true
28+
}
29+
}
30+
```
31+
32+
### Enable: bool (Default value is `$false`)
33+
34+
Enable or disable the rule during ScriptAnalyzer invocation.
35+
36+
### CheckCommands: bool (Default value is `$true`)
37+
38+
If true, require the case of all operators to be lowercase.
39+
40+
### CheckKeyword: bool (Default value is `$true`)
41+
42+
If true, require the case of all keywords to be lowercase.
43+
44+
### CheckOperator: bool (Default value is `$true`)
45+
46+
If true, require the case of all commands to match their actual casing.
47+
1948
## How
2049

2150
Use exact casing for type names.

0 commit comments

Comments
 (0)