mcp-feature-doc-generator 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@ import { z } from "zod";
5
5
  import { collectFeatureDocContext } from "./analysis/feature-context.js";
6
6
  import { PROMPT_DESCRIPTION, PROMPT_NAME, buildPromptMessages, } from "./prompts/generate-feature-doc.js";
7
7
  import { getTemplateContent } from "./resources/template.js";
8
- const SERVER_VERSION = "1.0.4";
8
+ const SERVER_VERSION = "1.0.6";
9
9
  const FEATURE_PATH_DESCRIPTION = "功能路径,如 project/pmbasupplierevaluation 或 pm/ba/PmBaRentcontractSettle";
10
10
  const server = new McpServer({
11
11
  name: "feature-doc-generator",
@@ -238,6 +238,92 @@ export function buildPromptMessages(featurePath) {
238
238
 
239
239
  ---
240
240
 
241
+ ## 流程节点字段控制输出规则
242
+ 若功能中存在**体现当前业务语义的特殊流程节点字段控制**,可在“核心业务逻辑”章节中增加相关小节进行说明。
243
+
244
+ ### 输出形式
245
+ 统一使用以下格式:
246
+
247
+ ### 4.x 流程节点字段控制
248
+
249
+ 先用一段简要文字说明:根据功能类型、流程状态、节点标识或页面模式,对不同业务区域、字段分组或操作区域的显示、禁用、可编辑性进行动态控制。
250
+
251
+ 随后使用条件对照表展示,优先体现:
252
+
253
+ - 不同流程节点下各业务区域的可编辑性
254
+ - 不同状态下字段区域的显示 / 隐藏
255
+ - 不同功能模式下的禁用控制
256
+ - 查看态、编辑态、审批态之间的差异
257
+
258
+ ### 示例
259
+
260
+ ### 4.6 流程节点字段控制
261
+
262
+ 根据功能类型和工作流状态动态控制各区域的显示与禁用:
263
+
264
+ | 条件 | 员工信息区域可编辑 | 合同信息区域可编辑 |
265
+ | ---- | ------------------ | ------------------ |
266
+ | 提交类功能 | ✓ | ✓ |
267
+ | 流程类功能 + 编辑中状态 | ✓ | ✗ |
268
+ | 流程类功能 + userTask2 节点 | ✗ | ✓ |
269
+ | 流程类功能 + 非 userTask2 节点 | ✗ | ✗ |
270
+ | 查看模式 | ✗ | ✗ |
271
+
272
+ ### 适用条件
273
+ 仅当代码中存在**当前功能特有的流程节点字段控制逻辑**时,才允许输出该小节,例如:
274
+
275
+ - 不同节点控制不同业务区域的可编辑性
276
+ - 某些字段或区域仅在指定流程节点开放
277
+ - 不同审批阶段对应不同字段处理权限
278
+ - 节点变化会直接影响当前功能的数据录入范围或业务处理方式
279
+
280
+ ### 过滤要求
281
+ 以下情况不单独输出“流程节点字段控制”小节:
282
+
283
+ - 仅存在项目通用流程组件控制
284
+ - 仅存在通用查看态 / 编辑态切换
285
+ - 仅存在统一的整页禁用控制,而无当前功能特有业务语义
286
+ - 仅体现项目公共工作流机制,未体现当前功能独有节点规则
287
+
288
+ ---
289
+
290
+ ## 引用组件说明输出模板
291
+ “引用组件说明”章节中的组件介绍,统一使用以下格式:
292
+
293
+ ### 6.x 组件名 — 中文功能名
294
+
295
+ 组件简要说明,说明其在当前功能中的用途。关键配置:
296
+
297
+ - **筛选条件**:说明组件的关键过滤条件、限制条件或数据范围
298
+ - **回调处理**:说明选择、确认、变更后触发的回填、联动、刷新、计算等处理逻辑
299
+ - **触发方式**:说明组件在页面中的触发入口,如搜索按钮、选择按钮、弹窗入口、字段点击等
300
+
301
+ ### 输出要求
302
+ - 组件标题格式固定为:${bt}### 6.x 组件名 — 中文功能名${bt}
303
+ - 先写一句组件用途说明,再写“关键配置”要点列表
304
+ - 优先说明与当前业务直接相关的内容,如:
305
+ - 筛选条件
306
+ - 默认参数
307
+ - 回调处理
308
+ - 数据回填
309
+ - 联动逻辑
310
+ - 触发方式
311
+ - 若某项不存在,不强行补齐
312
+ - 不罗列纯 UI 属性、样式属性、通用框架属性
313
+ - 不说明无业务语义的基础组件
314
+
315
+ ### 示例
316
+
317
+ ### 6.1 select-project — 项目选择器
318
+
319
+ 项目选择器组件,用于在表单中选择项目。关键配置:
320
+
321
+ - **筛选条件**:${bt}state: '2'${bt}(仅显示在建项目)
322
+ - **回调处理**:选择项目后通过 ${bt}projectMasterSelectProjectOkHandle${bt} 方法自动回填项目相关信息
323
+ - **触发方式**:点击项目名称输入框右侧的搜索按钮
324
+
325
+ ---
326
+
241
327
  ## 输出规则
242
328
  - 输出到 ${bt}开发规范/views/${bt} 目录下
243
329
  - 保持与源码相同的模块子目录结构
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcp-feature-doc-generator",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "MCP server for generating Vue 3 feature documentation via prompt template",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",