Add Write-Build alias print, close #240

Author: nightroman

.build.ps1

@@ -58,7 +58,7 @@ task module version, markdown, help, {
 
 	# copy the module folder
 	$dir = "$BuildRoot\z\InvokeBuild"
-	Copy-Item InvokeBuild $dir -Recurse
+	Copy-Item Content $dir -Recurse
 
 	# copy files without Invoke-Build.ps1
 	Copy-Item -Destination $dir $(
@@ -88,6 +88,9 @@ task module version, markdown, help, {
 	Description = 'Build and test automation in PowerShell'
 	PowerShellVersion = '3.0'
 	AliasesToExport = 'Invoke-Build', 'Build-Checkpoint', 'Build-Parallel'
+	VariablesToExport = @()
+	FunctionsToExport = @()
+	CmdletsToExport = @()
 	PrivateData = @{
 		PSData = @{
 			Tags = 'Build', 'Test', 'Automation'

Build-Parallel.ps1

@@ -133,7 +133,7 @@ try {
 			$work = $works[$iWork++]
 			$stage.Add($work)
 
-			Write-Build Cyan "Start $($work.Title)"
+			print Cyan "Start $($work.Title)"
 			$work.Job = $work.PS.BeginInvoke()
 		}
 		if (!$stage) {break}
@@ -169,7 +169,7 @@ try {
 
 	### finish works
 	foreach($work in $works) {
-		Write-Build Cyan "Build $($work.Title):"
+		print Cyan "Build $($work.Title):"
 
 		### get error and dispose
 		$runtime = $false
@@ -223,16 +223,16 @@ try {
 
 		### result
 		if ($_) {
-			Write-Build Cyan "Build $($work.Title) FAILED."
+			print Cyan "Build $($work.Title) FAILED."
 			$_ = if ($_ -is [System.Management.Automation.ErrorRecord] -and $runtime) {*Msg $_ $_} else {"$_"}
-			Write-Build Red "ERROR: $_"
+			print Red "ERROR: $_"
 			$failures += @{
 				File = $work.Title
 				Error = $_
 			}
 		}
 		else {
-			Write-Build Cyan "Build $($work.Title) succeeded."
+			print Cyan "Build $($work.Title) succeeded."
 		}
 	}
 
@@ -263,7 +263,7 @@ finally {
 	elseif ($warnings) {14, 'Builds succeeded with warnings'}
 	else {10, 'Builds succeeded'}
 
-	Write-Build $color @"
+	print $color @"
 Tasks: $($info.Tasks.Count) tasks, $errors errors, $warnings warnings
 $text. $($Build.Count) builds, $($failures.Count) failed $($info.Elapsed)
 "@

InvokeBuild/InvokeBuild.psm1 Content/InvokeBuild.psm1InvokeBuild/InvokeBuild.psm1 renamed to Content/InvokeBuild.psm1

@@ -177,7 +177,7 @@ Set-Alias TaskTearDown Write-TaskTearDown
 function Write-FormatTaskName([string]$format) {
 	$format = $format.Replace("'", "''")
 	'# TODO: Custom task headers, see the repository Tasks/Header for details.'
-	"Set-BuildHeader { param(`$Path) Write-Build Cyan ('$format' -f `$Path) }"
+	"Set-BuildHeader { param(`$Path) print Cyan ('$format' -f `$Path) }"
 }
 
 function Write-Property([scriptblock]$properties) {

InvokeBuild/about_InvokeBuild.help.txt Content/about_InvokeBuild.help.txtInvokeBuild/about_InvokeBuild.help.txt renamed to Content/about_InvokeBuild.help.txt

@@ -35,6 +35,7 @@
 		assert    (Assert-Build)
 		equals    (Assert-BuildEquals)
 		remove    (Remove-BuildItem)
+		print     (Write-Build)
 		property  (Get-BuildProperty)
 		requires  (Test-BuildAsset)
 		use       (Use-BuildAlias)
@@ -48,7 +49,6 @@
 		Set-BuildFooter
 		Set-BuildHeader
 		Use-BuildEnv
-		Write-Build
 		Write-Warning [1]
 
 	[1] Write-Warning is redefined internally in order to count warnings in
@@ -363,6 +363,7 @@
 		@{ text = 'assert    (Assert-Build)' }
 		@{ text = 'equals    (Assert-BuildEquals)' }
 		@{ text = 'remove    (Remove-BuildItem)' }
+		@{ text = 'print     (Write-Build' }
 		@{ text = 'property  (Get-BuildProperty)' }
 		@{ text = 'requires  (Test-BuildAsset)' }
 		@{ text = 'use       (Use-BuildAlias)' }
@@ -373,7 +374,6 @@
 		@{ text = 'Resolve-MSBuild' }
 		@{ text = 'Set-BuildFooter' }
 		@{ text = 'Set-BuildHeader' }
-		@{ text = 'Write-Build' }
 	)
 }
 
@@ -798,7 +798,7 @@
 		# Headers: print task paths as usual and synopses in addition
 		Set-BuildHeader {
 			param($Path)
-			Write-Build Cyan "Task $Path : $(Get-BuildSynopsis $Task)"
+			print Cyan "Task $Path : $(Get-BuildSynopsis $Task)"
 		}
 
 		# Synopsis: This task prints its own synopsis.
@@ -945,7 +945,7 @@
 	description = @'
 	This build block is used in order to change the default task footer format.
 	Use the automatic variable $Task in order to get the current task data.
-	Use Write-Build in order to write with colors.
+	Use Write-Build (print) in order to write with colors.
 '@
 
 	parameters = @{
@@ -963,7 +963,7 @@
 		# Use the usual footer format but change the color
 		Set-BuildFooter {
 			param($Path)
-			Write-Build DarkGray "Done $Path $($Task.Elapsed)"
+			print DarkGray "Done $Path $($Task.Elapsed)"
 		}
 
 		# Synopsis: Data for footers in addition to $Path and $Task.Elapsed
@@ -978,7 +978,7 @@
 	links = @(
 		@{ text = 'Get-BuildSynopsis' }
 		@{ text = 'Set-BuildHeader' }
-		@{ text = 'Write-Build' }
+		@{ text = 'Write-Build (print)' }
 	)
 }
 
@@ -990,7 +990,7 @@
 	description = @'
 	This build block is used in order to change the default task header format.
 	Use the automatic variable $Task in order to get the current task data.
-	Use Write-Build in order to write with colors.
+	Use Write-Build (print) in order to write with colors.
 '@
 
 	parameters = @{
@@ -1004,7 +1004,7 @@
 		# Headers: write task paths as usual and synopses in addition
 		Set-BuildHeader {
 			param($Path)
-			Write-Build Cyan "Task $Path --- $(Get-BuildSynopsis $Task)"
+			print Cyan "Task $Path --- $(Get-BuildSynopsis $Task)"
 		}
 
 		# Synopsis: Data for headers in addition to $Path and Get-BuildSynopsis
@@ -1019,7 +1019,7 @@
 	links = @(
 		@{ text = 'Get-BuildSynopsis' }
 		@{ text = 'Set-BuildFooter' }
-		@{ text = 'Write-Build' }
+		@{ text = 'Write-Build (print)' }
 	)
 }
 
@@ -1158,7 +1158,7 @@ If it is omitted, the current task or script name is used.
 ### Write-Build
 @{
 	command = 'Write-Build'
-	synopsis = 'Writes text using colors if they are supported.'
+	synopsis = '(print) Writes text using colors if they are supported.'
 
 	description = @'
 	This function is used in order to output colored text in a console or other

Convert-psake.ps1

@@ -28,6 +28,7 @@ function *Die($M, $C=0) {$PSCmdlet.ThrowTerminatingError((New-Object System.Mana
 Set-Alias assert Assert-Build
 Set-Alias equals Assert-BuildEquals
 Set-Alias exec Invoke-BuildExec
+Set-Alias print Write-Build
 Set-Alias property Get-BuildProperty
 Set-Alias remove Remove-BuildItem
 Set-Alias requires Test-BuildAsset
@@ -373,8 +374,8 @@ New-Variable * -Description IB ([PSCustomObject]@{
 	B = 0
 	Q = 0
 	H = @{}
-	Header = if (${*p}) {${*p}.Header} else {{Write-Build 11 "Task $($args[0])"}}
-	Footer = if (${*p}) {${*p}.Footer} else {{Write-Build 11 "Done $($args[0]) $($Task.Elapsed)"}}
+	Header = if (${*p}) {${*p}.Header} else {{print 11 "Task $($args[0])"}}
+	Footer = if (${*p}) {${*p}.Footer} else {{print 11 "Done $($args[0]) $($Task.Elapsed)"}}
 	Data = @{}
 	XBuild = $null
 	XCheck = $null
@@ -515,8 +516,8 @@ function *Check($J, $T, $P=@()) {
 function *Echo {
 	${*c} = $args[0]
 	${*t} = "${*c}".Replace("`t", '    ')
-	Write-Build 3 "exec {$(if (${*t} -match '((?:\r\n|[\r\n]) *)\S') {"$(${*t}.TrimEnd().Replace($matches[1], "`n    "))`n"} else {${*t}})}"
-	Write-Build 8 "cd $global:pwd"
+	print 3 "exec {$(if (${*t} -match '((?:\r\n|[\r\n]) *)\S') {"$(${*t}.TrimEnd().Replace($matches[1], "`n    "))`n"} else {${*t}})}"
+	print 8 "cd $global:pwd"
 	foreach(${*v} in ${*c}.Ast.FindAll({$args[0] -is [System.Management.Automation.Language.VariableExpressionAst]}, $true)) {
 		${*p} = ${*v}.Parent
 		if (${*p} -is [System.Management.Automation.Language.MemberExpressionAst]) {
@@ -525,14 +526,14 @@ function *Echo {
 		}
 		if (${*v}.Parent -isnot [System.Management.Automation.Language.AssignmentStatementAst]) {
 			${*t} = "${*v}" -replace '^@', '$'
-			Write-Build 8 "${*t}: $(& ([scriptblock]::Create(${*t})))"
+			print 8 "${*t}: $(& ([scriptblock]::Create(${*t})))"
 		}
 	}
 }
 
 function *Err($T) {
 	${*}.Errors.Add([PSCustomObject]@{Error = $_; File = $BuildFile; Task = $T})
-	Write-Build 12 "ERROR: $(if (*My) {$_} else {*Msg $_ $_})"
+	print 12 "ERROR: $(if (*My) {$_} else {*Msg $_ $_})"
 	if ($T) {$T.Error = $_}
 }
 
@@ -639,7 +640,7 @@ function *Task {
 	New-Variable Task (${*}.Task = ${*}.All[${*n}]) -Option Constant
 
 	if ($Task.Elapsed) {
-		Write-Build 8 "Done ${*p}"
+		print 8 "Done ${*p}"
 		return
 	}
 
@@ -652,14 +653,14 @@ function *Task {
 		}
 		catch {
 			*Err $Task
-			Write-Build 8 (*At $Task)
+			print 8 (*At $Task)
 			${*}.Tasks.Add($Task)
 			$Task.Elapsed = [TimeSpan]::Zero
 			throw
 		}
 	}
 	if (!${*x}) {
-		Write-Build 8 "Task ${*p} skipped."
+		print 8 "Task ${*p} skipped."
 		return
 	}
 
@@ -687,7 +688,7 @@ function *Task {
 					*Err $Task
 					throw
 				}
-				Write-Build 8 ${*i}[1]
+				print 8 ${*i}[1]
 			}
 			if (${*i}[0]) {
 				continue
@@ -716,7 +717,7 @@ function *Task {
 			}
 			catch {
 				*Err $Task
-				Write-Build 8 (*At $Task)
+				print 8 (*At $Task)
 				throw
 			}
 			finally {
@@ -828,9 +829,9 @@ try {
 		exit
 	}
 
-	Write-Build 11 "Build $($BuildTask -join ', ') $BuildFile"
+	print 11 "Build $($BuildTask -join ', ') $BuildFile"
 	foreach($_ in ${*}.Redefined) {
-		if (($_ = $_.Name) -ne '.') {Write-Build 8 "Redefined task '$_'."}
+		if (($_ = $_.Name) -ne '.') {print 8 "Redefined task '$_'."}
 	}
 	foreach($_ in ${*}.Doubles) {
 		if (${*}.All[$_[1]].If -isnot [scriptblock]) {
@@ -882,18 +883,18 @@ finally {
 		$t = ${*}.Tasks
 		$e = ${*}.Errors
 		if (${*}.Summary) {
-			Write-Build 11 'Build summary:'
+			print 11 'Build summary:'
 			foreach($_ in $t) {
 				'{0,-16} {1} - {2}:{3}' -f $_.Elapsed, $_.Name, $_.InvocationInfo.ScriptName, $_.InvocationInfo.ScriptLineNumber
 				if ($_ = $_.Error) {
-					Write-Build 12 "ERROR: $(if (*My) {$_} else {*Msg $_ $_})"
+					print 12 "ERROR: $(if (*My) {$_} else {*Msg $_ $_})"
 				}
 			}
 		}
 		if ($w = ${*}.Warnings) {
 			foreach($_ in $w) {
 				"WARNING: $(if ($_.Task) {"/$($_.Task.Name) "})$($_.InvocationInfo.ScriptName):$($_.InvocationInfo.ScriptLineNumber)"
-				Write-Build 14 $_.Message
+				print 14 $_.Message
 			}
 		}
 		if ($_ = ${*}.P) {
@@ -906,7 +907,7 @@ finally {
 		elseif ($e) {14, 'Build completed with errors'}
 		elseif ($w) {14, 'Build succeeded with warnings'}
 		else {10, 'Build succeeded'}
-		Write-Build $c "$m. $($t.Count) tasks, $($e.Count) errors, $($w.Count) warnings $((${*}.Elapsed = [DateTime]::Now - ${*}.Started))"
+		print $c "$m. $($t.Count) tasks, $($e.Count) errors, $($w.Count) warnings $((${*}.Elapsed = [DateTime]::Now - ${*}.Started))"
 	}
 }
 }

Help.ps1

@@ -2,6 +2,10 @@
 
 [Issues](https://github.com/nightroman/Invoke-Build/issues) [Releases](https://github.com/nightroman/Invoke-Build/releases) [Discussions](https://github.com/nightroman/Invoke-Build/discussions)
 
+## v5.14.18
+
+Add `Write-Build` alias `print`, #240
+
 ## v5.14.17
 
 Apply `Extends` prefixes to `After` and `Before` references, #239

Invoke-Build.ps1

@@ -191,39 +191,39 @@ function Add-TaskVariable($Jobs) {
 }
 
 function Format-TaskHelp($TaskHelp) {
-	Write-Build White Task:
+	print White Task:
 	foreach($r in $TaskHelp.Task) {
 		if ($synopsis = $r.Synopsis) {
-			Write-Build Gray ('    {0} - {1}' -f $r.Name, $synopsis)
+			print Gray ('    {0} - {1}' -f $r.Name, $synopsis)
 		}
 		else {
-			Write-Build Gray ('    {0}' -f $r.Name)
+			print Gray ('    {0}' -f $r.Name)
 		}
 	}
 
-	Write-Build White Jobs:
+	print White Jobs:
 	foreach($r in $TaskHelp.Jobs) {
 		if ($synopsis = Get-BuildSynopsis ($All[$r.Name]) $Hash) {
-			Write-Build Gray ('    {0} - {1} At {2}' -f $r.Name, $synopsis, $r.Location)
+			print Gray ('    {0} - {1} At {2}' -f $r.Name, $synopsis, $r.Location)
 		}
 		else {
-			Write-Build Gray ('    {0} - At {1}' -f $r.Name, $r.Location)
+			print Gray ('    {0} - At {1}' -f $r.Name, $r.Location)
 		}
 	}
 
 	if ($TaskHelp.Parameters) {
-		Write-Build White Parameters:
+		print White Parameters:
 		foreach($p in $TaskHelp.Parameters) {
-			Write-Build Gray ('    [{0}] {1}' -f $p.Type, $p.Name)
+			print Gray ('    [{0}] {1}' -f $p.Type, $p.Name)
 			if ($p.Description) {
-				Write-Build Gray ('        {0}' -f $p.Description)
+				print Gray ('        {0}' -f $p.Description)
 			}
 		}
 	}
 
 	if ($TaskHelp.Environment) {
-		Write-Build White Environment:
-		Write-Build Gray ('    {0}' -f ($TaskHelp.Environment -join ', '))
+		print White Environment:
+		print Gray ('    {0}' -f ($TaskHelp.Environment -join ', '))
 	}
 }
 

Release-Notes.md

@@ -4,17 +4,17 @@
 Set-BuildHeader {
 	param($Path)
 	# separator line
-	Write-Build Green ('=' * 79)
+	print Green ('=' * 79)
 	# default header + synopsis
-	Write-Build Green "Task $Path : $(Get-BuildSynopsis $Task)"
+	print Green "Task $Path : $(Get-BuildSynopsis $Task)"
 	# task location in a script
-	Write-Build Green "At $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)"
+	print Green "At $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)"
 }
 
 # Define footers similar to default but change the color to DarkGray.
 Set-BuildFooter {
 	param($Path)
-	Write-Build DarkGray "Done $Path, $($Task.Elapsed)"
+	print DarkGray "Done $Path, $($Task.Elapsed)"
 }
 
 # Synopsis: Some task description 1.