kie-issues#1498: Add "Generate form code for human interactions" command in the BPMN VS Code extension #2660

ljmotta · 2024-10-11T21:06:44Z

Closes: apache/incubator-kie-issues#1498

Description

Add BPMN Editor: Generate form code for human interactions from jBPM project command.
Add BPMN Editor prefix to the other BPMN Editor VS Code commads.
Rename inputSanizationUtil to removeInvalidVarChars.
Rename sanatizedId to idWithoutInvalidVarChars.
Make theme idWithoutInvalidVarChars optional.
Improve form-code-generator FormAsset interface.

tiagobento

Few comments inline... and also I think we need to add this command to our development VS Code Extension...

tiagobento · 2024-10-14T16:14:08Z

packages/bpmn-vscode-extension/package.json

@@ -65,11 +69,15 @@
          "dark": "./static/svg-icon-dark.png",
          "light": "./static/svg-icon-light.png"
        },
-        "title": "Get BPMN Editor Preview SVG"
+        "title": "BPMN Editor: Get BPMN Editor Preview SVG"


Suggested change

"title": "BPMN Editor: Get BPMN Editor Preview SVG"

"title": "BPMN Editor: Get preview SVG"

?

tiagobento · 2024-10-14T16:15:03Z

packages/bpmn-vscode-extension/src/extension/extension.ts

+  context.subscriptions.push(
+    vscode.commands.registerCommand("extension.kie.generateFormCode", async (args: any) => generateFormsCommand())
+  );


Suggested change

context.subscriptions.push(

vscode.commands.registerCommand("extension.kie.generateFormCode", async (args: any) => generateFormsCommand())

);

context.subscriptions.push(

vscode.commands.registerCommand("extension.apache.kie.bpmnEditor.generateFormCode", async (args: any) => generateFormsCommand())

);

?

tiagobento

"Invalid var chars" seems like a very clear name, but I'm not sure in what context "var" falls into. Is it a BPMN variable? Or a TypeScript variable? Maybe we could be a little bit extra there, if that's the goal?

ljmotta · 2024-10-14T18:00:52Z

@tiagobento It's related to TypeScript variables... I'll update accordingly.

jomarko

I think the only feedback I have is about the step of selecting jBPM project path

jomarko · 2024-10-22T12:55:47Z

packages/kie-editors-dev-vscode-extension/package.json

