Package xyz.block.ftl.language.v1

LanguageCommandService models commands that can be sent to a language plugin over the CLI interface.

Request to create a new module.

BuildContext contains contextual information needed to build.

Plugins must include the build context's id when a build succeeds or fails.
For automatic rebuilds, plugins must use the most recent build context they have received.

AutoRebuildStarted should be sent when the plugin decides to start rebuilding automatically.

It is not required to send this event, though it helps inform the user that their changes are not yet built.
FTL may ignore this event if it does not match FTL's current build context and state.
If the plugin decides to cancel the build because another build started, no failure or cancellation event needs
to be sent.

Every type of message that can be streamed from the language plugin for a build.

GetModuleConfigDefaultsResponse provides defaults for ModuleConfig.

The result may be cached by FTL, so defaulting logic should not be changing due to normal module changes.
For example, it is valid to return defaults based on which build tool is configured within the module directory,
as that is not expected to change during normal operation.
It is not recommended to read the module's toml file to determine defaults, as when the toml file is updated,
the module defaults will not be recalculated.

Request to build a module.

Error contains information about an error that occurred during a build.
Errors do not always cause a build failure. Use lesser levels to help guide the user.

BuildFailure should be sent when a build fails.

FTL may ignore this event if it does not match FTL's current build context and state.

ProjectConfig contains the configuration for a project, found in the ftl-project.toml file.

Response to a create module request.

BuildSuccess should be sent when a build succeeds.

FTL may ignore this event if it does not match FTL's current build context and state.

ModuleConfig contains the configuration for a module, found in the module's ftl.toml file.

LanguageCommandService models commands that can be sent to a language plugin over the CLI interface.