chore: ✨ Update build tasks and add cspell configuration

* Refactored build tasks to use `$PSBPreference.TaskDependencies`.
* Introduced `cspell.json` for spell checking configuration.
* Updated `CHANGELOG.md` to reflect changes in task dependencies.
* Adjusted formatting in several scripts for consistency.

Author: HeyItsGilbert

CHANGELOG.md

@@ -7,10 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+- Loose dependencies by allowing them to be overwritten with $PSBPreference.
 - [**#71**](https://github.com/psake/PowerShellBuild/pull/71) Compiled modules
   are now explicitly created as UTF-8 files.
 
-
 ## [0.6.2] 2024-10-06
 
 ### Changed

PowerShellBuild/build.properties.ps1

@@ -1,6 +1,7 @@
+# spell-checker:ignore PSGALLERY BHPS MAML
 BuildHelpers\Set-BuildEnvironment -Force
 
-$outDir        = [IO.Path]::Combine($env:BHProjectPath, 'Output')
+$outDir = [IO.Path]::Combine($env:BHProjectPath, 'Output')
 $moduleVersion = (Import-PowerShellDataFile -Path $env:BHPSModuleManifest).ModuleVersion
 
 [ordered]@{
@@ -22,7 +23,7 @@ $moduleVersion = (Import-PowerShellDataFile -Path $env:BHPSModuleManifest).Modul
     }
     Build = @{
 
-        Dependencies = @('StageFiles', 'BuildHelp')
+        # "Dependencies" moved to TaskDependencies section
 
         # Output directory when building a module
         OutDir = $outDir
@@ -97,8 +98,8 @@ $moduleVersion = (Import-PowerShellDataFile -Path $env:BHPSModuleManifest).Modul
             OutputFileFormat = 'JaCoCo'
         }
     }
-    Help  = @{
-        # Path to updateable help CAB
+    Help = @{
+        # Path to updatable help CAB
         UpdatableHelpOutDir = [IO.Path]::Combine($outDir, 'UpdatableHelp')
 
         # Default Locale used for help generation, defaults to en-US
@@ -122,6 +123,19 @@ $moduleVersion = (Import-PowerShellDataFile -Path $env:BHPSModuleManifest).Modul
         # Credential to authenticate to PowerShell repository with
         PSRepositoryCredential = $null
     }
+    TaskDependencies = @{
+        Clean = @('Init')
+        StageFiles = @('Clean')
+        Build = @('StageFiles', 'BuildHelp')
+        Analyze = @('Build')
+        Pester = @('Build')
+        Test = @('Pester', 'Analyze')
+        BuildHelp = @('GenerateMarkdown', 'GenerateMAML')
+        GenerateMarkdown = @('StageFiles')
+        GenerateMAML = @('GenerateMarkdown')
+        GenerateUpdatableHelp = @('BuildHelp')
+        Publish = @('Test')
+    }
 }
 
 # Enable/disable generation of a catalog (.cat) file for the module.

PowerShellBuild/psakeFile.ps1

@@ -3,7 +3,7 @@
 Remove-Variable -Name PSBPreference -Scope Script -Force -ErrorAction Ignore
 Set-Variable -Name PSBPreference -Option ReadOnly -Scope Script -Value (. ([IO.Path]::Combine($PSScriptRoot, 'build.properties.ps1')))
 
