Fixes #27. Allow overriding module output directory

$PSBPreference.Build.ModuleOutDir is now computed internally when
Initialize-PSBuild is run as part of the 'Init' task. It should not be set
directly.

Author: devblackops

CHANGELOG.md

@@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   - `$PSBPreference.Build.CompileScriptHeader`
   - `$PSBPreference.Build.CompileScriptFooter`
 
+### Fixed
+
+- Overriding `$PSBPreference.Build.OutDir` now correctly determines the final module output directory. `$PSBPreference.Build.ModuleOutDir` is now computed internally and **SHOULD NOT BE SET DIRECTLY**. ` $PSBPreference.Build.OutDir` will accept both relative and fully-qualified paths.
+
 ## [0.4.0] - 2019-08-31
 
 ### Changed

PowerShellBuild/PowerShellBuild.psd1

@@ -1,6 +1,6 @@
 @{
     RootModule        = 'PowerShellBuild.psm1'
-    ModuleVersion     = '0.4.0'
+    ModuleVersion     = '0.5.0'
     GUID              = '15431eb8-be2d-4154-b8ad-4cb68a488e3d'
     Author            = 'Brandon Olin'
     CompanyName       = 'Community'

PowerShellBuild/Public/Initialize-PSBuild.ps1

@@ -7,7 +7,7 @@ function Initialize-PSBuild {
     .PARAMETER BuildEnvironment
         Contains the PowerShellBuild settings (known as $PSBPreference).
     .PARAMETER UseBuildHelpers
-        Use BuildHelpers module to popular common environment variables based on current build system context.
+        Use BuildHelpers module to populate common environment variables based on current build system context.
     .EXAMPLE
         PS> Initialize-PSBuild -UseBuildHelpers
 
@@ -22,6 +22,12 @@ function Initialize-PSBuild {
         [switch]$UseBuildHelpers
     )
 
+    if ([IO.Path]::IsPathFullyQualified($BuildEnvironment.Build.OutDir)) {
+        $BuildEnvironment.Build.ModuleOutDir = [IO.Path]::Combine($BuildEnvironment.Build.OutDir, $env:BHProjectName, $BuildEnvironment.General.ModuleVersion)
+    } else {
+        $BuildEnvironment.Build.ModuleOutDir = [IO.Path]::Combine($env:BHProjectPath, $BuildEnvironment.Build.OutDir, $env:BHProjectName, $BuildEnvironment.General.ModuleVersion)
+    }
+
     $params = @{
         BuildOutput = $BuildEnvironment.Build.ModuleOutDir
     }
@@ -36,7 +42,8 @@ function Initialize-PSBuild {
 
     if ($UseBuildHelpers.IsPresent) {
         $nl = [System.Environment]::NewLine
-        "$nl`Environment variables:"
+
+        Write-Host "$nl`Environment variables:" -ForegroundColor Yellow
         (Get-Item ENV:BH*).Foreach({
             '{0,-20}{1}' -f $_.name, $_.value
         })

PowerShellBuild/build.properties.ps1

@@ -28,7 +28,9 @@ $moduleVersion = (Import-PowerShellDataFile -Path $env:BHPSModuleManifest).Modul
         OutDir = $outDir
 
         # Module output directory
-        ModuleOutDir = "$outDir/$env:BHProjectName/$moduleVersion"
+        # This will be computed in 'Initialize-PSBuild' so we can allow the user to
+        # override the top-level 'OutDir' above and compute the full path to the module internally
+        ModuleOutDir = $null
 
         # Controls whether to "compile" module into single PSM1 or not
         CompileModule = $false

README.md

@@ -75,7 +75,7 @@ You can override these in either psake or Invoke-Build to match your environment
 | $PSBPreference.General.ModuleManifestPath | $env:BHPSModuleManifest | Path to the module manifest (PSD1)
 | $PSBPreference.Build.OutDir | $projectRoot/Output | Output directory when building the module
 | $PSBPreference.Build.Dependencies | 'StageFiles, 'BuildHelp' | Default task dependencies for the `Build` task
-| $PSBPreference.Build.ModuleOutDir | $outDir/$moduleName/$moduleVersion | Module output directory
+| $PSBPreference.Build.ModuleOutDir | $outDir/$moduleName/$moduleVersion | `For internal use only. Do not overwrite. Use '$PSBPreference.Build.OutDir' to set output directory`
 | $PSBPreference.Build.CompileModule | $false | Controls whether to "compile" module into single PSM1 or not
 | $PSBPreference.Build.CompileHeader | $false | String that appears at the top of your compiled PSM1 file
 | $PSBPreference.Build.CompileFooter | $false | String that appears at the bottom of your compiled PSM1 file