@kie-tools/form-generation-tool
v0.32.0
Published
This is a utility CLI to help generating forms in differents formats for BPMN processes and User Tasks in your Kogito projects.
Downloads
27
Readme
Form Generation Tool
This is a utility CLI to help generating forms in differents formats for BPMN processes and User Tasks in your Kogito projects.
How does it work?
When building a Kogito project, Kogito generates JSON schemas to represent the data models for both Processes and User Tasks.
This tool locates those JSON Schemas in the project and taking advantage of the Uniforms APIs, processes them and generate static forms as a resources in the project src/main/resoures/form
folder.
Form Types
There are two types of form supported with differnt styling and output format:
Patternfly: generates a React (
.tsx
) forms using Patternfly 4 components. Implementation can be found in@kie-tools/uniforms-patternfly-codegen
Bootstrap 4: generates a HTML (
.html
) forms using Bootstrap 4 styling.
Each generated form consist in two files, the source code (.tsx
or .html
) and a companion .config
file that defines the external resources (css
/ js
) the form may need.
Build
In order to build the CLI you must run the following command in the root folder of the repository:
pnpm -F @kie-tools/form-generation-tool... build:prod
After the command has finished, go to packages/form-generation-tool/dist
folder and you'll find the CLI binary (form-generation-cli-macos
, form-generation-cli-linux
or form-generation-cli-win.exe
depending on your OS).
Running the CLI
In the command line just execute the CLI binary:
./form-generation-cli-linux
This command will start a wizard to help you generate the forms:
- First set the path to your Kogito Project.
ℹ️ NOTE: Make sure your Kogito project has been compiled, otherwhise the CLI won't be able to find all the form schemas.
- Select one of the availables the Form types (Patternfly or Bootstrap 4).
- Confirm Selection to start the Form Generation process.
- If the Form generation process is succesful, you'll get a confirmation message.
The generated forms will be stored in the src/main/resources/forms
folder of the Kogito project.
Using the Custom Forms with Runtime Tools Quarkus Extension
If your project is a Quarkus based Kogito project, you can use and test them by using the Runtime Tools Quarkus Extension.
To do so, just add the following dependency in your project pom.xml
:
<dependency>
<groupId>org.kie.kogito</groupId>
<artifactId>runtime-tools-quarkus-extension</artifactId>
<version>${version}</version>
</dependency>
And start the project in Dev mode with the command:
mvn clean quarkus:dev
For more information on how to setup the Runtime Tools Quarkus Extension in your project look at the oficial Kogito documentation.