PSFProject next

Author: Friedrich Weinmann

PSModuleDevelopment/changelog.md

@@ -1,4 +1,15 @@
 # Changelog
+## 2.2.7.91 (May 30th, 2020)
+
+- Upd: Template PSFTest - Pester v5 compatibility
+- Upd: Template PSFModule - Pester v5 compatibility
+- Upd: Template PSFProject - Pester v5 compatibility
+- Upd: Template PSFProject - Simplified module import workflow
+- Upd: Template PSFProject - Improved build process cross-agent convenience
+- Upd: Template PSFProject - Prerequisites task automatically detects module dependencies
+- Upd: Template PSFProject - Prerequisites task can be configured to work with any registered repository
+- Upd: Export-PSMDString - Now also detects splatted localization strings (thanks @StevePlp ; #117)
+
 ## 2.2.7.90 (September 1st, 2019)
  - New: Export-PSMDString - Parses strings from modules using the PSFramework localization feature.
  - Upd: Measure-PSMDCommand - Renamed from Measure-PSMDCommandEx, performance upgrades, adding option for comparing multiple test sets.

templates/PSFModule/PSMDTemplate.ps1

@@ -1,6 +1,6 @@
 @{
 	TemplateName = 'PSFModule'
-	Version = "1.1.1.0"
+	Version = "1.1.2.0"
 	AutoIncrementVersion = $true
 	Tags = 'module','psframework'
 	Author = 'Friedrich Weinmann'
@@ -22,10 +22,8 @@
 		testfolder = {
 
 		}
-		testresults = {
-			@'
-$results = Invoke-Pester -Script $file.FullName -Show $Show -PassThru
-'@
+		pesterconfig = {
+
 		}
 	}
 }

templates/PSFModule/internal/scripts/postimport.ps1

@@ -1,22 +1,26 @@
-# Add all things you want to run after importing the main code
+<#
+Add all things you want to run after importing the main function code
+
+WARNING: ONLY provide paths to files!
+
+After building the module, this file will be completely ignored, adding anything but paths to files ...
+- Will not work after publishing
+- Could break the build process
+#>
+
+$moduleRoot = Split-Path (Split-Path $PSScriptRoot)
 
 # Load Configurations
-foreach ($file in (Get-ChildItem "$($script:ModuleRoot)\internal\configurations\*.ps1" -ErrorAction Ignore)) {
-	. Import-ModuleFile -Path $file.FullName
-}
+(Get-ChildItem "$moduleRoot\internal\configurations\*.ps1" -ErrorAction Ignore).FullName
 
 # Load Scriptblocks
-foreach ($file in (Get-ChildItem "$($script:ModuleRoot)\internal\scriptblocks\*.ps1" -ErrorAction Ignore)) {
-	. Import-ModuleFile -Path $file.FullName
-}
+(Get-ChildItem "$moduleRoot\internal\scriptblocks\*.ps1" -ErrorAction Ignore).FullName
 
 # Load Tab Expansion
-foreach ($file in (Get-ChildItem "$($script:ModuleRoot)\internal\tepp\*.tepp.ps1" -ErrorAction Ignore)) {
-	. Import-ModuleFile -Path $file.FullName
-}
+(Get-ChildItem "$moduleRoot\internal\tepp\*.tepp.ps1" -ErrorAction Ignore).FullName
 
 # Load Tab Expansion Assignment
-. Import-ModuleFile -Path "$($script:ModuleRoot)\internal\tepp\assignment.ps1"
+"$moduleRoot\internal\tepp\assignment.ps1"
 
 # Load License
-. Import-ModuleFile -Path "$($script:ModuleRoot)\internal\scripts\license.ps1"
+"$moduleRoot\internal\scripts\license.ps1"

templates/PSFModule/internal/scripts/preimport.ps1

@@ -1,4 +1,14 @@
-# Add all things you want to run before importing the main code
+<#
+Add all things you want to run before importing the main function code.
+
+WARNING: ONLY provide paths to files!
+
+After building the module, this file will be completely ignored, adding anything but paths to files ...
+- Will not work after publishing
+- Could break the build process
+#>
+
+$moduleRoot = Split-Path (Split-Path $PSScriptRoot)
 
 # Load the strings used in messages
-. Import-ModuleFile -Path "$($script:ModuleRoot)\internal\scripts\strings.ps1"
+"$moduleRoot\internal\scripts\strings.ps1"

templates/PSFModule/þnameþ.psm1

@@ -54,7 +54,9 @@ function Import-ModuleFile
 if ($importIndividualFiles)
 {
 	# Execute Preimport actions
-	. Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1"
+	foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) {
+		. Import-ModuleFile -Path $path
+	}
 
 	# Import all internal functions
 	foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore))
@@ -69,7 +71,9 @@ if ($importIndividualFiles)
 	}
 
 	# Execute Postimport actions
-	. Import-ModuleFile -Path "$ModuleRoot\internal\scripts\postimport.ps1"
+	foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) {
+		. Import-ModuleFile -Path $path
+	}
 
 	# End it here, do not load compiled code below
 	return

templates/PSFProject/PSMDTemplate.ps1

@@ -1,6 +1,6 @@
 @{
 	TemplateName = 'PSFProject'
-	Version = "1.3.1.0"
+	Version = "1.3.2.0"
 	AutoIncrementVersion = $true
 	Tags = 'module','psframework'
 	Author = 'Friedrich Weinmann'
@@ -34,11 +34,8 @@ Write-PSFMessage -Level Important -Message "Creating test result folder"
 $null = New-Item -Path "$PSScriptRoot\..\.." -Name TestResults -ItemType Directory -Force
 '@
 		}
