worsoft-frontend-codegen-local-mcp 0.1.0

package/MVP_DESIGN.md

@@ -0,0 +1,78 @@
+# MVP Design
+
+## Goal
+
+Build a parallel MCP plugin that generates frontend files from:
+- local Markdown design docs
+- local template assets
+- style-based template selection
+
+without depending on the Worsoft backend generation API.
+
+## First Supported Flow
+
+1. Read `designFile` or fall back to `plugins/sql/SQL 设计说明.md`
+2. Parse one table definition by `tableName`
+3. Load style metadata from `assets/style-catalog.json`
+4. Resolve the shared template selection for the requested `style`
+5. Build a normalized metadata model
+6. For `master_child_jump`, infer the child relation from the design doc when possible
+7. Map parsed fields into simple frontend field types
+8. Render plugin-local runtime templates when the style is implemented
+9. Return a render manifest
+10. Optionally write files
+
+## Declared Styles
+
+- `single_table_jump`
+- `single_table_dialog`
+- `master_child_jump`
+
+## Runtime-Implemented Styles
+
+- `single_table_jump`
+- `single_table_dialog`
+- `master_child_jump`
+
+## Metadata Model
+
+```json
+{
+  "tableName": "iwm_sys_trade",
+  "className": "IwmSysTrade",
+  "functionName": "iwmSysTrade",
+  "moduleName": "admin/test",
+  "pk": { "fieldName": "id", "attrName": "id" },
+  "fields": [
+    {
+      "fieldName": "trade_name",
+      "attrName": "tradeName",
+      "sqlType": "VARCHAR",
+      "comment": "Trade Name",
+      "formType": "text",
+      "isAudit": false
+    }
+  ]
+}
+```
+
+## Master-Child Contract
+
+When `style=master_child_jump`, local mode now prefers the Markdown design file contract:
+- parse child relations from the "主从表关联说明" section
+- auto-resolve `mainField` and `childField`
+- require `childTableName` only when one main table has multiple child relations
+
+## Risks
+
+- Existing shared templates use Velocity syntax and need a larger rendering engine.
+- Markdown design docs may drift from the real schema if they are not maintained.
+- Query/list/form metadata inference is heuristic in local mode.
+- Multi-child relations still need explicit disambiguation.
+
+## Next Steps
+
+1. Add query/grid heuristics
+2. Add dict config sidecar file support
+3. Decide whether to migrate shared templates into a neutral local template format
+4. Consider cross-checking Markdown definitions against SQL or DB metadata

package/README.md

