Skip to main content

Formatting Task Name

Use the psake FormatTaskName function. 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.

String Format​

Here is an example using the format string parameter of the FormatTaskName parameter:

Task default -depends TaskA, TaskB, TaskC

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

Task TaskA {
  "TaskA is executing"
}

Task TaskB {
  "TaskB is executing"
}

Task TaskC {
  "TaskC is executing"
}

The output looks like the following:

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

Build Succeeded!

----------------------------------------------------------------------
Build Time Report
----------------------------------------------------------------------
Name   Duration
----   --------
TaskA  00:00:00.0058887
TaskB  00:00:00.0057582
TaskC  00:00:00.0043072
Total: 00:00:00.1919297

Format with Function​

The following example uses the scriptblock parameter of the FormatTaskName function:

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 preceding 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