moduleceylon.build.tasks.ceylon1.0.0
Source Code

Provides Task to launch ceylon compile, compile-js, doc, run, run-js command line tools

Compile

Tasks to compile to both jvm and javascript backend are available. They support various options.

A simple task to compile to jvm backend:

Task compileTask = compile {
    modules = "my.module";
};

A simple task to compile to javascript backend:

Task compileJsTask = compileJs {
    modules = "my.module";
};

Several modules can be compile at once:

Task compileTask = compile {
    modules = ["my.module1", "my.module2"];
};

Compiler options can be configured:

Task compileTask = compile {
    modules = ["my.module", "test.my.module"];
    encoding = "UTF-8";
    sourceDirectories = ["source", "test-source"];
    outputRepository = "~/.ceylon/repo";
};

Compile tests

Tasks to compile tests are provided. They are shortcuts for respectively compile and compileJs functions with sourceDirectories argument set to ["test-source"]

Task to compile tests to jvm backend:

Task compileTestsTask = compileTests {
    modules = "test.my.module";
};

Task to compile tests to javascript backend:

Task compileJsTestsTask = compileJsTests {
    modules = "test.my.module";
};

Doc

A simple document task:

Task documentTask = document {
    modules = "my.module";
};

Several options can be configured:

Task documentTask = document {
    modules = "my.module";
    includeSourceCode = true;
    includeNonShared = true;
};

Run

A simple task to run a module on jvm backend:

Task runTestsTask = runModule {
    moduleName = "test.my.module";
    version = "1.0.0";
};

A simple task to run a module on javascript backend:

Task runJsTestsTask = runModule {
    moduleName = "test.my.module";
    version = "1.0.0";
};

Several options can be configured:

