adding build system

Author: FriedrichWeinmann

PSModuleDevelopment/PSModuleDevelopment.psd1

@@ -27,7 +27,7 @@
 	# Modules that must be imported into the global environment prior to importing
 	# this module
 	RequiredModules	       = @(
-		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.4.149' }
+		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.6.198' }
 		@{ ModuleName = 'string'; ModuleVersion = '0.6.1' }
 	)
 
@@ -50,45 +50,57 @@
 
 	# Functions to export from this module
 	FunctionsToExport  = @(
-		'Convert-PSMDMessage',
-		'Expand-PSMDTypeName',
-		'Export-PSMDString',
-		'Find-PSMDFileContent',
-		'Find-PSMDType',
-		'Format-PSMDParameter',
-		'Get-PSMDArgumentCompleter',
-		'Get-PSMDAssembly',
-		'Get-PSMDConstructor',
-		'Get-PSMDFileCommand',
-		'Get-PSMDHelp',
-		'Get-PSMDMember',
-		'Get-PSMDModuleDebug',
-		'Get-PSMDTemplate',
-		'Import-PSMDModuleDebug',
-		'Invoke-PSMDTemplate',
-		'Measure-PSMDCommand',
-		'Measure-PSMDLinesOfCode',
-		'New-PSMDDotNetProject',
-		'New-PSMDHeader',
-		'New-PSMDFormatTableDefinition',
-		'New-PSMDModuleNugetPackage',
-		'New-PSMDTemplate',
-		'New-PssModuleProject',
-		'Publish-PSMDScriptFile',
-		'Publish-PSMDStagedModule',
-		'Read-PSMDScript',
-		'Remove-PSMDModuleDebug',
-		'Remove-PSMDTemplate',
-		'Rename-PSMDParameter',
-		'Restart-PSMDShell',
-		'Search-PSMDPropertyValue',
-		'Set-PSMDEncoding',
-		'Set-PSMDModuleDebug',
-		'Set-PSMDCmdletBinding',
-		'Set-PSMDModulePath',
-		'Set-PSMDParameterHelp',
-		'Set-PSMDStagingRepository',
-		'Show-PSMDSyntax',
+		'Convert-PSMDMessage'
+		'Expand-PSMDTypeName'
+		'Export-PSMDString'
+		'Find-PSMDFileContent'
+		'Find-PSMDType'
+		'Format-PSMDParameter'
+		'Get-PSMDArgumentCompleter'
+		'Get-PSMDAssembly'
+		'Get-PSMDBuildAction'
+		'Get-PSMDBuildArtifact'
+		'Get-PSMDBuildProject'
+		'Get-PSMDBuildStep'
+		'Get-PSMDConstructor'
+		'Get-PSMDFileCommand'
+		'Get-PSMDHelp'
+		'Get-PSMDMember'
+		'Get-PSMDModuleDebug'
+		'Get-PSMDTemplate'
+		'Import-PSMDModuleDebug'
+		'Invoke-PSMDBuildProject'
+		'Invoke-PSMDTemplate'
+		'Measure-PSMDCommand'
+		'Measure-PSMDLinesOfCode'
+		'New-PSMDBuildProject'
+		'New-PSMDDotNetProject'
+		'New-PSMDFormatTableDefinition'
+		'New-PSMDHeader'
+		'New-PSMDModuleNugetPackage'
+		'New-PSMDTemplate'
+		'New-PssModuleProject'
+		'Publish-PSMDBuildArtifact'
+		'Publish-PSMDScriptFile'
+		'Publish-PSMDStagedModule'
+		'Read-PSMDScript'
+		'Register-PSMDBuildAction'
+		'Remove-PSMDBuildArtifact'
+		'Remove-PSMDBuildProject'
+		'Remove-PSMDModuleDebug'
+		'Remove-PSMDTemplate'
+		'Rename-PSMDParameter'
+		'Restart-PSMDShell'
+		'Search-PSMDPropertyValue'
+		'Select-PSMDBuildProject'
+		'Set-PSMDBuildStep'
+		'Set-PSMDCmdletBinding'
+		'Set-PSMDEncoding'
+		'Set-PSMDModuleDebug'
+		'Set-PSMDModulePath'
+		'Set-PSMDParameterHelp'
+		'Set-PSMDStagingRepository'
+		'Show-PSMDSyntax'
 		'Split-PSMDScriptFile'
     )
 
@@ -99,15 +111,16 @@
 	# VariablesToExport = ''
 
 	# Aliases to export from this module
