https://www.ortussolutions.com/blog/the-12-tips-of-commandbox-christmas-2017-day-1-task-runners
It’s that time of year again. Trees are lit, presents are being wrapped, and relatives are coming to visit. That’s right, it’s time again for the 12 days of (CommandBox) Christmas-- 2017 edition! We’ll publish one invaluable hint from today until Christmas right here on the Ortus blog. Consider it our early Christmas gift to you.
Stay on task
Right, so let’s get going. Today’s tip are about CommandBox task runners. These are now the easiest and most robust way to do CLI scripting in CFML. What’s that you say-- you thought CFML was only for web pages?? Not so! With the advent of CommandBox, CFML is now capable of being run from the command line anywhere, without even needing a server to be installed!
Those crusty batch files? That shell script that takes a PhD to understand? Those… shudder… Node scripts! All of those are candidates for you to write in CFML. Face it, you’re faster and more familiar with doing things in CFML and you already have all the tools like database access, file manipulations, and familiar data structures. Rewrite your cron jobs, spruce up your Ant builds, and automate your lazy coworkers with the power of CFML!
What is a Task Runner?
Don’t worry one bit. Firstly, task runners are fully documented right here:
https://ortus.gitbooks.io/commandbox-documentation/content/task-runners.html
Secondly tasks are very very simple. In fact, we’ll create one right now. All you need is:
- A CFC file called “task.cfc”
- A method in the CFC called run()
- Just put the code you want to run inside the method!
Here’s a super simple task runner that works.
component {
function run() {
print.greenLine( 'This is my first task!' );
}
}
And now let’s run it. You don’t need any servers running. Just CD into the same folder as the task.cfc and run this:
> task run
This is my first task!
What else can I do?
A lot. In fact, you can do anything that’s possible in CFML. Your tasks run on the Lucee engine that powers your CommandBox CLI so keep in mind that you can even take advantage of some Lucee features like optional semicolons in script and Lucee-specific functions. Let’s take a look at some quick and easy things to add to your task.
Pass parameters
Consider this simple task;
component{
function run( string name ){
print.line( 'Well, hello there #name#!' );
}
}
Pass in named parameters with a dolon before the parameter name that you want to pass through to the task.
task run :name=Brad
Console output
Tasks don’t return HTML. Instead, they can print colored text to the console with a handy print helper.
print.line( 'I like Spam.' );
print.somethingBlue( 'UHF ' );
print.blackOnWhiteText( 'Inverse!' );
print.boldRedOnBlueText( "Test dirt, don't wash." );
print.boldBlinkingUnderscoredBlueTextOnRedBackground( "That's just cruel" );
Interact with users
Just because this is the CLI doesn’t mean you can’t interact with the user!