@@ -0,0 +1,121 @@
+# Worsoft Frontend Codegen Local MCP
+
+This plugin is a parallel local-template MVP for frontend code generation.
+It does not call `/admin/generator/mcp/execute`.
+
+## MVP Scope
+
+- local Markdown design file input
+- style-based template selection
+- local template rendering
+- single-table runtime generation
+- master-child runtime generation with relation inference from the design file
+- render plan preview
+- optional write-to-disk
+
+## Current Inputs
+
+- `designFile` : optional, defaults to `../sql/SQL 设计说明.md`
+- `tableName`
+- `style`
+- `frontendPath`
+- `moduleName`
+- `writeToDisk`
+- `childTableName` when `style=master_child_jump` : optional, only needed when one main table has multiple child-table relations in the design file
+
+## Recommended MCP Arguments
+
+Use `designFile` as the source argument.
+
+```json
+{
+  "tableName": "iwm_sys_trade",
+  "style": "master_child_jump",
+  "designFile": "plugins/sql/SQL 设计说明.md",
+  "frontendPath": "E:/own-worker-platform/trunk/worsoft-ui",
+  "moduleName": "admin/test",
+  "writeToDisk": false
+}
+```
+
+## Smoke Test Template
+
+Use `smoke_test_mcp.js` for quick local MCP verification.
+
+PowerShell is the recommended option on Windows because it does not depend on Node spawning a child Node process.
+
+```bash
+node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario single
+node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario master
+node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario child
+```
+
+```powershell
+powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario single
+powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario master
+powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario child
+```
+
+Optional overrides:
+
+- `--design-file`
+- `--table-name`
+- `--style`
+- `--child-table-name`
+- `--frontend-path`
+- `--write-to-disk`
+
+For `master_child_jump`, the execution result will return the detected relation. If the relation is ambiguous or not the one you want, the MCP error/result includes a `correctionEntry` with `childTableName`, `example`, and `retryArguments`, so the caller can resubmit directly.
+
+When one main table has multiple child relations in the design file, add `childTableName` to disambiguate:
+
+```json
+{
+  "tableName": "iwm_sys_trade_level",
+  "style": "master_child_jump",
+  "designFile": "plugins/sql/SQL 设计说明.md",
+  "childTableName": "iwm_sys_trade_level_standard",
+  "frontendPath": "E:/own-worker-platform/trunk/worsoft-ui",
+  "writeToDisk": false
+}
+```
+
+## Current Outputs
+
+- `src/views/<module>/<function>/index.vue`
+- `src/views/<module>/<function>/form.vue`
+- `src/views/<module>/<function>/options.ts`
+- `src/api/<module>/<function>.ts`
+- `menu/<function>_menu.sql`
+
+## Style Catalog
+
+- Human guide: `STYLE_TEMPLATE_GUIDE.md`
+- Machine source: `assets/style-catalog.json`
+
+Declared styles:
+- `single_table_jump`
+- `single_table_dialog`
+- `master_child_jump`
+
+Runtime generation support:
+- `single_table_jump`: supported
+- `single_table_dialog`: supported
+- `master_child_jump`: supported
+
+## Non-goals for v0.1
+
+- backend API forwarding
+- generic Velocity rendering
+- dict lookup from backend
+- full compatibility with the old generator contract
+
+## Notes
+
+- Shared Worsoft template references live under `../template`.
+- Plugin-local runtime assets live under `assets/templates`.
+- The preferred source is `plugins/sql/SQL 设计说明.md`.
+- Markdown mode parses both the field-definition tables and the "主从表关联说明" section.
+- When a main table has multiple child relations, provide `childTableName` to disambiguate.
+- Menu SQL is currently emitted to `frontendPath/menu/` because local mode does not accept `backendPath` yet.
+- The renderer uses a simple placeholder engine instead of the old backend template engine.

package/assets/style-catalog.json

@@ -0,0 +1,71 @@
+{
+  "single_table_jump": {
+    "id": "single_table_jump",
+    "label": "单表跳转模板",
+    "description": "单表跳转页面，使用单表 form 和跳转列表模板。",
+    "templateFiles": {
+      "api": "api.md",
+      "options": "options.md",
+      "form": "单主表单跳转方式.md",
+      "list": "主子表单跳转列表.md",
+      "menuSql": "权限菜单V2025001.md"
+    },
+    "runtime": {
+      "supported": true,
+      "templateDir": "assets/templates/single_table_jump",
+      "files": {
+        "api": "api.tpl",
+        "options": "options.tpl",
+        "form": "form.tpl",
+        "list": "index.tpl",
+        "menuSql": "menu.sql.tpl"
+      }
+    }
+  },
+  "single_table_dialog": {
+    "id": "single_table_dialog",
+    "label": "单表弹窗模板",
+    "description": "单表弹窗页面，使用弹窗 form 和通用表格模板。",
+    "templateFiles": {
+      "api": "api.md",
+      "options": "options.md",
+      "form": "表单V2025001.md",
+      "list": "表格V2025001.md",
+      "menuSql": "权限菜单V2025001.md"
+    },
+    "runtime": {
+      "supported": true,
+      "templateDir": "assets/templates/single_table_dialog",
+      "files": {
+        "api": "api.tpl",
+        "options": "options.tpl",
+        "form": "form.tpl",
+        "list": "index.tpl",
+        "menuSql": "menu.sql.tpl"
+      }
+    }
+  },
+  "master_child_jump": {
+    "id": "master_child_jump",
+    "label": "主子表前端跳转类型",
+    "description": "主子表跳转页面，使用主子表 form 和主子表列表模板。",
+    "templateFiles": {
+      "api": "api.md",
+      "options": "options.md",
+      "form": "主子表单跳转方式.md",
+      "list": "主子表单跳转列表.md",
+      "menuSql": "权限菜单V2025001.md"
+    },
+    "runtime": {
+      "supported": true,
+      "templateDir": "assets/templates/master_child_jump",
+      "files": {
+        "api": "api.tpl",
+        "options": "options.tpl",
+        "form": "form.tpl",
+        "list": "index.tpl",
+        "menuSql": "menu.sql.tpl"
+      }
+    }
+  }
+}

package/assets/templates/master_child_jump/api.tpl

