Fan

 

abstract class

build::BuildPod

sys::Obj
  build::BuildScript
    build::BuildPod

BuildPod is the base class for build scripts used to manage building a Fan source code and resources into a Fan pod.

See docTools::Build for details.

Slots

cleanSource

virtual Void clean()

compileSource

virtual Void compile(Bool includeFandocAndSrc := false)

compileAllSource

virtual Void compileAll()

defaultTargetSource

override Target defaultTarget()

Default target is compile.

dependsSource

Str[] depends

Dependencies of the pod formatted as a list of sys::Depend strings. Required.

dependsDirSource

Uri dependsDir

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.

descriptionSource

Str description

Short one sentence description of the pod. Required.

docSource

virtual Void doc()

dotnetDirsSource

Uri[]? dotnetDirs

List of Uris relative to scriptDir of directories containing the C# source files to compile for .NET native dll.

dotnetLibsSource

Uri[]? dotnetLibs

List of Uris relative to scriptDir of .NET assemblies which are automatically included in the library path when compiling the dotnetDirs.

dotnetNativeSource

virtual Void dotnetNative()

fullSource

virtual Void full()

hasJavascriptSource

Bool hasJavascript

If true compile any Types with the @javascript facet into Javascript source.

includeFandocSource

Bool includeFandoc

Include the fandoc API in the pod file. This is required to access the doc at runtime and to run the fandoc compiler. Default is true.

includeSrcSource

Bool includeSrc

Include the full set of source code in the pod file. This is required to generate links in HTML doc to HTML formatted source. Defaults to false.

javaDirsSource

Uri[]? javaDirs

List of Uris relative to scriptDir of directories containing the Java source files to compile for Java native jar.

javaLibsSource

Uri[]? javaLibs

List of Uris relative to scriptDir of Java jar files which are automatically included in the classpath when compiling the javaDirs.

javaNativeSource

virtual Void javaNative()

javascriptSource

virtual Void javascript()

podFacetsSource

[Str:Obj]? podFacets

User defined pod level facets. Optional.

podNameSource

Str podName

Programatic name of the pod. Required.

resDirsSource

Uri[]? resDirs

List of Uris relative to scriptDir of directories of resources files to package into pod zip file. Optional.

srcDirsSource

Uri[] srcDirs

List of Uris relative to scriptDir of directories containing the Fan source files to compile. Required.

testSource

virtual Void test()

versionSource

Version version

Version of the pod - typically set to BuildScript.globalVersion. Required.