logo

abstract class

build::BuildScript

sys::Obj
  build::BuildScript

BuildScript is the base class for build scripts - it manages the command line interface, argument parsing, environment, and target execution.

See docTools::Build for details.

Slots

binDir

File binDir

{devHomeDir}/bin/{os}/

defaultTarget

abstract Target defaultTarget()

Return the default target to execute when this script is run.

devHomeDir

File devHomeDir

Home directory of development installation. By default this value is initialized by Sys.env["fan.build.devHome"], otherwise Sys.homeDir is used.

fatal

FatalBuildErr fatal(Str msg, Err err := def)

Log an error and return a FatalBuildErr instance

globalVersion

Version globalVersion

This is the global default version to use when building pods. It is initialized by Sys.env["fan.build.globalVersion"], otherwise "0.0.0" is used as a default.

libDir

File libDir

{devHomeDir}/lib/

libFanDir

File libFanDir

{devHomeDir}/lib/fan

libJavaDir

File libJavaDir

{devHomeDir}/lib/java

libNetDir

File libNetDir

{devHomeDir}/lib/net

log

BuildLog log

Log used for error reporting and tracing

main

Int main(Str[] args := def)

Run the script with the specified arguments. Return 0 on success or -1 on failure.

make

new make()

Construct a new build script.

makeTargets

virtual Target[] makeTargets()

This callback is invoked by the BuildScript constructor after the call to setup to initialize the list of the targets this script publishes. The list of targets is built from all the methods annotated with the "target" facet. The "target" facet should have a string value with a description of what the target does.

scriptDir

File scriptDir

The directory containing the this script

scriptFile

File scriptFile

The source file of this script

setup

virtual Void setup()

The setup callback is invoked before creating or processing of any targets to ensure that the BuildScript is correctly initialized. If the script cannot be setup then report errors via the log and throw FatalBuildErr to terminate the script.

target

Target target(Str name, Bool checked := def)

Lookup a target by name. If not found and checked is false return null, otherwise throw an exception. This method cannot be called until after the script has completed its constructor.

targets

readonly Target[] targets

Targets available on this script (see makeTargets)

toRun

Target[] toRun

Targets specified to run by command line

toStr

override Str toStr()

Return this script's source file path.