@@ -0,0 +1,49 @@
+import request from '/@/utils/request';
+
+export function fetchList(query?: object) {
+  return request({
+    url: '/{{API_PATH}}/page',
+    method: 'get',
+    params: query,
+  });
+}
+
+export function addObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'post',
+    data: obj,
+  });
+}
+
+export function getObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}/details',
+    method: 'get',
+    params: obj,
+  });
+}
+
+export function delObjs(ids?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'delete',
+    data: ids,
+  });
+}
+
+export function putObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'put',
+    data: obj,
+  });
+}
+
+export function delChildObj(ids?: object) {
+  return request({
+    url: '/{{API_PATH}}/child',
+    method: 'delete',
+    data: ids,
+  });
+}

package/assets/templates/master_child_jump/form.tpl

@@ -0,0 +1,130 @@
+<template>
+  <div class="layout-padding-auto layout-padding-view">
+    <el-card shadow="never">
+      <template #header>
+        <span>{{ form.{{PK_ATTR}} ? (detail ? 'Detail' : 'Edit') : 'Add' }}</span>
+      </template>
+      <el-form ref="dataFormRef" :model="form" :rules="dataRules" :disabled="detail" v-loading="loading">
+        <el-row :gutter="24">
+{{FORM_FIELDS}}
+        </el-row>
+        <el-row :gutter="24">
+          <sc-form-table v-model="form.{{CHILD_LIST_NAME}}" :addTemplate="childTemp" @delete="deleteChild" placeholder="No data">
+{{CHILD_TABLE_COLUMNS}}
+          </sc-form-table>
+        </el-row>
+      </el-form>
+      <div class="dialog-footer" style="text-align: right; margin-top: 18px;">
+        <el-button @click="handleBack">Cancel</el-button>
+        <el-button type="primary" @click="onSubmit" :disabled="loading">Confirm</el-button>
+      </div>
+    </el-card>
+  </div>
+</template>
+
+<script setup lang="ts" name="{{CLASS_NAME}}Form">
+import mittBus from '/@/utils/mitt';
+import { useMessage } from '/@/hooks/message';
+import { getObj, addObj, putObj, delChildObj } from '/@/api/{{API_MODULE_PATH}}';
+{{DICT_IMPORT_BLOCK}}
+
+const scFormTable = defineAsyncComponent(() => import('/@/components/FormTable/index.vue'));
+const route = useRoute();
+const router = useRouter();
+
+const dataFormRef = ref();
+const loading = ref(false);
+const detail = ref(false);
+
+const form = reactive({
+{{FORM_DEFAULTS}}
+  {{CHILD_LIST_NAME}}: [],
+});
+
+const childTemp = reactive({
+{{CHILD_TEMP_DEFAULTS}}
+});
+
+const dataRules = ref({
+{{FORM_RULES}}
+});
+
+const get{{CLASS_NAME}}Data = async (id: string) => {
+  try {
+    loading.value = true;
+    const { data } = await getObj({ {{PK_ATTR}}: id });
+    Object.assign(form, data[0] || {});
+  } catch (error) {
+    useMessage().error('Failed to fetch data');
+  } finally {
+    loading.value = false;
+  }
+};
+
+const resetFormState = () => {
+  Object.assign(form, {
+{{FORM_DEFAULTS}}
+    {{CHILD_LIST_NAME}}: [],
+  });
+  nextTick(() => {
+    dataFormRef.value?.resetFields();
+    form.{{CHILD_LIST_NAME}} = [];
+  });
+};
+
+const initPage = async () => {
+  const id = route.query.id as string;
+  const isDetail = route.query.detail === 'true' || route.query.detail === '1';
+
+  detail.value = isDetail;
+  resetFormState();
+
+  if (id) {
+    form.{{PK_ATTR}} = id;
+    await get{{CLASS_NAME}}Data(id);
+  }
+};
+
+const closeCurrentPage = () => {
+  mittBus.emit('onCurrentContextmenuClick', { contextMenuClickId: 1, ...route });
+};
+
+const handleBack = () => {
+  router.back();
+};
+
+const onSubmit = async () => {
+  loading.value = true;
+
+  const valid = await dataFormRef.value.validate().catch(() => {});
+  if (!valid) {
+    loading.value = false;
+    return false;
+  }
+
+  try {
+    form.{{PK_ATTR}} ? await putObj(form) : await addObj(form);
+    useMessage().success(form.{{PK_ATTR}} ? 'Updated successfully' : 'Created successfully');
+    closeCurrentPage();
+  } catch (err: any) {
+    useMessage().error(err.msg || 'Submit failed');
+  } finally {
+    loading.value = false;
+  }
+};
+
+const deleteChild = async (obj: { {{CHILD_PK_ATTR}}: string }) => {
+  if (obj.{{CHILD_PK_ATTR}}) {
+    try {
+      await delChildObj([obj.{{CHILD_PK_ATTR}}]);
+      useMessage().success('Deleted successfully');
+    } catch (err: any) {
+      useMessage().error(err.msg || 'Delete failed');
+    }
+  }
+};
+
+onMounted(() => {
+  initPage();
+});
+</script>

