Repository navigation
Expand file tree
/
Copy pathPSScriptAnalyzerSettings.psd1
More file actions
94 lines (79 loc) · 2.54 KB
/
Copy pathPSScriptAnalyzerSettings.psd1
File metadata and controls
94 lines (79 loc) · 2.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@{
Severity = @('Error', 'Warning')
IncludeRules = @(
# Security / Dangerous patterns
'PSAvoidUsingInvokeExpression',
'PSAvoidUsingPlainTextForPassword',
'PSAvoidUsingConvertToSecureStringWithPlainText',
'PSAvoidUsingComputerNameHardcoded',
# Bad practices
'PSAvoidUsingCmdletAliases',
'PSAvoidUsingPositionalParameters',
'PSAvoidUsingWriteHost',
'PSAvoidDefaultValueSwitchParameter',
# Cmdlet / function design
'PSUseApprovedVerbs',
'PSUseSingularNouns',
'PSUseShouldProcessForStateChangingFunctions',
'PSUsePSCredentialType',
'PSUseProcessBlockForPipelineCommand',
# Type safety / correctness
'PSUseOutputTypeCorrectly',
'PSUseDeclaredVarsMoreThanAssignments',
'PSUseCmdletCorrectly',
# Compatibility
'PSUseCompatibleSyntax',
'PSUseCompatibleTypes',
'PSUseCompatibleCommands',
# Documentation
'PSProvideCommentHelp',
# Code quality
'PSReviewUnusedParameter',
'PSMisleadingBacktick',
'PSAvoidUsingEmptyCatchBlock',
# Formatting / style
'PSUseConsistentIndentation',
'PSUseConsistentWhitespace',
'PSAvoidTrailingWhitespace',
'PSAvoidMultipleEmptyLines',
'PSAvoidMultipleStatementsPerLine',
'PSPipelineIndentation',
'PSUseCorrectCasing',
'PSHashTableFormatting',
# Misc
'PSReservedCmdletChar',
'PSReservedParams',
'PSMissingModuleManifestField'
)
Rules = @{
# Compatibility configuration
PSUseCompatibleSyntax = @{
Enable = $true
TargetVersions = @('5.1')
}
# Documentation rules
PSProvideCommentHelp = @{
Enable = $true
ExportedOnly = $true
BlockComment = $true
VSCodeSnippetCorrection = $false
Placement = 'before'
}
# Indentation
PSUseConsistentIndentation = @{
IndentationSize = 4
}
# Pipeline formatting
PSPipelineIndentation = @{
Enable = $true
IndentationStyle = 'IncreaseForFirstPipeline'
}
# Hashtable formatting
PSHashTableFormatting = @{
Enable = $true
AlignKeysAndValues = $true
IndentationSize = 4
}
}
ExcludeRules = @('TypeNotFound')
}