Task runTestsTask = runModule {
    moduleName = "test.my.module";
    version = "1.0.0";
    functionNameToRun = "customMain";
};
License: [ASL 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Packages
ceylon.build.tasks.ceylon

Tasks to compile, run and document ceylon modules

Dependencies
ceylon.build.task1.0.0
ceylon.build.tasks.commandline1.0.0
Source Code
ValuesFunctionsInterfacesClasses

Tasks to compile, run and document ceylon modules

Values
allSource Code
shared all all

All verbose modes

astSource Code
shared ast ast

verbose mode: ast

benchmarkSource Code
shared benchmark benchmark

verbose mode: benchmark

cmrSource Code
shared cmr cmr

verbose mode: cmr

cmrloaderSource Code
shared cmrloader cmrloader

verbose mode: cmrloader

codeSource Code
shared code code

verbose mode: code

loaderSource Code
shared loader loader

verbose mode: loader

Functions
ceylonModuleSource Code
shared GoalSet ceylonModule(String moduleName, String testModuleName = ..., String testModuleVersion = ..., Target target = ..., String(String) rename = ...)

Returns a GoalSet providing goals to compile, test and document ceylon modules.

Following goals will be returned:

  • "doc": document module

JVM specific goals:

  • "compile": compile module
  • "compile-tests": compile test module
  • "run-tests": run test module
  • "test": compile module, compile test module and run test module

Javascript specific goals:

  • "compile-js": compile module
  • "compile-js-tests": compile test module
  • "run-js-tests": run test module
  • "test-js": compile module, compile test module and run test module
Parameters:
  • moduleName

    module name

  • testModuleName = "test.``moduleName``"

    test module name

  • testModuleVersion = "1.0.0"

    test module version

  • target = Target { jvm = true; javascript = true; }

    Targeted backend (JVM and/or Javascript)

  • rename = keepCurrentName()

    rename function that will be applied to each goal name

compileSource Code
shared Task compile(String|{String*} modules, String|{String*} files = [], String? encoding = "", String|{String*} sourceDirectories = [], String|{String*} resourceDirectories = [], String? javacOptions = null, String? outputRepository = null, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? user = null, String? password = null, Boolean offline = false, Boolean noDefaultRepositories = false, {CompileVerboseMode*}|AllVerboseModes verboseModes = [], String ceylon = ..., String? currentWorkingDirectory = null)

Compiles a Ceylon module using ceylon compile command line.

Parameters:
  • modules

    name of modules to compile

  • files = []

    name of files to compile

  • encoding = ""

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories = []

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • resourceDirectories = []

    Path to directory containing resource files (default: './resource') (corresponding command line parameter: --resource=<dirs>)

  • javacOptions = null

    Passes an option to the underlying java compiler (corresponding command line parameter: --javac=<option>)

  • outputRepository = null

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user = null

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password = null

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • noDefaultRepositories = false

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • verboseModes = []

    Produce verbose output. (corresponding command line parameter: --verbose=<flags>)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

compileCommandSource Code
shared String compileCommand(String ceylon, String? currentWorkingDirectory, {String*} modules, {String*} files, String? encoding, {String*} sourceDirectories, {String*} resourceDirectories, String? javacOptions, String? outputRepository, {String*} repositories, String? systemRepository, String? cacheRepository, String? user, String? password, Boolean offline, Boolean noDefaultRepositories, {CompileVerboseMode*}|AllVerboseModes verboseModes, {String*} arguments)

Builds a ceylon compile command as a String and returns it.

Parameters:
  • ceylon

    Ceylon executable that will be used

  • currentWorkingDirectory

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

  • modules

    name of modules to compile

  • files

    name of files to compile

  • encoding

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • resourceDirectories

    Path to directory containing resource files (default: './resource') (corresponding command line parameter: --resource=<dirs>)

  • javacOptions

    Passes an option to the underlying java compiler (corresponding command line parameter: --javac=<option>)

  • outputRepository

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • noDefaultRepositories

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • verboseModes

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • arguments

    custom arguments to be added to commandline

compileJsSource Code
shared Task compileJs(String|{String*} modules, String|{String*} files = [], String? encoding = null, String|{String*} sourceDirectories = [], String? outputRepository = null, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? user = null, String? password = null, Boolean offline = false, Boolean compact = false, Boolean noComments = false, Boolean noIndent = false, Boolean noModule = false, Boolean optimize = false, Boolean profile = false, Boolean skipSourceArchive = false, Boolean verbose = false, String ceylon = ..., String? currentWorkingDirectory = null)

Compiles a Ceylon module to javascript using ceylon compile-js command line.

Parameters:
  • modules

    name of modules to compile

  • files = []

    name of files to compile

  • encoding = null

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories = []

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • outputRepository = null

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user = null

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password = null

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • compact = false

    Equivalent to '–no-indent' '–no-comments' (corresponding command line parameter: --compact)

  • noComments = false

    Do NOT generate any comments (corresponding command line parameter: --no-comments)

  • noIndent = false

    Do NOT indent code (corresponding command line parameter: --no-indent)

  • noModule = false

    Do NOT wrap generated code as CommonJS module (corresponding command line parameter: --no-module)

  • optimize = false

    Create prototype-style JS code (corresponding command line parameter: --optimize)

  • profile = false

    Time the compilation phases (results are printed to standard error) (corresponding command line parameter: --profile)

  • skipSourceArchive = false

    Do NOT generate .src archive - useful when doing joint compilation (corresponding command line parameter: --skip-src-archive)

  • verbose = false

    Print messages while compiling (corresponding command line parameter: --verbose)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

compileJsCommandSource Code
shared String compileJsCommand(String ceylon, String? currentWorkingDirectory, {String*} modules, {String*} files, String? encoding, {String*} sourceDirectories, String? outputRepository, {String*} repositories, String? systemRepository, String? cacheRepository, String? user, String? password, Boolean offline, Boolean compact, Boolean noComments, Boolean noIndent, Boolean noModule, Boolean optimize, Boolean profile, Boolean skipSourceArchive, Boolean verbose, {String*} arguments)

Builds a ceylon compile-js command as a String and returns it.

Parameters:
  • ceylon

    Ceylon executable that will be used

  • currentWorkingDirectory

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

  • modules

    name of modules to compile

  • files

    name of files to compile

  • encoding

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • outputRepository

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • compact

    Equivalent to '–no-indent' '–no-comments' (corresponding command line parameter: --compact)

  • noComments

    Do NOT generate any comments (corresponding command line parameter: --no-comments)

  • noIndent

    Do NOT indent code (corresponding command line parameter: --no-indent)

  • noModule

    Do NOT wrap generated code as CommonJS module (corresponding command line parameter: --no-module)

  • optimize

    Create prototype-style JS code (corresponding command line parameter: --optimize)

  • profile

    Time the compilation phases (results are printed to standard error) (corresponding command line parameter: --profile)

  • skipSourceArchive

    Do NOT generate .src archive - useful when doing joint compilation (corresponding command line parameter: --skip-src-archive)

  • verbose

    Print messages while compiling (corresponding command line parameter: --verbose)

  • arguments

    custom arguments to be added to commandline

compileJsTestsSource Code
shared Task compileJsTests(String|{String*} modules, String|{String*} files = [], String? encoding = null, String? outputRepository = null, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? user = null, String? password = null, Boolean offline = false, Boolean compact = false, Boolean noComments = false, Boolean noIndent = false, Boolean noModule = false, Boolean optimize = false, Boolean profile = false, Boolean skipSourceArchive = false, Boolean verbose = false, String ceylon = ..., String? currentWorkingDirectory = null)

Compiles a Ceylon test module to javascript using ceylon compile-js command line.

--source command line parameter is set to "test-source"

Parameters:
  • modules

    name of modules to compile

  • files = []

    name of files to compile

  • encoding = null

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • outputRepository = null

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user = null

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password = null

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • compact = false

    Equivalent to '–no-indent' '–no-comments' (corresponding command line parameter: --compact)

  • noComments = false

    Do NOT generate any comments (corresponding command line parameter: --no-comments)

  • noIndent = false

    Do NOT indent code (corresponding command line parameter: --no-indent)

  • noModule = false

    Do NOT wrap generated code as CommonJS module (corresponding command line parameter: --no-module)

  • optimize = false

    Create prototype-style JS code (corresponding command line parameter: --optimize)

  • profile = false

    Time the compilation phases (results are printed to standard error) (corresponding command line parameter: --offline)

  • skipSourceArchive = false

    Do NOT generate .src archive - useful when doing joint compilation (corresponding command line parameter: --skip-src-archive)

  • verbose = false

    Print messages while compiling (corresponding command line parameter: --verbose)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

compileTestsSource Code
shared Task compileTests(String|{String*} modules, String|{String*} files = [], String? encoding = "", String? javacOptions = null, String? outputRepository = null, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? user = null, String? password = null, Boolean offline = false, Boolean noDefaultRepositories = false, {CompileVerboseMode*} verboseModes = [], String ceylon = ..., String? currentWorkingDirectory = null)

Compiles a Ceylon test module using ceylon compile command line.

--source command line parameter is set to "test-source"

Parameters:
  • modules

    name of modules to compile

  • files = []

    name of files to compile

  • encoding = ""

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • javacOptions = null

    Passes an option to the underlying java compiler (corresponding command line parameter: --javac=<option>)

  • outputRepository = null

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user = null

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password = null

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • noDefaultRepositories = false

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • verboseModes = []

    Produce verbose output. If no 'flags' are given then be verbose about everything, otherwise just be vebose about the flags which are present (corresponding command line parameter: --verbose=<flags>)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

docCommandSource Code
shared String docCommand(String ceylon, String? currentWorkingDirectory, {String+} modules, String? encoding, {String*} sourceDirectories, String? outputRepository, {String*} repositories, String? systemRepository, String? cacheRepository, String? user, String? password, Boolean offline, String? link, Boolean includeNonShared, Boolean includeSourceCode, Boolean ignoreBrokenLink, Boolean ignoreMissingDoc, {String*} arguments)

Builds a ceylon doc command as a String and returns it.

Parameters:
  • ceylon

    Ceylon executable that will be used

  • currentWorkingDirectory

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

  • modules

    list of modules to document

  • encoding

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • outputRepository

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • link

    The URL of a module repository containing documentation for external dependencies.

    Parameter url must be one of supported protocols (http://, https:// or file://). Parameter url can be prefixed with module name pattern, separated by a '=' character, determine for which external modules will be use.

    Examples:

    • –link https://modules.ceylon-lang.org/
    • –link ceylon.math=https://modules.ceylon-lang.org/

    (corresponding command line parameter: --link=<url>)

  • includeNonShared

    Includes documentation for package-private declarations. (corresponding command line parameter: --non-shared)

  • includeSourceCode

    Includes source code in the generated documentation. (corresponding command line parameter: --source-code)

  • ignoreBrokenLink

    Do not print warnings about broken links. (corresponding command line parameter: --ignore-broken-link)

  • ignoreMissingDoc

    Do not print warnings about missing documentation. (corresponding command line parameter: --ignore-missing-doc)

  • arguments

    custom arguments to be added to commandline

documentSource Code
shared Task document(String|{String+} modules, String? encoding = "", String|{String*} sourceDirectories = [], String? outputRepository = null, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? user = null, String? password = null, Boolean offline = false, String? link = null, Boolean includeNonShared = false, Boolean includeSourceCode = false, Boolean ignoreBrokenLink = false, Boolean ignoreMissingDoc = false, String ceylon = ..., String? currentWorkingDirectory = null)

Documents a Ceylon module using ceylon doc command line.

Parameters:
  • modules

    list of modules to document

  • encoding = ""

    encoding used for reading source files (default: platform-specific) (corresponding command line parameter: --encoding=<encoding>)

  • sourceDirectories = []

    Path to source files (default: './source') (corresponding command line parameter: --source=<dirs>)

  • outputRepository = null

    Specifies the output module repository (which must be publishable). (default: './modules') (corresponding command line parameter: --out=<url>)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • user = null

    Sets the user name for use with an authenticated output repository (corresponding command line parameter: --user=<name>)

  • password = null

    Sets the password for use with an authenticated output repository (corresponding command line parameter: --pass=<secret>)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • link = null

    The URL of a module repository containing documentation for external dependencies.

    Parameter url must be one of supported protocols (http://, https:// or file://). Parameter url can be prefixed with module name pattern, separated by a '=' character, determine for which external modules will be use.

    Examples:

    • –link https://modules.ceylon-lang.org/
    • –link ceylon.math=https://modules.ceylon-lang.org/

    (corresponding command line parameter: --link=<url>)

  • includeNonShared = false

    Includes documentation for package-private declarations. (corresponding command line parameter: --non-shared)

  • includeSourceCode = false

    Includes source code in the generated documentation. (corresponding command line parameter: --source-code)

  • ignoreBrokenLink = false

    Do not print warnings about broken links. (corresponding command line parameter: --ignore-broken-link)

  • ignoreMissingDoc = false

    Do not print warnings about missing documentation. (corresponding command line parameter: --ignore-missing-doc)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

runCommandSource Code
shared String runCommand(String ceylon, String? currentWorkingDirectory, String moduleName, String version, Boolean noDefaultRepositories, Boolean offline, {String*} repositories, String? systemRepository, String? cacheRepository, String? functionNameToRun, {RunVerboseMode*}|AllVerboseModes verboseModes, {String*} arguments)

Builds a ceylon run command as a String and returns it.

Parameters:
  • ceylon

    Ceylon executable that will be used

  • currentWorkingDirectory

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

  • moduleName

    name of module to run

  • version

    version of module to run

  • noDefaultRepositories

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • offline

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • repositories

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • functionNameToRun

    Specifies the fully qualified name of a toplevel method or class with no parameters. (corresponding command line parameter: --run=<toplevel>)

  • verboseModes

    Produce verbose output. (corresponding command line parameter: --verbose=<flags>)

  • arguments

    custom arguments to be added to commandline

runJsCommandSource Code
shared String runJsCommand(String ceylon, String? currentWorkingDirectory, String moduleName, String version, Boolean offline, {String*} repositories, String? systemRepository, String? cacheRepository, String? functionNameToRun, String? debug, String? pathToNodeJs, {String*} arguments)

Builds a ceylon run-js command as a String and returns it.

Parameters:
  • ceylon

    Ceylon executable that will be used

  • currentWorkingDirectory

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

  • moduleName

    name of module to run

  • version

    version of module to run

  • offline

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • repositories

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • functionNameToRun

    Specifies the fully qualified name of a toplevel method or class with no parameters. (corresponding command line parameter: --run=<toplevel>)

  • debug

    Shows more detailed output in case of errors. (corresponding command line parameter: --debug=<debug>)

  • pathToNodeJs

    The path to the node.js executable. Will be searched in standard locations if not specified. (corresponding command line parameter: --node-exe=<node-exe>)

  • arguments

    custom arguments to be added to commandline

runJsModuleSource Code
shared Task runJsModule(String moduleName, String version = ..., Boolean offline = false, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? functionNameToRun = null, String? debug = null, String? pathToNodeJs = null, String ceylon = ..., String? currentWorkingDirectory = null)

Runs a Ceylon module on node.js using ceylon run-js command line

Parameters:
  • moduleName

    name of module to run

  • version = defaultModuleVersion

    version of module to run

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • functionNameToRun = null

    Specifies the fully qualified name of a toplevel method or class with no parameters. (corresponding command line parameter: --run=<toplevel>)

  • debug = null

    Shows more detailed output in case of errors. (corresponding command line parameter: --debug=<debug>)

  • pathToNodeJs = null

    The path to the node.js executable. Will be searched in standard locations if not specified. (corresponding command line parameter: --node-exe=<node-exe>)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

runModuleSource Code
shared Task runModule(String moduleName, String version = ..., Boolean noDefaultRepositories = false, Boolean offline = false, String|{String*} repositories = [], String? systemRepository = null, String? cacheRepository = null, String? functionNameToRun = null, {RunVerboseMode*}|AllVerboseModes verboseModes = [], String ceylon = ..., String? currentWorkingDirectory = null)

Runs a Ceylon module using ceylon run command line.

Parameters:
  • moduleName

    name of module to run

  • version = defaultModuleVersion

    version of module to run

  • noDefaultRepositories = false

    Indicates that the default repositories should not be used (corresponding command line parameter: --no-default-repositories)

  • offline = false

    Enables offline mode that will prevent the module loader from connecting to remote repositories. (corresponding command line parameter: --offline)

  • repositories = []

    Specifies a module repository containing dependencies. Can be specified multiple times. (default: 'modules', '~/.ceylon/repo', http://modules.ceylon-lang.org) (corresponding command line parameter: --rep=<url>)

  • systemRepository = null

    Specifies the system repository containing essential modules. (default: '$CEYLON_HOME/repo') (corresponding command line parameter: --sysrep=<url>)

  • cacheRepository = null

    Specifies the folder to use for caching downloaded modules. (default: '~/.ceylon/cache') (corresponding command line parameter: --cacherep=<url>)

  • functionNameToRun = null

    Specifies the fully qualified name of a toplevel method or class with no parameters. (corresponding command line parameter: --run=<toplevel>)

  • verboseModes = []

    Produce verbose output. (corresponding command line parameter: --verbose=<flags>)

  • ceylon = ceylonExecutable

    Ceylon executable that will be used

  • currentWorkingDirectory = null

    Specifies the current working directory for this tool. (default: the directory where the tool is run from) (corresponding command line parameter: --cwd=<dir>)

Interfaces
AllVerboseModesSource Code
shared AllVerboseModes

All verbose modes for jvm backend compilation / execution

CompileVerboseModeSource Code
shared CompileVerboseMode

Verbose modes for jvm backend compilation

RunVerboseModeSource Code
shared RunVerboseMode

Verbose modes for jvm backend execution

Classes
TargetSource Code
shared Target

Compilation / Execution targets

allSource Code
shared all

All verbose modes

astSource Code
shared ast

verbose mode: ast

benchmarkSource Code
shared benchmark

verbose mode: benchmark

cmrSource Code
shared cmr

verbose mode: cmr

cmrloaderSource Code
shared cmrloader

verbose mode: cmrloader

codeSource Code
shared code

verbose mode: code

loaderSource Code
shared loader

verbose mode: loader