package/assets/templates/master_child_jump/index.tpl

@@ -0,0 +1,99 @@
+<template>
+  <div class="layout-padding">
+    <div class="layout-padding-auto layout-padding-view">
+      <el-row>
+        <div class="mb8" style="width: 100%">
+          <el-button icon="folder-add" type="primary" class="ml10" v-auth="'{{PERMISSION_PREFIX}}_add'" @click="handleCreate">新增</el-button>
+          <el-button plain icon="upload-filled" type="primary" class="ml10" v-auth="'{{PERMISSION_PREFIX}}_add'" @click="excelUploadRef.show()">导入</el-button>
+          <el-button plain :disabled="multiple" icon="Delete" type="primary" v-auth="'{{PERMISSION_PREFIX}}_del'" @click="handleDelete(selectObjs)">删除</el-button>
+          <right-toolbar v-model:showSearch="showSearch" :export="'{{PERMISSION_PREFIX}}_export'" @exportExcel="exportExcel" @queryTable="getDataList" class="ml10 mr20" style="float: right;" />
+        </div>
+      </el-row>
+
+      <el-table
+        :data="state.dataList"
+        v-loading="state.loading"
+        border
+        :cell-style="tableStyle.cellStyle"
+        :header-cell-style="tableStyle.headerCellStyle"
+        @selection-change="selectionChangeHandle"
+        @sort-change="sortChangeHandle"
+      >
+        <el-table-column type="selection" width="40" align="center" />
+        <el-table-column type="index" label="#" width="40" />
+{{TABLE_COLUMNS}}
+        <el-table-column label="操作" width="220">
+          <template #default="scope">
+            <el-button text type="primary" icon="view" v-auth="'{{PERMISSION_PREFIX}}_view'" @click="handleDetail(scope.row.{{PK_ATTR}})">查看</el-button>
+            <el-button icon="edit-pen" text type="primary" v-auth="'{{PERMISSION_PREFIX}}_edit'" @click="handleEdit(scope.row.{{PK_ATTR}})">编辑</el-button>
+            <el-button icon="delete" text type="primary" v-auth="'{{PERMISSION_PREFIX}}_del'" @click="handleDelete([scope.row.{{PK_ATTR}}])">删除</el-button>
+          </template>
+        </el-table-column>
+      </el-table>
+
+      <pagination @size-change="sizeChangeHandle" @current-change="currentChangeHandle" v-bind="state.pagination" />
+    </div>
+
+    <upload-excel ref="excelUploadRef" title="导入" url="/{{API_PATH}}/import" temp-url="/admin/sys-file/local/file/{{FUNCTION_NAME}}.xlsx" @refreshDataList="getDataList" />
+  </div>
+</template>
+
+<script setup lang="ts" name="system{{CLASS_NAME}}">
+import { BasicTableProps, useTable } from '/@/hooks/table';
+import { fetchList, delObjs } from '/@/api/{{API_MODULE_PATH}}';
+import { useMessage, useMessageBox } from '/@/hooks/message';
+{{DICT_IMPORT_BLOCK}}
+const router = useRouter();
+
+const excelUploadRef = ref();
+const queryRef = ref();
+const showSearch = ref(true);
+const selectObjs = ref([]) as any;
+const multiple = ref(true);
+
+const state: BasicTableProps = reactive<BasicTableProps>({
+  queryForm: {},
+  pageList: fetchList,
+});
+
+const { getDataList, currentChangeHandle, sizeChangeHandle, sortChangeHandle, downBlobFile, tableStyle } = useTable(state);
+
+const getFormPath = () => '/{{VIEW_MODULE_PATH}}/form';
+
+const handleCreate = () => {
+  router.push({ path: getFormPath(), query: { tagsViewName: '新增' } });
+};
+
+const handleDetail = (id: string) => {
+  router.push({ path: getFormPath(), query: { id, detail: '1', tagsViewName: '查看' } });
+};
+
+const handleEdit = (id: string) => {
+  router.push({ path: getFormPath(), query: { id, tagsViewName: '编辑' } });
+};
+
+const exportExcel = () => {
+  downBlobFile('/{{API_PATH}}/export', { ...state.queryForm, ids: selectObjs.value }, '{{FUNCTION_NAME}}.xlsx');
+};
+
+const selectionChangeHandle = (objs: { {{PK_ATTR}}: string }[]) => {
+  selectObjs.value = objs.map((item) => item.{{PK_ATTR}});
+  multiple.value = !objs.length;
+};
+
+const handleDelete = async (ids: string[]) => {
+  try {
+    await useMessageBox().confirm('此操作将永久删除');
+  } catch {
+    return;
+  }
+
+  try {
+    await delObjs(ids);
+    getDataList();
+    useMessage().success('删除成功');
+  } catch (err: any) {
+    useMessage().error(err.msg || '删除失败');
+  }
+};
+</script>

