mvframe 1.0.73 → 1.0.75

package/scripts/scaffold-app.js

@@ -36,6 +36,22 @@ function write(rel, content) {
   console.log("[mvframe-init] 写入", rel);
 }
 
+function appendGitignoreLines(lines) {
+  const fp = path.join(target, ".gitignore");
+  const existing = fs.existsSync(fp) ? fs.readFileSync(fp, "utf8") : "";
+  const current = new Set(
+    existing
+      .split(/\r?\n/)
+      .map((line) => line.trim())
+      .filter(Boolean),
+  );
+  const missing = lines.filter((line) => !current.has(line));
+  if (missing.length === 0) return;
+  const prefix = existing && !existing.endsWith("\n") ? "\n" : "";
+  fs.writeFileSync(fp, `${existing}${prefix}${missing.join("\n")}\n`, "utf8");
+  console.log("[mvframe-init] 已更新 .gitignore");
+}
+
 /**
  * 将本包 `.cursor/rules/*.mdc` 复制到目标工程，与 mvframe 仓库内 Cursor 规则保持一致。
  * 发布包需在 `package.json` 的 `files` 中包含 `.cursor/rules`。
@@ -83,6 +99,11 @@ const SCAFFOLD_SCRIPTS = {
   preview: "vite preview",
 };
 
+const TEST_DINGTALK_WEBHOOK =
+  "https://oapi.dingtalk.com/robot/send?access_token=142b6ddc73e8656b7906a3cb3982836a59f430a6fe5ef619a5689eed91d5f9f7";
+const TEST_DINGTALK_SECRET =
+  "SEC7140677a84a5190046e22d508548923dd2c4f485e38896aa0c3555ae003f4ef5";
+
 /**
  * 合并 package.json：保留原有字段与其它依赖；仅补足脚手架所需包与启动脚本。
  * 同名依赖以目标项目已有版本为准（{ ...建议, ...已有 }）。
@@ -166,6 +187,7 @@ function main() {
 
   copyCursorRulesFromPackage();
   upsertCodexAgents(target);
+  appendGitignoreLines([".env.local", ".env.mvframe-notify"]);
 
   write(
     "src/main.js",
@@ -354,6 +376,12 @@ export default {
     // url: "//at.alicdn.com/t/c/your_font.js",
     // prefix: "ant",
   },
+  notify: {
+    enabled: true,
+    endpoint: import.meta.env.VITE_MVFRAME_NOTIFY_ENDPOINT || "http://127.0.0.1:3300",
+    token: import.meta.env.VITE_MVFRAME_NOTIFY_TOKEN || "",
+    timeout: 5000,
+  },
   table: {
     summaryMetric: null,
   },
@@ -732,6 +760,56 @@ export default defineConfig({
     );
   }
 
+  write(
+    ".env.mvframe-notify.example",
+    `# Copy to .env.mvframe-notify for the local Node notify service.
+# Do not put DingTalk webhook/secret in src/main.js or other browser-bundled files.
+# The DingTalk values below are MVFrame's test robot config. Replace them for production.
+
+MVFRAME_NOTIFY_PORT=3300
+MVFRAME_NOTIFY_HOST=127.0.0.1
+MVFRAME_NOTIFY_TOKEN=
+MVFRAME_NOTIFY_TIMEOUT_MS=5000
+MVFRAME_NOTIFY_CORS_ORIGIN=*
+
+DINGTALK_WEBHOOK="${TEST_DINGTALK_WEBHOOK}"
+DINGTALK_SECRET="${TEST_DINGTALK_SECRET}"
+DINGTALK_AT_MOBILES=""
+DINGTALK_AT_USER_IDS=""
+DINGTALK_AT_ALL=""
+`,
+  );
+
+  write(
+    ".env.mvframe-notify",
+    `# Local MVFrame DingTalk notify service config.
+# This file is generated for test use and is ignored by git.
+# Replace the DingTalk webhook/secret before production use.
+
+MVFRAME_NOTIFY_PORT=3300
+MVFRAME_NOTIFY_HOST=127.0.0.1
+MVFRAME_NOTIFY_TOKEN=
+MVFRAME_NOTIFY_TIMEOUT_MS=5000
+MVFRAME_NOTIFY_CORS_ORIGIN=*
+
+DINGTALK_WEBHOOK="${TEST_DINGTALK_WEBHOOK}"
+DINGTALK_SECRET="${TEST_DINGTALK_SECRET}"
+DINGTALK_AT_MOBILES=""
+DINGTALK_AT_USER_IDS=""
+DINGTALK_AT_ALL=""
+`,
+  );
+
+  write(
+    ".env.local.example",
+    `# Copy to .env.local when you need the browser app to call mvframe-notify.
+# VITE_MVFRAME_NOTIFY_TOKEN should match MVFRAME_NOTIFY_TOKEN in .env.mvframe-notify.
+
+VITE_MVFRAME_NOTIFY_ENDPOINT=http://127.0.0.1:3300
+VITE_MVFRAME_NOTIFY_TOKEN=
+`,
+  );
+
   write(
     "MVFRAME-SCAFFOLD.md",
     `# MVFrame 雏形已生成
@@ -744,6 +822,12 @@ export default defineConfig({
 yarn dev
 \`\`\`
 
+如需同时启动 Vite 与 MVFrame 钉钉通知服务，可显式执行框架命令（与 \`mvframe-b\` 类似由 MVFrame 包提供，不会自动覆盖宿主脚本）：
+
+\`\`\`bash
+yarn exec mvframe-d
+\`\`\`
+
 若需跳过对 \`package.json\` 的修改：\`node scripts/scaffold-app.js --no-package-json\`。
 
 自动生成的 \`vite.config.js\` 已包含 \`unplugin-auto-import\`；\`dts: true\` 时类型默认写在项目根 \`auto-imports.d.ts\`。
@@ -778,7 +862,43 @@ yarn dev
 
 ## 子路径（按需）
 
-发布包 \`exports\` 还提供 \`mvframe/composition\`、\`mvframe/util\`、\`mvframe/store\` 等，业务侧可 \`import { ... } from "mvframe/composition"\` 等，参见包内 \`package.json\` 的 \`exports\`。
+发布包 \`exports\` 还提供 \`mvframe/composition\`、\`mvframe/util\`、\`mvframe/store\`、\`mvframe/notify\` 等，业务侧可 \`import { ... } from "mvframe/composition"\` 等，参见包内 \`package.json\` 的 \`exports\`。
+
+## 钉钉通知（mvframe-notify）
+
+脚手架已初始化：
+
+- \`src/config/index.js\` 的 \`notify\` 节点：浏览器端只保存本地服务地址和访问 token。
+- \`.env.mvframe-notify\` 与 \`.env.mvframe-notify.example\`：已写入 MVFrame 测试钉钉机器人配置，生产环境请替换 \`DINGTALK_WEBHOOK\` / \`DINGTALK_SECRET\`。
+- \`.env.local.example\`：复制为 \`.env.local\`，填写 \`VITE_MVFRAME_NOTIFY_ENDPOINT\` / \`VITE_MVFRAME_NOTIFY_TOKEN\`。
+
+启动通知服务：
+
+\`\`\`bash
+yarn exec mvframe-notify
+\`\`\`
+
+同时启动 Vite 和通知服务：
+
+\`\`\`bash
+yarn exec mvframe-d
+\`\`\`
+
+前端发送：
+
+\`\`\`js
+await globalThis.$notify.send("需要发送到钉钉的消息");
+\`\`\`
+
+或按需导入：
+
+\`\`\`js
+import { notify } from "mvframe/notify";
+
+await notify("需要发送到钉钉的消息");
+\`\`\`
+
+注意：钉钉 webhook / secret 不应写进 \`main.js\`、\`src/config/index.js\` 或任何会被 Vite 打包到浏览器的文件。
 
 ## 目录约定