-		testresults = {
-			@'
-$TestOuputFile = Join-Path "$PSScriptRoot\..\..\TestResults" "TEST-$($file.BaseName).xml"
-    $results = Invoke-Pester -Script $file.FullName -Show $Show -PassThru -OutputFile $TestOuputFile -OutputFormat NUnitXml
-'@
+		pesterconfig = {
+'[PesterConfiguration]::Default.TestResult.Enabled = $true'
 		}
 	}
 }

templates/PSFProject/README.md

@@ -7,27 +7,25 @@ Remember, it's the first thing a visitor will see.
 # Project Setup Instructions
 ## Working with the layout
 
- - Don't touch the psm1 file
- - Place functions you export in `functions/` (can have subfolders)
- - Place private/internal functions invisible to the user in `internal/functions` (can have subfolders)
- - Don't add code directly to the `postimport.ps1` or `preimport.ps1`.
-   Those files are designed to import other files only.
- - When adding files you load during `preimport.ps1`, be sure to add corresponding entries to `filesBefore.txt`.
-   The text files are used as reference when compiling the module during the build script.
- - When adding files you load during `postimport.ps1`, be sure to add corresponding entries to `filesAfter.txt`.
-   The text files are used as reference when compiling the module during the build script.
+- Don't touch the psm1 file
+- Place functions you export in `functions/` (can have subfolders)
+- Place private/internal functions invisible to the user in `internal/functions` (can have subfolders)
+- Don't add code directly to the `postimport.ps1` or `preimport.ps1`.
+  Those files are designed to import other files only.
+- When adding files & folders, make sure they are covered by either `postimport.ps1` or `preimport.ps1`.
+  This adds them to both the import and the build sequence.
 
 ## Setting up CI/CD
 
 > To create a PR validation pipeline, set up tasks like this:
 
- - Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1)
- - Validate (PowerShell Task; VSTS-Validate.ps1)
- - Publish Test Results (Publish Test Results; NUnit format; Run no matter what)
+- Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1)
+- Validate (PowerShell Task; VSTS-Validate.ps1)
+- Publish Test Results (Publish Test Results; NUnit format; Run no matter what)
 
 > To create a build/publish pipeline, set up tasks like this:
 
- - Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1)
- - Validate (PowerShell Task; VSTS-Validate.ps1)
- - Build (PowerShell Task; VSTS-Build.ps1)
- - Publish Test Results (Publish Test Results; NUnit format; Run no matter what)
+- Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1)
+- Validate (PowerShell Task; VSTS-Validate.ps1)
+- Build (PowerShell Task; VSTS-Build.ps1)
+- Publish Test Results (Publish Test Results; NUnit format; Run no matter what)

templates/PSFProject/build/filesAfter.txt

@@ -30,6 +30,7 @@ if (-not $WorkingDirectory)
 	}
 	else { $WorkingDirectory = $env:SYSTEM_DEFAULTWORKINGDIRECTORY }
 }
+if (-not $WorkingDirectory) { $WorkingDirectory = Split-Path $PSScriptRoot }
 #endregion Handle Working Directory Defaults
 
 # Prepare publish folder
@@ -42,19 +43,15 @@ $text = @()
 $processed = @()
 
 # Gather Stuff to run before
-foreach ($line in (Get-Content "$($PSScriptRoot)\filesBefore.txt" | Where-Object { $_ -notlike "#*" }))
+foreach ($filePath in (& "$($PSScriptRoot)\..\þnameþ\internal\scripts\preimport.ps1"))
 {
-	if ([string]::IsNullOrWhiteSpace($line)) { continue }
+	if ([string]::IsNullOrWhiteSpace($filePath)) { continue }
 
-	$basePath = Join-Path "$($publishDir.FullName)\þnameþ" $line
-	foreach ($entry in (Resolve-PSFPath -Path $basePath))
-	{
-		$item = Get-Item $entry
-		if ($item.PSIsContainer) { continue }
-		if ($item.FullName -in $processed) { continue }
-		$text += [System.IO.File]::ReadAllText($item.FullName)
-		$processed += $item.FullName
-	}
+	$item = Get-Item $filePath
+	if ($item.PSIsContainer) { continue }
+	if ($item.FullName -in $processed) { continue }
+	$text += [System.IO.File]::ReadAllText($item.FullName)
+	$processed += $item.FullName
 }
 
 # Gather commands
@@ -66,19 +63,15 @@ Get-ChildItem -Path "$($publishDir.FullName)\þnameþ\functions\" -Recurse -File
 }
 
 # Gather stuff to run afterwards
-foreach ($line in (Get-Content "$($PSScriptRoot)\filesAfter.txt" | Where-Object { $_ -notlike "#*" }))
+foreach ($filePath in (& "$($PSScriptRoot)\..\þnameþ\internal\scripts\postimport.ps1"))
 {
-	if ([string]::IsNullOrWhiteSpace($line)) { continue }
+	if ([string]::IsNullOrWhiteSpace($filePath)) { continue }
 
-	$basePath = Join-Path "$($publishDir.FullName)\þnameþ" $line
-	foreach ($entry in (Resolve-PSFPath -Path $basePath))
-	{
-		$item = Get-Item $entry
-		if ($item.PSIsContainer) { continue }
-		if ($item.FullName -in $processed) { continue }
-		$text += [System.IO.File]::ReadAllText($item.FullName)
-		$processed += $item.FullName
-	}
+	$item = Get-Item $filePath
+	if ($item.PSIsContainer) { continue }
+	if ($item.FullName -in $processed) { continue }
+	$text += [System.IO.File]::ReadAllText($item.FullName)
+	$processed += $item.FullName
 }
 #endregion Gather text data to compile