package/assets/templates/master_child_jump/menu.sql.tpl

@@ -0,0 +1,21 @@
+-- Do not execute directly. Review parent menu id and tenant settings before import.
+-- Suggested default parent_id: -1
+-- Generated by worsoft-codegen-local on {{GENERATED_AT}}
+
+insert into sys_menu (menu_id, parent_id, path, permission, menu_type, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID}}, '-1', '/{{MENU_ROUTE_PATH}}/index', '', '0', 'icon-bangzhushouji', '0', null, '8', null, '{{TABLE_COMMENT}}管理', 1);
+
+insert into sys_menu (menu_id, parent_id, permission, menu_type, path, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID_PLUS_1}}, {{MENU_BASE_ID}}, '{{PERMISSION_PREFIX}}_view', '1', null, '1', '0', null, '0', null, '{{TABLE_COMMENT}}查看', 1);
+
+insert into sys_menu (menu_id, parent_id, permission, menu_type, path, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID_PLUS_2}}, {{MENU_BASE_ID}}, '{{PERMISSION_PREFIX}}_add', '1', null, '1', '0', null, '1', null, '{{TABLE_COMMENT}}新增', 1);
+
+insert into sys_menu (menu_id, parent_id, permission, menu_type, path, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID_PLUS_3}}, {{MENU_BASE_ID}}, '{{PERMISSION_PREFIX}}_edit', '1', null, '1', '0', null, '2', null, '{{TABLE_COMMENT}}修改', 1);
+
+insert into sys_menu (menu_id, parent_id, permission, menu_type, path, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID_PLUS_4}}, {{MENU_BASE_ID}}, '{{PERMISSION_PREFIX}}_del', '1', null, '1', '0', null, '3', null, '{{TABLE_COMMENT}}删除', 1);
+
+insert into sys_menu (menu_id, parent_id, permission, menu_type, path, icon, del_flag, create_time, sort_order, update_time, name, tenant_id)
+values ({{MENU_BASE_ID_PLUS_5}}, {{MENU_BASE_ID}}, '{{PERMISSION_PREFIX}}_export', '1', null, '1', '0', null, '4', null, '导入导出', 1);

package/assets/templates/master_child_jump/options.tpl

@@ -0,0 +1,10 @@
+/**
+ * Local codegen metadata for {{TABLE_NAME}}
+ */
+export const dataMasterEntity = {
+{{OPTIONS_FIELDS}}
+};
+
+export const filterTypes = {
+{{FILTER_TYPES}}
+};

package/assets/templates/single_table_dialog/api.tpl

@@ -0,0 +1,41 @@
+import request from '/@/utils/request';
+
+export function fetchList(query?: object) {
+  return request({
+    url: '/{{API_PATH}}/page',
+    method: 'get',
+    params: query,
+  });
+}
+
+export function addObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'post',
+    data: obj,
+  });
+}
+
+export function getObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}/details',
+    method: 'get',
+    params: obj,
+  });
+}
+
+export function delObjs(ids?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'delete',
+    data: ids,
+  });
+}
+
+export function putObj(obj?: object) {
+  return request({
+    url: '/{{API_PATH}}',
+    method: 'put',
+    data: obj,
+  });
+}