Global

Methods

exec()

Execute Bob CLI.
Source:

exec(command:, opts:, cb:)

Execute a single command.
Source:
Parameters:
Name Type Description
command: String the command to execute
opts: Object - cwd: base directory where the commands should be executed from - quiet: don't display command output if quiet - task: Bob task name, used to create output directory - type: Bob task type name, used to create output directory - dir: report directory where process output will be written into a file
cb: function standard cb(err, result) callback

execSeries(commands:, opts:, cb:)

Execute multiple commands in series.
Source:
Parameters:
Name Type Description
commands: Array an array of commands, each command contains: - exec: executable command line, to be executed on shell - meta: command metadata, task and type
opts: Object - cwd: base directory where the commands should be executed from - quiet: don't display command output if quiet
cb: function standard cb(err, result) callback

install(depNames:, optional:, cb:)

Install dependency modules that are not yet installed, and needed for executing the tasks. Global modules (like npm) are assumed to already exist.
Source:
Parameters:
Name Type Description
depNames: Array an array of dependency module names
optional: Object - dir: application directory where node_modules dir is located
cb: function standard cb(err, result) callback

load(taskNames:, dir:, cb:)

Load application config file if exists, otherwise ignore. Config file will be filtered, fields not in taskNames won't be .
Source:
Parameters:
Name Type Description
taskNames: Array an array of task names
dir: String base directory where config file is located
cb: function standard cb(err, result) callback

load(taskNames:, dir:, cb:)

Load Bob task files in parallel. Only task files in specified taskNames will be loaded.
Source:
Parameters:
Name Type Description
taskNames: Array an array of task names
dir: String base directory where task files are located
cb: function standard cb(err, result) callback