Skip to main content

FormatTaskName

This page was generated

Contributions are welcome in Psake-repo.

SYNOPSIS​

This function allows you to change how psake renders the task name during a build.

SYNTAX​

__AllParameterSets​

FormatTaskName [-Format] <Object> [<CommonParameters>]

DESCRIPTION​

This function takes either a string which represents a format string (formats using the -f format operator see "help about_operators") or it can accept a script block that has a single parameter that is the name of the task that will be executed.

EXAMPLES​

EXAMPLE 1​

A sample build script that uses a format string is shown below:

Task default -depends TaskA, TaskB, TaskC

FormatTaskName "-------- {0} --------"

Task TaskA { "TaskA is executing" }

Task TaskB { "TaskB is executing" }

Task TaskC { "TaskC is executing"

The script above produces the following output:

-------- TaskA -------- TaskA is executing -------- TaskB -------- TaskB is executing -------- TaskC -------- TaskC is executing

Build Succeeded!

EXAMPLE 2​

A sample build script that uses a ScriptBlock is shown below:

Task default -depends TaskA, TaskB, TaskC

FormatTaskName { param($taskName) write-host "Executing Task: $taskName" -foregroundcolor blue }

Task TaskA { "TaskA is executing" }

Task TaskB { "TaskB is executing" }

Task TaskC { "TaskC is executing" }

The above example uses the scriptblock parameter to the FormatTaskName function to render each task name in the color blue.

Note: the $taskName parameter is arbitrary, it could be named anything.

PARAMETERS​

-Format​

A format string or a scriptblock to execute

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

VERSION​

This page was generated using comment-based help in Psake 5.0.3.