+        "title": "Kogito Editors: Save Preview SVG"
      },
      {
        "command": "extension.kogito.runTest",
-        "title": "Run"
+        "title": "Kogito Editors: Run"
      },
      {
        "command": "extension.kogito.silentlyGenerateSvg",
-        "title": "Generate SVG without any notification"
+        "title": "Kogito Editors: Generate SVG without any notification"
+      },
+      {
+        "command": "extension.apache.kie.kogitoEditors.generateFormCode",
+        "title": "Kogito Editors: Generate form code for human interactions from jBPM project"


not sure about word Kogito as we are in kie-editors-dev-vscode-extension package, not a kogito-editors-dev-vscode-extension

jomarko · 2024-10-22T12:56:11Z

packages/kie-editors-dev-vscode-extension/package.json

@@ -144,7 +149,7 @@
    },
    "customEditors": [
      {
-        "displayName": "KIE Kogito Editors",
+        "displayName": "Apache KIE Kogito Editors",


similar comment

jomarko · 2024-10-22T13:06:42Z

packages/form-code-generator-vscode-command/src/generateFormCodeCommand.ts

+  // Select project path
+  const projectUri = await vscode.window.showOpenDialog({
+    canSelectFiles: false,
+    canSelectFolders: true,
+    canSelectMany: false,
+    openLabel: "Select Project Folder",
+    defaultUri: defaultPath ? vscode.Uri.file(defaultPath) : undefined,
+  });


The problem with added dialogues/prompts/popups, not sure what is the terminology in VSCode is only with the first one. There is no additionl linformation in the step of selecting path to the jBPM project. See the second screenshot below.:

01

02

it seems openLabel: "Select Project Folder", config is not used? In the documentation I see alternative title ? https://code.visualstudio.com/api/references/vscode-api#OpenDialogOptions

Using the generate command for the first time I was confused what should I do in the step 02.

Indeed. Changing to title fixed the problem, adding the label in this step:

ljmotta · 2024-10-28T15:06:23Z

@jomarko Thanks for your review. The name "Kogito Editors" is due to the current extension name. It's not the intent of this PR to change the extension name, I've only added the "Apache" as it's a must. @tiagobento do we create a new issue to tackle the Kogito name, or I just remove and call it "Apache KIE Editors"?

jomarko

Thank you for changes, I understand the substring "Kogito Editors" must be discussed further with others, so I am approving this PR and I will accept any decision that will be taken by the team around this.

…and in the BPMN VS Code extension (apache#2660)

ljmotta added 11 commits October 7, 2024 16:40

wip

4a77491

extract command to another file

2815e90

missing config files and partial generation

cdebfb9

Partial and override working

6866073

Improve comments

ba0afcc

Change form-code-generator FormAsset interface

d9a3674

Polishing the code

f3e544b

Fix FormCodeGeneration interface

73e7597

Rename sanitization

f476dcd

Save the form code file without the invalid chars

3d77e90

Clean up

a8acac3

ljmotta added the area:bpmn label Oct 11, 2024

ljmotta self-assigned this Oct 11, 2024

ljmotta added the pr: wip PR is still under development label Oct 11, 2024

Minor changes

a198cd8

ljmotta added pr: waiting-for-ci CI is still running or broken. and removed pr: wip PR is still under development labels Oct 14, 2024

ljmotta marked this pull request as ready for review October 14, 2024 11:08

ljmotta requested a review from tiagobento as a code owner October 14, 2024 11:08

tiagobento requested changes Oct 14, 2024

View reviewed changes

tiagobento reviewed Oct 14, 2024

View reviewed changes

ljmotta added 8 commits October 14, 2024 16:28

Code review

c83bcf2

Update variable name

e54313f

Extract generate form code command to a new package

cdbdcea

Add form code generator in kie-editors-dev-vscode-extension

0dff53a

Merge remote-tracking branch 'origin/main' into kie-issues-1498-b

d5175d4

Oops

3bad54b

Add missing env file

024cb77

Update README

f3ce83b

Add missing dependency

f51b8ea

ljmotta force-pushed the kie-issues-1498-b branch 3 times, most recently from 586fc96 to f51b8ea Compare October 17, 2024 01:19

Remove peerDependencies

0b04249

ljmotta force-pushed the kie-issues-1498-b branch from 16a25b3 to 0b04249 Compare October 17, 2024 13:42

tiagobento removed the pr: waiting-for-ci CI is still running or broken. label Oct 22, 2024

jomarko reviewed Oct 22, 2024

View reviewed changes

Change to title

dae8d55

jomarko approved these changes Oct 29, 2024

View reviewed changes

tiagobento approved these changes Oct 29, 2024

View reviewed changes

tiagobento merged commit 9a8d8c9 into apache:main Oct 29, 2024
14 checks passed

ricardozanini pushed a commit to ricardozanini/kogito-tooling that referenced this pull request Nov 5, 2024

kie-issues#1498: Add "Generate form code for human interactions" comm…

cca8844

…and in the BPMN VS Code extension (apache#2660)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kie-issues#1498: Add "Generate form code for human interactions" command in the BPMN VS Code extension #2660

kie-issues#1498: Add "Generate form code for human interactions" command in the BPMN VS Code extension #2660

ljmotta commented Oct 11, 2024 •

edited

Loading

tiagobento left a comment

tiagobento Oct 14, 2024

tiagobento Oct 14, 2024

tiagobento left a comment

ljmotta commented Oct 14, 2024

jomarko left a comment

jomarko Oct 22, 2024

jomarko Oct 22, 2024

jomarko Oct 22, 2024

ljmotta Oct 28, 2024

jomarko Oct 29, 2024

ljmotta commented Oct 28, 2024

jomarko left a comment

	"title": "BPMN Editor: Get BPMN Editor Preview SVG"
	"title": "BPMN Editor: Get preview SVG"

kie-issues#1498: Add "Generate form code for human interactions" command in the BPMN VS Code extension #2660

kie-issues#1498: Add "Generate form code for human interactions" command in the BPMN VS Code extension #2660

Conversation

ljmotta commented Oct 11, 2024 • edited Loading

Description

tiagobento left a comment

Choose a reason for hiding this comment

tiagobento Oct 14, 2024

Choose a reason for hiding this comment

tiagobento Oct 14, 2024

Choose a reason for hiding this comment

tiagobento left a comment

Choose a reason for hiding this comment

ljmotta commented Oct 14, 2024

jomarko left a comment

Choose a reason for hiding this comment

jomarko Oct 22, 2024

Choose a reason for hiding this comment

jomarko Oct 22, 2024

Choose a reason for hiding this comment

jomarko Oct 22, 2024

Choose a reason for hiding this comment

01

02

ljmotta Oct 28, 2024

Choose a reason for hiding this comment

jomarko Oct 29, 2024

Choose a reason for hiding this comment

ljmotta commented Oct 28, 2024

jomarko left a comment

Choose a reason for hiding this comment

ljmotta commented Oct 11, 2024 •

edited

Loading