Tasks

The tasks module defines annotations and enums for describing runnable tasks
in Cavefiles.

Annotations

Alias

annotation Alias
                        

Provides alternative names for the task, flag, or argument.

Fields:

• @Array alias

Arg

annotation Arg
                        

Marks this field as a positional commandline argument.

Call

annotation Call
                        

Indicates that this task is implemented by a function.

Fields:

• @Function function

Exec

annotation Exec
                        

Indicates that this task is implemented in an external file.

Fields:

• @String file

Flag

annotation Flag
                        

Marks this field as a commandline flag.

Help

annotation Help
                        

A short help text for the task, flag, or argument.

Fields:

• @String help

Import

annotation Import
                        

Indicates that this task uses a module for its implementation.

Fields:

• @Module module

Name

annotation Name
                        

Renames the task, flag, or argument.

Fields:

• @String name

Short

annotation Short
                        

Provides a short name for the flag. Not applicable to arguments.

Fields:

• @Char short

Enum

Task

enum Task
                        

Marks a data declaration as a task. Exactly one of @Exec, @Call, or @Import
is required.

Cases:

• Exec
• Call
• Import