IdentityLifecycleEngine/PSScriptAnalyzerSettings.psd1 at main · blindzero/IdentityLifecycleEngine · GitHub

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
# PSScriptAnalyzer settings for IdentityLifecycleEngine (IdLE)
#
# This file is intentionally data-only (no script blocks, no expressions).
# It is used by CI and can also be referenced from VS Code workspace settings.
#
# Notes:
# - We explicitly list IncludeRules to keep the first rollout focused and low-noise.
# - Formatting rules are enabled to align with STYLEGUIDE.md (4 spaces, consistent whitespace).

@{
    Severity     = @('Error', 'Warning')

    IncludeRules = @(
        # Naming / API hygiene
        'PSUseApprovedVerbs',
        'PSAvoidGlobalVars',
        'PSAvoidUsingCmdletAliases',
        'PSAvoidUsingPositionalParameters',
        'PSUseCorrectCasing',

        # Common correctness issues
        'PSAvoidUsingEmptyCatchBlock',
        'PSReviewUnusedParameter',
        'PSUseDeclaredVarsMoreThanAssignments',
        'PSAvoidTrailingWhitespace',

        # Security / risky constructs
        'PSAvoidUsingInvokeExpression',
        'PSAvoidUsingPlainTextForPassword',
        'PSAvoidUsingConvertToSecureStringWithPlainText',

        # Style / formatting (enabled explicitly)
        'PSUseConsistentIndentation',
        'PSUseConsistentWhitespace'
    )

    Rules        = @{
        PSUseConsistentIndentation = @{
            Enable              = $true
            IndentationSize     = 4
            PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
            Kind                = 'space'
        }

        PSUseConsistentWhitespace = @{
            Enable                          = $true
            CheckInnerBrace                 = $true
            CheckOpenBrace                  = $true
            CheckOpenParen                  = $true
            CheckOperator                   = $true
            CheckPipe                       = $true
            CheckPipeForRedundantWhitespace = $false
            CheckSeparator                  = $true
            CheckParameter                  = $false
            IgnoreAssignmentOperatorInsideHashTable = $true
        }
    }
}