src @Target { help=... }
virtual Void clean()

Delete all intermediate and target files

src @Target { help=... }
virtual Void compile()

Compile the source into a pod file and all associated natives. See compileFan, compileJava, and compileDotnet.

src virtual Void compileDotnet()

Compile native .NET assembly dotnetDirs configured

src virtual Void compileFan()

Compile Fan code into pod file

src virtual Void compileJava()

Compile Java class files if javaDirs is configured

src virtual Void compileJni()

Compile JNI bindings if jniDirs configured.

src virtual Void compileNodeJs()

Compile to javascript node module

src Str[] depends := Str[,]

List of dependencies for pod formatted as Depend. Strings are automatically run through BuildScript.applyMacros.

src Uri? dependsDir := null

The directory to look in for the dependency pod file (and potentially their recursive dependencies). If null then we use the compiler's own pod definitions via reflection (which is more efficient). As a general rule you shouldn't mess with this field - it is used by the build and compiler build scripts for bootstrap build.

src Bool docApi := true

Indicates if if fandoc API should be included in the documentation. By default API is included.

src Bool docSrc := false

Indicates if if source code should be included in the pod/documentation. By default source code it not included.

src Uri[]? dotnetDirs

List of Uris relative to build script of directories containing the C# source files to compile for .NET native methods.

src @Target { help="Run clean, compile, and test" }
virtual Void full()

Run clean, compile, and test

src Str:Obj index := [Str:Obj][:]

Pod index name/value pairs to compile into pod. See Env.index. The index values can be a single Str or a Str[] if there are multiple values mapped to one key.

src Uri[]? javaDirs

List of Uris relative to build script of directories containing the Java source files to compile for Java native methods.

src Uri[]? jniDirs

List of Uris relative to build script of directories containing the JNI C source files to compile.

src Str[]? jniPlatforms

If non-null, whitelist of platforms JNI should be enabled for. Platform string may be full platform name ("macosx-x86_64") or OS only ("macosx").

src Uri[]? jsDirs

List of Uris relative to build script of directories containing the JavaScript source files to compile for JavaScript native methods.

src Uri[]? jsProps

List of Uris relative to build script that should be searched for .props files to compile to JavaScript. You may also give relative paths to files with a .props ext. If this field is null, it defaults to resDirs.

src Str:Str meta := ...

Pod meta-data name/value pairs to compile into pod. See Pod.meta.

src @Target { help="Compile all types to run in Node.js" }
virtual Void nodeJs()

Compile to all classes to run in Node.js

src virtual Void onCompileFan(CompilerInput ci)

Callback to tune the Fantom compiler input

src Uri outDocDir := Env.cur().workDir().plus(`doc/`).uri

Directory to output documentation (docs always get placed in sub-directory named by pod). By default it goes into "{Env.cur.workDir}/doc/"

src Uri outPodDir := Env.cur().workDir().plus(`lib/fan/`).uri

Directory to output pod file. By default it goes into "{Env.cur.workDir}/lib/fan/"

src Str? podName := null

Required name of the pod.

src Uri[]? resDirs

List of optional Uris relative to build script of directories of resources files to package into pod zip file. If a file has a "jar" extension then its contents are unzipped into the target pod.

src Uri[]? srcDirs

List of Uris relative to build script of directories containing the Fan source files to compile.

src Str? summary := null

Required summary description of pod.

src @Target { help="Run the pod unit tests via fant" }
virtual Void test()

Run the unit tests using fant for this pod

src Version version := ...

Version of the pod - default is set to BuildScript.config prop buildVersion.