add Groovy Script 脚本设计规范

Author: xlorne

frontend/packages/flow-pc/flow-pc-design/src/components/design-editor/node-components/scripts/README.md

@@ -0,0 +1,43 @@
+# Groovy Script 脚本设计规范
+
+## 脚本的实例写法如下
+```
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+## 脚本规范
+request对象，根据脚本的不同，起传递的request对象也不同。
+return语句，return语句根据脚本的不同，起返回的对象也不同。
+
+## 开发规范
+为了让脚本可以更好的呈现和使用，脚本的配置分为两种模式，一种是可视化配置模式，一种是代码配置模式。
+
+* 代码配置模式
+代码配置模式的脚本中，将会通过注释的方式添加一行@CUSTOM_SCRIPT，来标识这是一个自定义脚本，这样在编辑器中就会以代码的形式展示出来。
+```
+// @CUSTOM_SCRIPT
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+* 可视化配置模式
+可视化配置模式的脚本中，没有@CUSTOM_SCRIPT的注释标识，这样在编辑器中就会以可视化的形式展示出来。
+```
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+## 脚本展示标题
+为了让脚本在在展示时可以更好的展示脚本的作用，所以在脚本中支持通过@SCRIPT_TITLE的注释来标识脚本的展示标题，这样在编辑器中就会以这个标题来展示脚本。 
+
+```
+// @SCRIPT_TITLE 这是一个示例脚本
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+上述的脚本在编辑器中就会以“这是一个示例脚本”来展示，而不是以代码的方式来展示。

frontend/packages/flow-pc/flow-pc-design/src/components/design-editor/node-components/scripts/services/convertor/utils.ts

@@ -3,9 +3,11 @@ import {
     NodeTitleGroovyConvertor
 } from "@/components/design-editor/node-components/scripts/services/convertor/node-title";
 
-/** 自定义注释标记 */
-const CUSTOM_COMMENT = '@CUSTOM_SCRIPT';
+/** 自定义脚本标记 */
+const CUSTOM_SCRIPT = '@CUSTOM_SCRIPT';
 
+/** 脚本标题标记 */
+const SCRIPT_TITLE = '@SCRIPT_TITLE';
 
 /**
  * Groovy脚本转换器接口
@@ -94,7 +96,7 @@ export class GroovyScriptConvertorUtil {
      * @param script
      */
     public static isCustomScript(script: string): boolean {
-        return script.includes(CUSTOM_COMMENT);
+        return script.includes(CUSTOM_SCRIPT);
     }
 
     /**
@@ -105,9 +107,38 @@ export class GroovyScriptConvertorUtil {
         if (GroovyScriptConvertorUtil.isCustomScript(script)) {
             return script;
         }
-        return `// ${CUSTOM_COMMENT}\n${script}`;
+        return `// ${CUSTOM_SCRIPT}\n${script}`;
     }
 
+
+    /**
+     * 获取脚本中的标题注释内容
+     * @param script
+     */
+    public static getScriptTitle(script: string): string {
+        const titleMatch = script.match(new RegExp(`//\\s*${SCRIPT_TITLE}:\\s*(.+)`));
+        if (titleMatch) {
+            return titleMatch[1].trim();
+        }
+        return '';
+    }
+
+    /**
+     * 更新脚本中的标题注释内容，如果不存在则添加
+     * @param script
+     * @param title
+     */
+    public static updateScriptTitle(script: string, title: string): string {
+        const titleComment = `// ${SCRIPT_TITLE}: ${title}`;
+        if (GroovyScriptConvertorUtil.getScriptTitle(script)) {
+            return script.replace(new RegExp(`//\\s*${SCRIPT_TITLE}:\\s*.+`), titleComment);
+        } else {
+            return `${titleComment}\n${script}`;
+        }
+    }
+
+
+
     /**
      * 清除脚本中的注释
      * @param script
@@ -144,14 +175,14 @@ export class GroovyScriptConvertorUtil {
     /**
      * 将可视化表达式转换为Groovy表达式（编辑时）
      * @param expression
-     * @param mappings
+     * @param variables
      */
-    public static toScript(expression: string, mappings: GroovyVariableMapping[]): string {
+    public static toScript(expression: string, variables: GroovyVariableMapping[]): string {
 
         let result = expression;
 
         // 按label长度降序排序，避免短label替换长label的一部分
-        const sortedMappings = [...mappings].sort((a, b) => b.label.length - a.label.length);
+        const sortedMappings = [...variables].sort((a, b) => b.label.length - a.label.length);
 
         // 将 ${label} 替换为唯一的占位符
         const placeholders: Map<string, string> = new Map();
@@ -204,12 +235,12 @@ export class GroovyScriptConvertorUtil {
     /**
      * 将Groovy表达式转换为可视化表达式（回显时）
      * @param script
-     * @param mappings
+     * @param variables
      */
-    public static toExpression(script: string, mappings: GroovyVariableMapping[]): string {
+    public static toExpression(script: string, variables: GroovyVariableMapping[]): string {
         let result = script;
         const exprToLabel = new Map<string, string>();
-        for (const mapping of mappings) {
+        for (const mapping of variables) {
             exprToLabel.set(mapping.value, mapping.label);
         }