-properties {}
+Properties {}
 
 FormatTaskName {
     param($taskName)
@@ -15,24 +15,24 @@ FormatTaskName {
 # Can't have two 'default' tasks
 # Task default -depends Test
 
-task Init {
+Task Init {
     Initialize-PSBuild -UseBuildHelpers -BuildEnvironment $PSBPreference
 } -description 'Initialize build environment variables'
 
-task Clean -depends Init {
+Task Clean -depends $PSBPreference.TaskDependencies.Clean {
     Clear-PSBuildOutputFolder -Path $PSBPreference.Build.ModuleOutDir
 } -description 'Clears module output directory'
 
-task StageFiles -depends Clean {
+Task StageFiles -depends $PSBPreference.TaskDependencies.StageFiles {
     $buildParams = @{
-        Path                = $PSBPreference.General.SrcRootDir
-        ModuleName          = $PSBPreference.General.ModuleName
-        DestinationPath     = $PSBPreference.Build.ModuleOutDir
-        Exclude             = $PSBPreference.Build.Exclude
-        Compile             = $PSBPreference.Build.CompileModule
-        CompileDirectories  = $PSBPreference.Build.CompileDirectories
-        CopyDirectories     = $PSBPreference.Build.CopyDirectories
-        Culture             = $PSBPreference.Help.DefaultLocale
+        Path = $PSBPreference.General.SrcRootDir
+        ModuleName = $PSBPreference.General.ModuleName
+        DestinationPath = $PSBPreference.Build.ModuleOutDir
+        Exclude = $PSBPreference.Build.Exclude
+        Compile = $PSBPreference.Build.CompileModule
+        CompileDirectories = $PSBPreference.Build.CompileDirectories
+        CopyDirectories = $PSBPreference.Build.CopyDirectories
+        Culture = $PSBPreference.Help.DefaultLocale
     }
 
     if ($PSBPreference.Help.ConvertReadMeToAboutHelp) {
@@ -53,7 +53,7 @@ task StageFiles -depends Clean {
     Build-PSBuildModule @buildParams
 } -description 'Builds module based on source directory'
 
-task Build -depends $PSBPreference.Build.Dependencies -description 'Builds module and generate help documentation'
+Task Build -depends $PSBPreference.TaskDependencies.Build -description 'Builds module and generate help documentation'
 
 $analyzePreReqs = {
     $result = $true
@@ -67,11 +67,11 @@ $analyzePreReqs = {
     }
     $result
 }
-task Analyze -depends Build -precondition $analyzePreReqs {
+Task Analyze -depends $PSBPreference.TaskDependencies.Analyze -precondition $analyzePreReqs {
     $analyzeParams = @{
-        Path              = $PSBPreference.Build.ModuleOutDir
+        Path = $PSBPreference.Build.ModuleOutDir
         SeverityThreshold = $PSBPreference.Test.ScriptAnalysis.FailBuildOnSeverityLevel
-        SettingsPath      = $PSBPreference.Test.ScriptAnalysis.SettingsPath
+        SettingsPath = $PSBPreference.Test.ScriptAnalysis.SettingsPath
     }
     Test-PSBuildScriptAnalysis @analyzeParams
 } -description 'Execute PSScriptAnalyzer tests'
@@ -92,27 +92,27 @@ $pesterPreReqs = {
     }
     return $result
 }
-task Pester -depends Build -precondition $pesterPreReqs {
+Task Pester -depends $PSBPreference.TaskDependencies.Pester -precondition $pesterPreReqs {
     $pesterParams = @{
-        Path                         = $PSBPreference.Test.RootDir
-        ModuleName                   = $PSBPreference.General.ModuleName
-        ModuleManifest               = Join-Path $PSBPreference.Build.ModuleOutDir "$($PSBPreference.General.ModuleName).psd1"
-        OutputPath                   = $PSBPreference.Test.OutputFile
-        OutputFormat                 = $PSBPreference.Test.OutputFormat
-        CodeCoverage                 = $PSBPreference.Test.CodeCoverage.Enabled
-        CodeCoverageThreshold        = $PSBPreference.Test.CodeCoverage.Threshold
-        CodeCoverageFiles            = $PSBPreference.Test.CodeCoverage.Files
-        CodeCoverageOutputFile       = $PSBPreference.Test.CodeCoverage.OutputFile
+        Path = $PSBPreference.Test.RootDir
+        ModuleName = $PSBPreference.General.ModuleName
+        ModuleManifest = Join-Path $PSBPreference.Build.ModuleOutDir "$($PSBPreference.General.ModuleName).psd1"
+        OutputPath = $PSBPreference.Test.OutputFile
+        OutputFormat = $PSBPreference.Test.OutputFormat
+        CodeCoverage = $PSBPreference.Test.CodeCoverage.Enabled
+        CodeCoverageThreshold = $PSBPreference.Test.CodeCoverage.Threshold
+        CodeCoverageFiles = $PSBPreference.Test.CodeCoverage.Files
+        CodeCoverageOutputFile = $PSBPreference.Test.CodeCoverage.OutputFile
         CodeCoverageOutputFileFormat = $PSBPreference.Test.CodeCoverage.OutputFileFormat
-        ImportModule                 = $PSBPreference.Test.ImportModule
+        ImportModule = $PSBPreference.Test.ImportModule
     }
     Test-PSBuildPester @pesterParams
 } -description 'Execute Pester tests'
 
-task Test -depends Pester, Analyze {
+Task Test -depends $PSBPreference.TaskDependencies.Test {
 } -description 'Execute Pester and ScriptAnalyzer tests'
 
-task BuildHelp -depends GenerateMarkdown, GenerateMAML {} -description 'Builds help documentation'
+Task BuildHelp -depends $PSBPreference.TaskDependencies.BuildHelp {} -description 'Builds help documentation'
 
 $genMarkdownPreReqs = {
     $result = $true
@@ -122,12 +122,12 @@ $genMarkdownPreReqs = {
     }
     $result
 }
-task GenerateMarkdown -depends StageFiles -precondition $genMarkdownPreReqs {
+Task GenerateMarkdown -depends $PSBPreference.TaskDependencies.GenerateMarkdown -precondition $genMarkdownPreReqs {
     $buildMDParams = @{
         ModulePath = $PSBPreference.Build.ModuleOutDir
         ModuleName = $PSBPreference.General.ModuleName
-        DocsPath   = $PSBPreference.Docs.RootDir
-        Locale     = $PSBPreference.Help.DefaultLocale
+        DocsPath = $PSBPreference.Docs.RootDir
+        Locale = $PSBPreference.Help.DefaultLocale
     }
     Build-PSBuildMarkdown @buildMDParams
 } -description 'Generates PlatyPS markdown files from module help'
@@ -140,7 +140,7 @@ $genHelpFilesPreReqs = {
     }
     $result
 }
-task GenerateMAML -depends GenerateMarkdown -precondition $genHelpFilesPreReqs {
+Task GenerateMAML -depends $PSBPreference.TaskDependencies.GenerateMAML -precondition $genHelpFilesPreReqs {
     Build-PSBuildMAMLHelp -Path $PSBPreference.Docs.RootDir -DestinationPath $PSBPreference.Build.ModuleOutDir
 } -description 'Generates MAML-based help from PlatyPS markdown files'
 
@@ -152,18 +152,18 @@ $genUpdatableHelpPreReqs = {
     }
     $result
 }
-task GenerateUpdatableHelp -depends BuildHelp -precondition $genUpdatableHelpPreReqs {
+Task GenerateUpdatableHelp -depends $PSBPreference.TaskDependencies.GenerateUpdatableHelp -precondition $genUpdatableHelpPreReqs {
     Build-PSBuildUpdatableHelp -DocsPath $PSBPreference.Docs.RootDir -OutputPath $PSBPreference.Help.UpdatableHelpOutDir
 } -description 'Create updatable help .cab file based on PlatyPS markdown help'
 
-task Publish -depends Test {
+Task Publish -depends $PSBPreference.TaskDependencies.Publish {
     Assert -conditionToCheck ($PSBPreference.Publish.PSRepositoryApiKey -or $PSBPreference.Publish.PSRepositoryCredential) -failureMessage "API key or credential not defined to authenticate with [$($PSBPreference.Publish.PSRepository)] with."
 
     $publishParams = @{
-        Path       = $PSBPreference.Build.ModuleOutDir
-        Version    = $PSBPreference.General.ModuleVersion
+        Path = $PSBPreference.Build.ModuleOutDir
+        Version = $PSBPreference.General.ModuleVersion
         Repository = $PSBPreference.Publish.PSRepository
-        Verbose    = $VerbosePreference
+        Verbose = $VerbosePreference
     }
     if ($PSBPreference.Publish.PSRepositoryApiKey) {
         $publishParams.ApiKey = $PSBPreference.Publish.PSRepositoryApiKey
@@ -176,7 +176,7 @@ task Publish -depends Test {
     Publish-PSBuildModule @publishParams
 } -description 'Publish module to the defined PowerShell repository'
 
-task ? -description 'Lists the available tasks' {
+Task ? -description 'Lists the available tasks' {
     'Available tasks:'
     $psake.context.Peek().Tasks.Keys | Sort-Object
 }

build.ps1

@@ -3,23 +3,22 @@ param(
     # Build task(s) to execute
     [parameter(ParameterSetName = 'task', position = 0)]
     [ArgumentCompleter( {
-        param($Command, $Parameter, $WordToComplete, $CommandAst, $FakeBoundParams)
-        $psakeFile = './psakeFile.ps1'
-        switch ($Parameter) {
-            'Task' {
-                if ([string]::IsNullOrEmpty($WordToComplete)) {
-                    Get-PSakeScriptTasks -buildFile $psakeFile | Select-Object -ExpandProperty Name
+            param($Command, $Parameter, $WordToComplete, $CommandAst, $FakeBoundParams)
+            $psakeFile = './psakeFile.ps1'
+            switch ($Parameter) {
+                'Task' {
+                    if ([string]::IsNullOrEmpty($WordToComplete)) {
+                        Get-PSakeScriptTasks -buildFile $psakeFile | Select-Object -ExpandProperty Name
+                    } else {
+                        Get-PSakeScriptTasks -buildFile $psakeFile |
+                            Where-Object { $_.Name -match $WordToComplete } |
+                            Select-Object -ExpandProperty Name
+                    }
                 }
-                else {
-                    Get-PSakeScriptTasks -buildFile $psakeFile |
-                        Where-Object { $_.Name -match $WordToComplete } |
-                        Select-Object -ExpandProperty Name
+                default {
                 }
             }
-            Default {
-            }
-        }
-    })]
+        })]
     [string[]]$Task = 'default',
 
     # Bootstrap dependencies
@@ -36,10 +35,10 @@ $ErrorActionPreference = 'Stop'
 
 # Bootstrap dependencies
 if ($Bootstrap.IsPresent) {
-    Get-PackageProvider -Name Nuget -ForceBootstrap | Out-Null
+    PackageManagement\Get-PackageProvider -Name Nuget -ForceBootstrap | Out-Null
     Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
     if (-not (Get-Module -Name PSDepend -ListAvailable)) {
-        Install-module -Name PSDepend -Repository PSGallery
+        Install-Module -Name PSDepend -Repository PSGallery
     }
     Import-Module -Name PSDepend -Verbose:$false
     Invoke-PSDepend -Path './requirements.psd1' -Install -Import -Force -WarningAction SilentlyContinue
@@ -48,7 +47,7 @@ if ($Bootstrap.IsPresent) {
 # Execute psake task(s)
 $psakeFile = './psakeFile.ps1'
 if ($PSCmdlet.ParameterSetName -eq 'Help') {
-    Get-PSakeScriptTasks -buildFile $psakeFile  |
+    Get-PSakeScriptTasks -buildFile $psakeFile |
         Format-Table -Property Name, Description, Alias, DependsOn
 } else {
     Set-BuildEnvironment -Force

cspell.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [],
+    "dictionaries": [
+        "powershell",
+        "csharp",
+        "json",
+        "xml",
+        "markdown"
+    ],
+    "words": [],
+    "ignoreWords": [
+        "psake",
+        "MAML"
+    ],
+    "import": []
+}

requirements.psd1

@@ -2,15 +2,15 @@
     PSDependOptions = @{
         Target = 'CurrentUser'
     }
-    BuildHelpers     = '2.0.16'
-    Pester           = @{
+    BuildHelpers = '2.0.16'
+    Pester = @{
         MinimumVersion = '5.6.1'
         Parameters = @{
             SkipPublisherCheck = $true
         }
     }
-    psake            = '4.9.0'
-    PSScriptAnalyzer = '1.19.1'
-    InvokeBuild      = '5.8.1'
-    platyPS          = '0.14.2'
+    psake = '4.9.0'
+    PSScriptAnalyzer = '1.24.0'
+    InvokeBuild = '5.8.1'
+    platyPS = '0.14.2'
 }

tests/TestModule/.build.ps1

@@ -3,6 +3,6 @@ Import-Module ../../Output/PowerShellBuild -Force
 
 $PSBPreference.Build.CompileModule = $true
 
-task Build $PSBPreference.build.dependencies
+Task Build $PSBPreference.TaskDependencies.Build
 
-task . Build
+Task . Build