Taxi CLI
Plugins
Plugins can be used to output a taxi model in a specific language - or to modify the source from a generator.
Plugins are either packaged internally with Taxi, or you can write your own, which can be downloaded and included.
Declaring a plugin
Plugins are declared in the plugins section of the taxi.conf file. Declare the name of the plugin to enable, followed by configuration options for that plugin
plugins: {
'taxi/kotlin' { // Name of the plugin
// plugin config goes here
}
}
pluginSettings: { // Optional
repositories: [
'http://your-plugin-repository-url'
]
localCache: '~/.taxi.plugins'
}Configuring a plugin
Each plugin determines it’s own configuration. The PluginWithConfig<T> interface defines the type of config that a plugin will consume. For an example, check out the Kotlin plugin.
Kotlin plugin
The Kotlin Plugin generates Kotlin classes, annotated with @DataType. This makes referencing taxi types in services more typesafe and robust.
What's generated
Scalar & Primitive types
Primitive and Scalar (types without properties) are output as kotlin type alias types, with a corresponding @DataType annotation
Model types
model types in Taxi (or types that contain properties) will generate a kotlin data class. with a corresponding @DataType annotation
Enums
Enums in Taxi are output as kotlin enumclasses
Configuration
| Name | Usage | Default |
|---|---|---|
| outputPath | Defines where the generated kotlin code is written. This is relative to the output parameter in the main project config | kotlin |
| kotlinVersion | The version of kotlin to use. Defines the Maven dependencies that are generated | 1.3.50 |
| kotlinLanguageVersion | The kotlin language version. Corresponds to the languageVersion property in Kotlin’s configuration. | 1.3 |
| jvmTarget | Which version of the JVM to target. Defaults t | 1.8 |
| maven | Defines the properties used for Maven configuration. If omitted, a pom.xml file is not generated. | - |
| taxiVersion | The version of the taxi to depend on | The same version as the compiler being used. |
For more details see the KotlinPluginConfig class.
Generating a Maven pom.xml
The plugin will optionally generate a Maven pom.xml file, to allow you to then compile and publish a jar file containing the generated artifacts.
The following properties can be configured, which relate to the same concepts in a maven pom.xml file:
- groupId (defaults to the organisation name within the taxi project)
- artifactId (defaults to the project name within the taxi project)
- dependencies
- repositories
- distribution management
| Name | Usage | Default value |
|---|---|---|
| groupId | The maven groupId in the generated output | The groupId of the taxi project |
| artifactId | The maven artifactId in the generated output | The project name of the taxi project |
| dependencies | Configures additional maven dependencies in the output maven pom. Generally, this isn’t required. Kotlin and Taxi dependencies are included by default | Kotlin and Taxi dependencies |
| repositories | Configures additional repositories to download dependencies from. Use this if you have an internal maven repository server that operates as a corporate proxy to Maven central | Omitted |
| distributionManagement | Defines where generated jar files are published using mavens deploy command | Omitted |
Sample Configuration
name: taxi/maven-sample
version: 0.3.0
sourceRoot: src/
plugins: {
taxi/kotlin: {
maven: {
groupId: "lang.taxi"
artifactId: "parent"
repositories: [
{
id: "internal-repo"
url: "https://newcorp.nexus.com"
snapshots: true
}
]
distributionManagement: {
id: "some-internal-repo"
url: "https://our-internal-repo"
}
}
}
}
Writing your own plugins
You can author your own plugins which hook into the Taxi compilation and code generation process by implementing the ComponentProviderPlugin interface.
The taxi-jpa project is provided as a sample to show how to implement your own plugins.
Distributing Plugins
See