Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 2.68 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.68 KB
Raw

AsyncAPI Gradle Plugin

AsyncAPI Gradle plugin that delegates installation and execution of npm commands to com.github.node-gradle.node Gradle plugin.

This way one doesn't need to care about node and npm installation within JVM project in order to use AsyncAPI generator.

Usage

To use the async generator in you Gradle build, apply the plugin:

plugins {
  id("com.rivancic.asyncapi-gradle-plugin") version "0.2.0"
}

Plugin is available on Gradle Plugin Portal under com.rivancic.asyncapi-gradle-plugin.

Configuration

One can configure following parameters through asyncapi extension:

asyncapi and template parameters are required to be set.

asyncapi {

  // You want a specific version of the generator because your template might not be compatible with the latest 
  // generator. Check what version you need and perform installation, specifying the exact version.
  version.set("1.14.1")
  
  // Local path or URL pointing to AsyncAPI specification file
  asyncapi.set(null)

  // Name of the generator template like for example <i>@asyncapi/html-template</i> or 
  // <i>https://github.com/asyncapi/html-template</i>
  template.set(null)

  // Directory where to put the generated files (defaults to current directory)
  output.set("build/asyncapi")

  // Output the version number
  printVersion.set(false)

  // Enable more specific errors in the console
  debug.set(false)

  // Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty 
  // dir (defaults to false)
  forceWrite.set(false)

  // Additional parameters that will be passed to templates. Have to be provided as a map.
  parameters.set(mapOf<String, String>())
}

It's planned to support all the AsyncAPI CLI options.

Additionally one can leverage configuration of com.github.node-gradle.node plugin with node extension. For example:

node {
  download.set(true)
  version.set("21.1.0")
  ...
}

Tasks:

Task Description
asyncApiGenerate Generate code based on the configuration form variables
assemble Depends on asyncApiGenerate task
clean Basic clean task, will delete build directory