(chocolatey#67) Add PSSA linting to the repo

Initial pass for formatting existing scripts and adding the PSSA options to the repo for use in VS Code, and later the build process.
vexx32 · Aug 31, 2022 · 80d6bd2 · 80d6bd2
1 parent b1fb927
commit 80d6bd2
Show file tree

Hide file tree

Showing 41 changed files with 883 additions and 969 deletions.
diff --git a/PSScriptAnalyzerSettings.psd1 b/PSScriptAnalyzerSettings.psd1
@@ -0,0 +1,70 @@
+@{
+    IncludeRules = @(
+        'PSUseBOMForUnicodeEncodedFile',
+        'PSMisleadingBacktick',
+        'PSAvoidUsingCmdletAliases',
+        'PSAvoidTrailingWhitespace',
+        'PSAvoidSemicolonsAsLineTerminators',
+        'PSUseCorrectCasing',
+        'PSPlaceOpenBrace',
+        'PSPlaceCloseBrace',
+        'PSAlignAssignmentStatement',
+        'PSUseConsistentWhitespace',
+        'PSUseConsistentIndentation'
+    )
+
+    Rules        = @{
+
+        <#
+        PSAvoidUsingCmdletAliases          = @{
+            'allowlist' = @('')
+        }#>
+
+        PSAvoidSemicolonsAsLineTerminators = @{
+            Enable = $true
+        }
+
+        PSUseCorrectCasing                 = @{
+            Enable = $true
+        }
+
+        PSPlaceOpenBrace                   = @{
+            Enable             = $true
+            OnSameLine         = $true
+            NewLineAfter       = $true
+            IgnoreOneLineBlock = $false
+        }
+
+        PSPlaceCloseBrace                  = @{
+            Enable             = $true
+            NewLineAfter       = $true
+            IgnoreOneLineBlock = $false
+            NoEmptyLineBefore  = $true
+        }
+
+        PSAlignAssignmentStatement         = @{
+            Enable         = $true
+            CheckHashtable = $true
+        }
+
+        PSUseConsistentIndentation         = @{
+            Enable              = $true
+            Kind                = 'space'
+            PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
+            IndentationSize     = 4
+        }
+
+        PSUseConsistentWhitespace          = @{
+            Enable                                  = $true
+            CheckInnerBrace                         = $true
+            CheckOpenBrace                          = $true
+            CheckOpenParen                          = $true
+            CheckOperator                           = $true
+            CheckPipe                               = $true
+            CheckPipeForRedundantWhitespace         = $false
+            CheckSeparator                          = $true
+            CheckParameter                          = $false
+            IgnoreAssignmentOperatorInsideHashTable = $true
+        }
+    }
+}
diff --git a/src/ChocoCCM.psd1 b/src/ChocoCCM.psd1
@@ -8,147 +8,144 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'ChocoCCM.psm1'
-
-# Version number of this module.
-ModuleVersion = '0.1.2'
-
-# Supported PSEditions
-# CompatiblePSEditions = @()
-
-# ID used to uniquely identify this module
-GUID = '7097e495-f5e0-4d7f-acba-8e2bbeb354af'
-
-# Author of this module
-Author = 'Stephen Valdinger'
-
-# Company or vendor of this module
-CompanyName = 'Chocolatey Software, Inc.'
+    # Script module or binary module file associated with this manifest.
+    RootModule        = 'ChocoCCM.psm1'
+
+    # Version number of this module.
+    ModuleVersion     = '0.1.2'
+
+    # Supported PSEditions
+    # CompatiblePSEditions = @()
+
+    # ID used to uniquely identify this module
+    GUID              = '7097e495-f5e0-4d7f-acba-8e2bbeb354af'
+
+    # Author of this module
+    Author            = 'Stephen Valdinger'
+
+    # Company or vendor of this module
+    CompanyName       = 'Chocolatey Software, Inc.'
 
-# Copyright statement for this module
-Copyright = 'Chocolatey Software, Inc.'
+    # Copyright statement for this module
+    Copyright         = 'Chocolatey Software, Inc.'
 
-# Description of the functionality provided by this module
-Description = 'This module provides a PowerShell wrapper to Chocolatey Central Management. Requires a Chocolatey For Business license. See https://chocolatey.org/docs/central-management for more information.'
+    # Description of the functionality provided by this module
+    Description       = 'This module provides a PowerShell wrapper to Chocolatey Central Management. Requires a Chocolatey For Business license. See https://chocolatey.org/docs/central-management for more information.'
 
-# Minimum version of the PowerShell engine required by this module
-# PowerShellVersion = ''
+    # Minimum version of the PowerShell engine required by this module
+    # PowerShellVersion = ''
 
-# Name of the PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# CLRVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # CLRVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-# RequiredModules = @()
+    # Modules that must be imported into the global environment prior to importing this module
+    # RequiredModules = @()
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-# NestedModules = @()
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    # NestedModules = @()
 
-# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = @('Connect-CCMServer',
-'Get-CCMComputer',
-'Get-CCMSoftware',
-'Get-CCMGroup',
-'Add-CCMGroup',
-'Set-CCMGroup',
-'Remove-CCMGroup',
-'Add-CCMGroupMember',
-'Get-CCMGroupMember',
-'Remove-CCMGroupMember',
-'Get-CCMDeployment',
-'Get-CCMDeploymentStepResult',
-'New-CCMDeployment',
-'New-CCMDeploymentStep',
-'Set-CCMDeploymentStep',
-'Remove-CCMDeployment',
-'Remove-CCMDeploymentStep',
-'Remove-CCMStaleDeployment',
-'Start-CCMDeployment',
-'Stop-CCMDeployment',
-'Export-CCMDeployment',
-'Export-CCMDeploymentReport',
-'Move-CCMDeploymentToReady',
-'Disable-CCMDeployment',
-'Get-DeploymentResult',
-'Get-CCMOutdatedSoftwareMember',
-'Get-CCMOutdatedSoftware',
-'New-CCMOutdatedSoftwareReport',
-'Get-CCMOutdatedSoftwareReport',
-'Get-CCMOutdatedSoftwarereportDetail',
-'Export-CCMOutdatedSoftwareReport',
-'Set-CCMNotificationStatus',
-'Get-CCMRole')
+    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+    FunctionsToExport = @('Connect-CCMServer',
+        'Get-CCMComputer',
+        'Get-CCMSoftware',
+        'Get-CCMGroup',
+        'Add-CCMGroup',
+        'Set-CCMGroup',
+        'Remove-CCMGroup',
+        'Add-CCMGroupMember',
+        'Get-CCMGroupMember',
+        'Remove-CCMGroupMember',
+        'Get-CCMDeployment',
+        'Get-CCMDeploymentStepResult',
+        'New-CCMDeployment',
+        'New-CCMDeploymentStep',
+        'Set-CCMDeploymentStep',
+        'Remove-CCMDeployment',
+        'Remove-CCMDeploymentStep',
+        'Remove-CCMStaleDeployment',
+        'Start-CCMDeployment',
+        'Stop-CCMDeployment',
+        'Export-CCMDeployment',
+        'Export-CCMDeploymentReport',
+        'Move-CCMDeploymentToReady',
+        'Disable-CCMDeployment',
+        'Get-DeploymentResult',
+        'Get-CCMOutdatedSoftwareMember',
+        'Get-CCMOutdatedSoftware',
+        'New-CCMOutdatedSoftwareReport',
+        'Get-CCMOutdatedSoftwareReport',
+        'Get-CCMOutdatedSoftwarereportDetail',
+        'Export-CCMOutdatedSoftwareReport',
+        'Set-CCMNotificationStatus',
+        'Get-CCMRole')
 
-# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-CmdletsToExport = '*'
+    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+    CmdletsToExport   = '*'
 
-# Variables to export from this module
-VariablesToExport = '*'
+    # Variables to export from this module
+    VariablesToExport = '*'
 
-# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-AliasesToExport = 'Archive-CCMDeployment'
+    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+    AliasesToExport   = 'Archive-CCMDeployment'
 
-# DSC resources to export from this module
-# DscResourcesToExport = @()
+    # DSC resources to export from this module
+    # DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-# ModuleList = @()
+    # List of all modules packaged with this module
+    # ModuleList = @()
 
-# List of all files packaged with this module
-# FileList = @()
-
-# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-PrivateData = @{
-
-    PSData = @{
-
-        # Tags applied to this module. These help with module discovery in online galleries.
-         Tags = @('chocolatey','central-management','automation')
-
-        # A URL to the license for this module.
-         LicenseUri = 'https://github.com/chocolatey/choco/blob/master/LICENSE'
-
-        # A URL to the main website for this project.
-        # ProjectUri = ''
-
-        # A URL to an icon representing this module.
-        # IconUri = ''
-
-        # ReleaseNotes of this module
-        # ReleaseNotes = ''
-
-    } # End of PSData hashtable
-
-} # End of PrivateData hashtable
-
-# HelpInfo URI of this module
- HelpInfoURI = 'https://chocolatey.org/docs/choco-ccmfunction-reference'
-
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
+    # List of all files packaged with this module
+    # FileList = @()
+
+    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+    PrivateData       = @{
+
+        PSData = @{
 
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags       = @('chocolatey', 'central-management', 'automation')
+
+            # A URL to the license for this module.
+            LicenseUri = 'https://github.com/chocolatey/choco/blob/master/LICENSE'
+
+            # A URL to the main website for this project.
+            # ProjectUri = ''
+
+            # A URL to an icon representing this module.
+            # IconUri = ''
+
+            # ReleaseNotes of this module
+            # ReleaseNotes = ''
+        } # End of PSData hashtable
+    } # End of PrivateData hashtable
+
+    # HelpInfo URI of this module
+    HelpInfoURI       = 'https://chocolatey.org/docs/choco-ccmfunction-reference'
+
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 }
diff --git a/src/ChocoCCM.psm1 b/src/ChocoCCM.psm1
@@ -1 +1 @@
-Get-ChildItem .\Public\*.ps1 | % { . $_.Fullname }
+Get-ChildItem .\Public\*.ps1 | ForEach-Object { . $_.Fullname }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Get-ChildItem .\Public\*.ps1 \| % { . $_.Fullname }
		Get-ChildItem .\Public\*.ps1 \| ForEach-Object { . $_.Fullname }