@@ -3,7 +3,7 @@ date=2021-08-14
33type=project
44status=published
55summary=KFSM - Visualization Gradle plugin
6- version=1.5.2.1
6+ version=1.5.2.3
77~~~~~~
88= KFSM Visualization Gradle plugin
99
@@ -15,13 +15,20 @@ This model includes the content of the lambdas used in guards and actions.
1515==Getting Started
1616
1717Plugin Id: `io.jumpco.open.kfsm.viz-plugin`
18- Version: `1.5.2.1 `
18+ Version: `1.5.2.3 `
1919
2020=== Gradle Groovy DSL
2121[source,groovy]
2222----
2323plugins {
24- id 'io.jumpco.open.kfsm.viz-plugin' version '1.5.2.1'
24+ id 'io.jumpco.open.kfsm.viz-plugin' version '1.5.2.3'
25+ }
26+ ----
27+ === Gradle Kotlin DSL
28+ [source,kotlin]
29+ ----
30+ plugins {
31+ id("io.jumpco.open.kfsm.viz-plugin") version "1.5.2.3"
2532}
2633----
2734
@@ -42,13 +49,30 @@ kfsmViz {
4249 }
4350}
4451----
45- <1> `input: File`: Required, fully qualified filename of relevant source file
46- <2> `isGeneratePlantUml: Boolean`: Required default is false
47- <3> `isGenerateAsciidoc: Boolean`: Required default is false
48- <4> `output: String`: Optional filename base. The default is the classname
49- <5> `outputFolder: File`: Optional directory for output file. Default is `$buildDir/generated`
50- <6> `plantUmlName: String`: Optional filename for plantuml output. Default is `$output.plantuml`
51- <7> `asciidocName: String`: Optional name of Asciidoc output file. Default is `$output.adoc`
52+ === Gradle Kotlin DSL
53+ [source,kotlin]
54+ ----
55+ import io.jumpco.open.kfsm.gradle.VizPluginExtension
56+ configure<VizPluginExtension> {
57+ fsm("PacketReaderFSM") {
58+ input = file("src/main/kotlin/PacketReader.kt") // <1>
59+ isGeneratePlantUml = true // <2>
60+ isGenerateAsciidoc = true // <3>
61+ output = "packet-reader" // <4>
62+ outputFolder = file("generated") // <5>
63+ plantUmlName = "packet-reader-statediagram.plantuml" // <6>
64+ asciidocName = "packet-reader-state-table.adoc" // <7>
65+ }
66+ }
67+ ----
68+
69+ <1> `input: File`: *Required*, relative path/name of relevant source file
70+ <2> `isGeneratePlantUml: Boolean`: *Required* default is false
71+ <3> `isGenerateAsciidoc: Boolean`: *Required* default is false
72+ <4> `output: String`: _Optional_ filename base. The default is the classname
73+ <5> `outputFolder: File`: _Optional_ directory for output file. Default is `$buildDir/generated`
74+ <6> `plantUmlName: String`: _Optional_ filename for plantuml output. Default is `$output.plantuml`
75+ <7> `asciidocName: String`: _Optional_ name of Asciidoc output file. Default is `$output.adoc`
5276
5377=== Example with multiple state machines.
5478[source,groovy]