5.4.0
ForgeBox Enterprise
Task Output
Tasks aren't required to output anything, but if you do, use the handy
print helper that lives in the variables scope. You can output ANSI-formatted text this way. All the text you output will be stored in a "buffer" and at the end of the task it will be output to the console, or piped into the next command if necessary;Print Helper
The print object has an unlimited number of methods you can call on it since it uses onMissingMethod. Here are the rules.
Line Break
If the method has the word "line" in it, a new line will be added to the end of the string. If the string is empty or not provided, you'll just output a blank line.
1
print.line( 'I like Spam.' );
2
print.line();
Copied!
Text Color
CommandBox supports 256 colors, but some terminals only support 16 or even 8. If you use a color that the terminal doesn't support, it will be adjusted to the next closest color. If the method has one of the names of a supported color in it, the text will be colored. Here are the basic 16 color names:
- Black
- Maroon
- Green
- Olive
- Navy
- Magenta
- Cyan
- Silver
- Grey
- Red
- Lime
- Yellow
- Blue
- Fuchsia
- Aqua
- White
1
print.magenta( 'I sound like a toner cartridge' );
2
print.greenText( "You wouldn't like me when I'm angry" );
3
print.somethingBlue( 'UHF ' );
Copied!
To view all the color names run the
system-colors command.1
print.MistyRose3( 'Fancy colors' );
Copied!
Background Color
If the method has a valid color name preceded by the word "on", the background of the text will be that color.
- onBlack
- onRed
- onGreen
- onYellow
- onBlue
- onMagenta
- onCyan
- onWhite
- etc...
1
print.blackOnWhiteText( 'Inverse!' );
2
print.greenOnRedLine( "Christmas?" );
Copied!
Color by Numbers
When you run the system-colors command, you'll see that each of the 256 colors have a number. You can reference a color like so:
1
print.color221( 'I will print PaleVioletRed1' );
Copied!
Text Decoration
If any of the following words appear in the method, their decoration will be added. Note, not all of these work on all ANSI consoles. Blink, for instance, doesn't seem to work in Windows.
- bold
- underscored
- blinking
- reversed - Inverse of the default terminal colors
- concealed
- indented
1
print.boldText( "Don't make me turn this car around!" );
2
print.underscoredLine( "Have I made my point?" );
Copied!
indented isn't part of the ANSI standard but rather a nice way to indent each line of output with two spaces to help clean up nested lines of output. If the string being passed in has carriage returns, each of them will be preceded by two spaces.1
print.boldText( "Header" )
2
.indentedLine( "Detail 1" )
3
.indentedLine( "Detail 2" )
4
.indentedLine( "Detail 3" );
Copied!
Mix It Up
Any combination of the above is possible. Filler words like "text" will simply be ignored so you can make your method nice and readable. Get creative, but just don't overdo it. No one wants their console to look like a rainbow puked on it.
1
print.redOnWhiteLine( 'Ready the cannons!' );
2
print.boldRedOnBlueText( "Test dirt, don't wash." );
3
print.boldBlinkingUnderscoredBlueTextOnRedBackground( "That's just cruel" );
Copied!
Dynamic Formatting
Some times you want to apply formatting at run time. For instance, show a status green if it's good and red if it's bad. You can pass a second string to the print helper with additional formatting that will be appended to the method name.
1
print.text( status, ( status == 'running' ? 'green' : 'red' ) );
Copied!
Depending on the value of the
status variable, that line would be the same as one of the following two lines:1
print.greenText( status );
2
print.redText( status );
Copied!
Flush
If you have a task that takes a while to complete and you want to update the user right away, you can flush out everything in the buffer to the console with the .toConsole() method. Note, any text flushed to the console cannot be piped to another command.
1
print.Line( 'Step 1 complete' ).toConsole();
2
print.Line( 'Step 2 complete' ).toConsole();
3
print.Line( 'Step 3 complete' ).toConsole();
Copied!
Chaining
All the methods in the
print object can be chained together to clean up your code.1
print.whiteOnRedLine( 'ERROR' )
2
.line()
3
.redLine( message )
4
.line();
Copied!
Strip ANSI Formatting
If you have a string that contains ANSI formatting and you want to strip it out to just plain text, there is a function on the print helper to do this for you.
1
var strippedOutput = print.unANSI( formattedOutput );
Copied!
Last modified 8mo ago