Skip to content

Commit 6c4f1d2

Browse files
authored
Document new optional parameters added in 1704 (#2086)
1 parent 28081e5 commit 6c4f1d2

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/Rules/UseCorrectCasing.md

+29
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,35 @@ cmdlet names or parameters does not matter but this rule ensures that the casing
1515
consistency and also because most cmdlets/parameters start with an upper case and using that
1616
improves readability to the human eye.
1717

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

2049
Use exact casing of the cmdlet and its parameters, e.g.

0 commit comments

Comments
 (0)