-    AliasesToExport = @(
-		'dotnetnew',
-		'find',
-		'hex',
-		'imt',
-		'ipmod',
-		'parse',
-		'Restart-Shell',
-        'rss',
+	AliasesToExport    = @(
+		'build'
+		'dotnetnew'
+		'find'
+		'hex'
+		'imt'
+		'ipmod'
+		'parse'
+		'Restart-Shell'
+        'rss'
         'smd'
     )
 

PSModuleDevelopment/en-us/strings.psd1

@@ -4,6 +4,8 @@
 
 	'Get-PSMDFileCommand.SyntaxError'				   = 'Syntax error in file: {0}' # $pathItem
 
+	'Invoke-PSMDBuildProject.Step.Executing' = '[{0}] Executing step {1} ({2})' # $count, $step.Name, $step.Action
+	
 	'Invoke-PSMDTemplate.Template.NotFound'		       = 'Unable to find template data for "{0}"' # $TemplateName
 	'Invoke-PSMDTemplate.Invoking'					   = 'Creating file/project from template {0}' # $item
 

PSModuleDevelopment/functions/build/Get-PSMDBuildAction.ps1

@@ -0,0 +1,12 @@
+function Get-PSMDBuildAction {
+	[CmdletBinding()]
+	param (
+		[PsfArgumentCompleter('PSModuleDevelopment.Build.Action')]
+		[string]
+		$Name = '*'
+	)
+	
+	process {
+		$script:buildActions.Values | Where-Object Name -Like $Name
+	}
+}

PSModuleDevelopment/functions/build/Get-PSMDBuildArtifact.ps1

@@ -0,0 +1,20 @@
+function Get-PSMDBuildArtifact {
+	[CmdletBinding()]
+	param (
+		[string]
+		$Name = '*',
+		
+		[string[]]
+		$Tag
+	)
+	
+	process {
+		$script:buildArtifacts.Values | Where-Object Name -Like $Name | Where-Object {
+			if (-not $Tag) { return $true }
+			foreach ($tagName in $Tag) {
+				if ($_.Tags -contains $Tag) { return $true }
+			}
+			return $false
+		}
+	}
+}

PSModuleDevelopment/functions/build/Get-PSMDBuildProject.ps1

@@ -0,0 +1,33 @@
+function Get-PSMDBuildProject {
+	[CmdletBinding(DefaultParameterSetName = 'Path')]
+	param (
+		[Parameter(Mandatory = $true, ParameterSetName = 'Path')]
+		[string]
+		$Path,
+		
+		[Parameter(ParameterSetName = 'Path')]
+		[string]
+		$Name,
+		
+		[Parameter(Mandatory = $true, ParameterSetName = 'Selected')]
+		[switch]
+		$Selected
+	)
+	
+	process {
+		#region By Path
+		if ($Path) {
+			$importPath = $Path
+			if ($Name) { $importPath = Join-Path -Path $Path -ChildPath "$Name.build.json" }
+			
+			Get-Content -Path $importPath -Encoding UTF8 | ConvertFrom-Json
+		}
+		#endregion By Path
+		
+		#region Selected
+		else {
+			Get-Content -Path (Get-PSFConfigValue -FullName 'PSModuleDevelopment.Build.Project.Selected') -Encoding UTF8 | ConvertFrom-Json
+		}
+		#endregion Selected
+	}
+}

PSModuleDevelopment/functions/build/Get-PSMDBuildStep.ps1

@@ -0,0 +1,23 @@
+function Get-PSMDBuildStep {
+	[CmdletBinding()]
+	param (
+		[string]
+		$Name = '*',
+		
+		[string]
+		$BuildProject
+	)
+	
+	begin {
+		$projectPath = $BuildProject
+		if (-not $projectPath) { $projectPath = Get-PSFConfigValue -FullName 'PSModuleDevelopment.Build.Project.Selected' }
+		if (-not $projectPath) { throw "No Project path specified and none selected!" }
+		if (-not (Test-Path -Path $projectPath)) {
+			throw "Project file not found: $projectPath"
+		}
+	}
+	process {
+		$projectObject = Get-PSMDBuildProject -Path $projectPath
+		$projectObject.Steps | Where-Object Name -Like $Name
+	}
+}

PSModuleDevelopment/functions/build/Invoke-PSMDBuildProject.ps1

@@ -0,0 +1,132 @@
+function Invoke-PSMDBuildProject {
+	[Alias('build')]
+	[CmdletBinding()]
+	param (
+		[string]
+		$Path,
+		
+		[switch]
+		$RetainArtifacts
+	)
+	
+	begin {
+		$script:buildArtifacts = @{ }
+		$buildStatus = @{ }
+		
+		$projectPath = $Path
+		if (-not $projectPath) { $projectPath = Get-PSFConfigValue -FullName 'PSModuleDevelopment.Build.Project.Selected' }
+		if (-not $projectPath) { throw "No Project path specified and none selected!" }
+		if (-not (Test-Path -Path $projectPath)) {
+			throw "Project file not found: $projectPath"
+		}
+		
+		function Write-StepResult {
+			[CmdletBinding()]
+			param (
+				[int]
+				$Count,
+				
+				[ValidateSet('Success', 'Failed', 'ConditionNotMet', 'DependencyNotMet', 'BadAction')]
+				[string]
+				$Status,
+				
+				$StepObject,
+				
+				$Data,
+				
+				[hashtable]
+				$BuildStatus,
+				
+				[string]
+				$ContinueLabel
+			)
+			
+			$BuildStatus[$StepObject.Name] = $Status -eq 'Success'
+			
+			$paramWritePSFMessage = @{
+				Level	     = 'Warning'
+				String	     = "Invoke-PSMDBuildProject.Step.$Status"
+			}
+			
+			switch ($Status) {
+				Failed { Write-PSFMessage @paramWritePSFMessage -StringValues $StepObject.Name, $StepObject.Action -ErrorRecord $Data }
+				ConditionNotMet { Write-PSFMessage @paramWritePSFMessage -StringValues $StepObject.Name, $StepObject.Action, $StepObject.Condition }
+				DependencyNotMet { Write-PSFMessage @paramWritePSFMessage -StringValues $StepObject.Name, $StepObject.Action, $Data }
+				BadAction { Write-PSFMessage @paramWritePSFMessage -StringValues $StepObject.Name, $StepObject.Action }	
+			}
+			
+			[PSCustomObject]@{
+				PSTypeName = 'PSModuleDevelopment.Build.StepResult'
+				Count	   = $Count
+				Action	   = $StepObject.Action
+				Status	   = $Status
+				Step	   = $StepObject.Name
+				Data	   = $Data
+			}
+			
+			if ($ContinueLabel) {
+				continue $ContinueLabel
+			}
+		}
+	}
+	process {
+		$projectObject = Get-PSMDBuildProject -Path $projectPath
+		$steps = $projectObject.Steps | Sort-Object Weight
+		
+		$count = 0
+		$stepResults = :main foreach ($step in $steps) {
+			$count++
+			$resultDef = @{
+				Count = $count
+				StepObject = $step
+				BuildStatus = $buildStatus
+			}
+			
+			Write-PSFMessage -Level Host -String 'Invoke-PSMDBuildProject.Step.Executing' -StringValues $count, $step.Name, $step.Action
+			
+			#region Validation
+			$actionObject = $script:buildActions[$step.Action]
+			if (-not $actionObject) {
+				Write-StepResult @resultDef -Status BadAction -ContinueLabel main
+			}
+			
+			foreach ($dependency in $step.Dependency) {
+				if (-not $buildStatus[$dependency]) {
+					Write-StepResult @resultDef -Status DependencyNotMet -Data $dependency -ContinueLabel main
+				}
+			}
+			
+			if ($step.Condition -and $step.ConditionSet) {
+				$cModule, $cSetName = $step.ConditionSet -split " ", 2
+				$conditionSet = Get-PSFFilterConditionSet -Module $cModule -Name $cSetName
+				if (-not $conditionSet) {
+					Write-StepResult @resultDef -Status ConditionNotMet -ContinueLabel main
+				}
+				
+				$filter = New-PSFFilter -Expression $step.Condition -ConditionSet $conditionSet
+				if (-not $filter.Evaluate()) {
+					Write-StepResult @resultDef -Status ConditionNotMet -ContinueLabel main
+				}
+			}
+			#endregion Validation
+			
+			#region Execution
+			$parameters = @{
+				RootPath = Split-Path -Path $projectPath
+				Parameters = $step.Parameters
+			}
+			try { $null = & $actionObject.Action $parameters }
+			catch {
+				Write-StepResult @resultDef -Status Failed -Data $_ -ContinueLabel main
+			}
+			Write-StepResult @resultDef -Status Success
+			#endregion Execution
+		}
+		$stepResults
+	}
+	end {
+		if (-not $RetainArtifacts) {
+			$script:buildArtifacts = @{ }
+		}
+	}
+}