mvframe 1.0.72 → 1.0.74

package/scripts/scaffold-app.js

@@ -14,6 +14,7 @@
 const fs = require("fs");
 const path = require("path");
 const { execFileSync } = require("child_process");
+const { upsertCodexAgents } = require("./install-codex-agents.js");
 
 const FORCE = process.argv.includes("--force");
 const NO_PKG = process.argv.includes("--no-package-json");
@@ -35,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`。
@@ -164,6 +181,8 @@ function main() {
   }
 
   copyCursorRulesFromPackage();
+  upsertCodexAgents(target);
+  appendGitignoreLines([".env.local", ".env.mvframe-notify"]);
 
   write(
     "src/main.js",
@@ -352,6 +371,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,
   },
@@ -730,6 +755,35 @@ export default defineConfig({
     );
   }
 
+  write(
+    ".env.mvframe-notify.example",
+    `# Copy to .env.mvframe-notify and fill values for the local Node notify service.
+# Do not put DingTalk webhook/secret in src/main.js or other browser-bundled files.
+
+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="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx"
+DINGTALK_SECRET="SECxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+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 雏形已生成
@@ -742,6 +796,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\`。
@@ -776,7 +836,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.example\`：复制为 \`.env.mvframe-notify\`，填写 \`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 打包到浏览器的文件。
 
 ## 目录约定
 
@@ -795,6 +891,16 @@ yarn dev
 | \`src/maps/index.js\` | 与库内置 \`maps/chip\` 深度合并（模块内）；\`useMap().$l()\` / \`mapLangPath\` / \`mapLang\` 可由 auto-import 从 \`mvframe/maps\` 引入 |
 | \`src/composition\` | 可选，与 Vite 别名 \`@cps\` 对应 |
 
+## Codex 规则（\`AGENTS.md\`）
+
+初始化脚本会写入/更新项目根 **\`AGENTS.md\`** 的 MVFrame 区块，供 Codex 在宿主项目内优先使用 **MVFrame 全局组件、全局方法与全局样式工具类**。该区块带有 \`MVFRAME-CODEX-RULES\` 标记，重复执行脚手架会更新这段内容，不会覆盖你在 \`AGENTS.md\` 中的其它规则。
+
+仅安装 Codex 规则：
+
+\`\`\`bash
+yarn exec mvframe-install-codex-rules
+\`\`\`
+
 ## Cursor 规则（\`.cursor/rules\`）
 
 初始化脚本会把 **mvframe 包内**与仓库一致的 **\`*.mdc\`** 写入目标项目 **\`/.cursor/rules/\`**（\`component-hierarchy\`、\`script-setup\`、\`style-system\`、\`views\`、\`router\`、\`global-components\`、\`data\`、\`util\`）。若目录或文件已存在且未加 \`--force\`，则跳过对应文件。