Refactor documentation comments and suppress warnings in helper scripts

Author: MariusStorhaug

scripts/helpers/Build-PSModuleDocumentation.ps1

@@ -1,19 +1,22 @@
-#Requires -Modules GitHub
-#Requires -Modules Utilities
-
-function Build-PSModuleDocumentation {
+function Build-PSModuleDocumentation {
     <#
-        .SYNOPSIS
-        Builds a module.
+    .SYNOPSIS
+    Builds a module.
 
-        .DESCRIPTION
-        Builds a module.
+    .DESCRIPTION
+    Builds a module.
     #>
     [CmdletBinding()]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
         'PSReviewUnusedParameter', '', Scope = 'Function',
         Justification = 'LogGroup - Scoping affects the variables line of sight.'
     )]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Want to just write to the console, not the pipeline.'
+    )]
+    #Requires -Modules GitHub
+    #Requires -Modules Utilities
     param(
         # Name of the module.
         [Parameter(Mandatory)]

scripts/helpers/Import-PSModule.ps1

@@ -1,19 +1,22 @@
-#Requires -Modules Utilities
-
-function Import-PSModule {
+function Import-PSModule {
     <#
-        .SYNOPSIS
-        Imports a build PS module.
+    .SYNOPSIS
+    Imports a build PS module.
 
-        .DESCRIPTION
-        Imports a build PS module.
+    .DESCRIPTION
+    Imports a build PS module.
 
-        .EXAMPLE
-        Import-PSModule -SourceFolderPath $ModuleFolderPath -ModuleName $ModuleName
+    .EXAMPLE
+    Import-PSModule -SourceFolderPath $ModuleFolderPath -ModuleName $ModuleName
 
-        Imports a module located at $ModuleFolderPath with the name $ModuleName.
+    Imports a module located at $ModuleFolderPath with the name $ModuleName.
     #>
     [CmdletBinding()]
+    #Requires -Modules Utilities
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Want to just write to the console, not the pipeline.'
+    )]
     param(
         # Path to the folder where the module source code is located.
         [Parameter(Mandatory)]

scripts/helpers/Resolve-PSModuleDependency.ps1

@@ -1,25 +1,28 @@
-#Requires -Modules Retry
-
-function Resolve-PSModuleDependency {
+function Resolve-PSModuleDependency {
     <#
-        .SYNOPSIS
-        Resolve dependencies for a module based on the manifest file.
+    .SYNOPSIS
+    Resolve dependencies for a module based on the manifest file.
 
-        .DESCRIPTION
-        Resolve dependencies for a module based on the manifest file, following PSModuleInfo structure
+    .DESCRIPTION
+    Resolve dependencies for a module based on the manifest file, following PSModuleInfo structure
 
-        .EXAMPLE
-        Resolve-PSModuleDependency -Path 'C:\MyModule\MyModule.psd1'
+    .EXAMPLE
+    Resolve-PSModuleDependency -Path 'C:\MyModule\MyModule.psd1'
 
-        Installs all modules defined in the manifest file, following PSModuleInfo structure.
+    Installs all modules defined in the manifest file, following PSModuleInfo structure.
 
-        .NOTES
-        Should later be adapted to support both pre-reqs, and dependencies.
-        Should later be adapted to take 4 parameters sets: specific version ("requiredVersion" | "GUID"), latest version ModuleVersion,
-        and latest version within a range MinimumVersion - MaximumVersion.
+    .NOTES
+    Should later be adapted to support both pre-reqs, and dependencies.
+    Should later be adapted to take 4 parameters sets: specific version ("requiredVersion" | "GUID"), latest version ModuleVersion,
+    and latest version within a range MinimumVersion - MaximumVersion.
     #>
     [Alias('Resolve-PSModuleDependencies')]
     [CmdletBinding()]
+    #Requires -Modules Retry
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Want to just write to the console, not the pipeline.'
+    )]
     param(
         # The path to the manifest file.
         [Parameter(Mandatory)]

scripts/main.ps1

@@ -1,8 +1,12 @@
-#Requires -Modules Utilities
-
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSAvoidUsingWriteHost', '',
+    Justification = 'Want to just write to the console, not the pipeline.'
+)]
 [CmdletBinding()]
 param()
 
+#Requires -Modules Utilities
+
 $path = (Join-Path -Path $PSScriptRoot -ChildPath 'helpers') | Get-Item | Resolve-Path -Relative
 LogGroup "Loading helper scripts from [$path]" {
     Get-ChildItem -Path $path -Filter '*.ps1' -Recurse | Resolve-Path -Relative | ForEach-Object {