-
-
Notifications
You must be signed in to change notification settings - Fork 26
/
PSScriptAnalyzerSettings.psd1
153 lines (153 loc) · 3.92 KB
/
PSScriptAnalyzerSettings.psd1
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<#
.SYNOPSIS
Based on the PowerShell Script Analyzer (PSSA) presets.
.LINK
https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Engine/Settings/
#>
@{
Filter = @(
'**/*.ps1',
'**/*.psm1',
!'* * / Tests/*.ps1'
)
Severity = @(
'Error',
'Warning',
'Information'
)
IncludeRules = @(
'PSAlignAssignmentStatement',
'PSAvoidAssignmentToAutomaticVariable',
'PSAvoidDefaultValueForMandatoryParameter',
'PSAvoidDefaultValueSwitchParameter',
'PSAvoidGlobalAliases',
'PSAvoidGlobalFunctions',
'PSAvoidGlobalVars',
'PSAvoidInvokingEmptyMembers',
'PSAvoidNullOrEmptyHelpMessageAttribute',
'PSAvoidSemicolonsAsLineTerminators',
'PSAvoidShouldContinueWithoutForce',
'PSAvoidTrailingWhitespace',
'PSAvoidUsingBrokenHashAlgorithms',
'PSAvoidUsingCmdletAliases',
'PSAvoidUsingComputerNameHardcoded',
'PSAvoidUsingConvertToSecureStringWithPlainText',
'PSAvoidUsingDeprecatedManifestFields',
'PSAvoidUsingDoubleQuotesForConstantString',
'PSAvoidUsingEmptyCatchBlock',
'PSAvoidUsingInvokeExpression',
'PSAvoidUsingPlainTextForPassword',
'PSAvoidUsingPositionalParameters',
'PSAvoidUsingUserNameAndPasswordParams',
'PSAvoidUsingWMICmdlet',
'PSAvoidUsingWriteHost',
'PSDSC*',
'PSMisleadingBacktick',
'PSMissingModuleManifestField',
'PSPlaceCloseBrace',
'PSPlaceOpenBrace',
'PSPossibleIncorrectComparisonWithNull',
'PSPossibleIncorrectUsageOfAssignmentOperator',
'PSPossibleIncorrectUsageOfRedirectionOperator'
'PSProvideCommentHelp',
'PSReservedCmdletChar',
'PSReservedParams',
'PSReviewUnusedParameter',
'PSShouldProcess',
'PSUseApprovedVerbs',
'PSUseBOMForUnicodeEncodedFile',
'PSUseCmdletCorrectly',
'PSUseCompatibleCmdlets',
'PSUseCompatibleCommands',
'PSUseCompatibleSyntax',
'PSUseCompatibleTypes',
'PSUseConsistentIndentation',
'PSUseConsistentWhitespace',
'PSUseCorrectCasing',
'PSUseDeclaredVarsMoreThanAssignments',
'PSUseLiteralInitializerForHashtable',
'PSUseOutputTypeCorrectly',
'PSUseProcessBlockForPipelineCommand',
'PSUsePSCredentialType',
'PSUseShouldProcessForStateChangingFunctions',
'PSUseLowerCaseForBooleanVariables',
'PSUseLowerCaseForBuiltInFunctions',
'PSUseLowerCaseForParameters',
'PSUseSingularNouns',
'PSUseTitleCaseForCmdletParameters',
'PSUseTitleCaseForConstants',
'PSUseTitleCaseForNonConstants',
'PSUseTitleCaseFunctionNames',
'PSUseTitleCaseVerbs'
)
Rules = @{
PSAlignAssignmentStatement = @{
Enable = $false
}
PSPlaceCloseBrace = @{
Enable = $true
NewLineAfter = $false
IgnoreOneLineBlock = $true
NoEmptyLineBefore = $false
}
PSPlaceOpenBrace = @{
Enable = $true
OnSameLine = $true
NewLineAfter = $true
IgnoreOneLineBlock = $true
}
PSReviewUnusedParameter = @{
Enable = $true
CommandsToTraverse = @(
'New-NinjaOneQuery'
)
}
PSUseCompatibleCmdlets = @{
Enable = $true
Compatibility = @(
'desktop-5.1.14393.206-windows',
'core-6.1.0-windows',
'core-6.1.0-linux',
'core-6.1.0-linux-arm'
'core-6.1.0-macos'
)
}
PSUseCompatibleCommands = @{
Enable = $false
}
PSUseCompatibleSyntax = @{
Enable = $true
TargetVersions = @(
'5.1',
'6.0',
'7.0'
)
}
PSUseConsistentIndentation = @{
Enable = $true
Kind = 'tab'
PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
}
PSUseConsistentWhitespace = @{
Enable = $true
CheckInnerBrace = $true
CheckOpenBrace = $true
CheckOpenParen = $true
CheckOperator = $true
CheckPipe = $true
CheckPipeForRedundantWhitespace = $true
CheckSeparator = $true
CheckParameter = $true
IgnoreAssignmentOperatorInsideHashTable = $true
}
PSUseCorrectCasing = @{
Enable = $true
}
PSUseSingularNouns = @{
Enable = $false
}
PSAvoidUsingDoubleQuotesForConstantString = @{
Enable = $true
}
}
}