Compare commits

...
1 Commits
Author SHA1 Message Date
wc24 064bc108d7 0.8.0: express 收紧到 ^5;契约副本改为 build 时自动同步
破坏性:peerDependencies.express 从 "^4 || ^5" 收成 "^5"。
buildShrimpRouter 的 router.post("/*path") 是 Express 5 才有的写法,
声明支持 4 一直是假的。devDeps 同步升到 express 5.1 / @types/express 5,32 个测试通过。

契约同步:新增 postbuild,把 src/IShrimpType.ts 覆盖到同级 shrimp-admin 的副本
(scripts/check-admin-contract.mjs;找不到同级仓库就跳过,不影响 CI 与消费侧 prepare)。
起因是那份副本靠人工复制,漂了一整代没人发现——停在旧的 json 类型,
缺 object/array/fields/item/parse/refs,而前端对未注册类型静默回落成 string,
漂移不报错、只悄悄渲染错。

删掉 @contractVersion 版本轴:代码无人读取,且从 1.0.0 起从未移动,
期间契约实际改了好几处,数字全程说谎。副本新不新改由字节比对回答,
消费侧看钉的 tag 即可,版本收敛成 package version 一根轴。
2026-08-10 19:42:52 +08:00
4 changed files with 471 additions and 583 deletions
+426 -574
View File
File diff suppressed because it is too large Load Diff
+5 -4
View File
@@ -1,6 +1,6 @@
{ {
"name": "shrimp-server", "name": "shrimp-server",
"version": "0.7.12", "version": "0.8.0",
"description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)", "description": "Shrimp 框架后端 — 声明式字段驱动的 Node.js 管理后台框架(Express + Mongoose + JWT)",
"main": "dist/main/index.js", "main": "dist/main/index.js",
"types": "dist/main/index.d.ts", "types": "dist/main/index.d.ts",
@@ -18,6 +18,7 @@
], ],
"scripts": { "scripts": {
"build": "tsc -p tsconfig.build.json", "build": "tsc -p tsconfig.build.json",
"postbuild": "node scripts/check-admin-contract.mjs",
"prepare": "tsc -p tsconfig.build.json", "prepare": "tsc -p tsconfig.build.json",
"test": "vitest run", "test": "vitest run",
"test:watch": "vitest", "test:watch": "vitest",
@@ -25,7 +26,7 @@
}, },
"peerDependencies": { "peerDependencies": {
"bcrypt": "^5 || ^6", "bcrypt": "^5 || ^6",
"express": "^4 || ^5", "express": "^5",
"jsonwebtoken": "^8 || ^9", "jsonwebtoken": "^8 || ^9",
"mongoose": "^6 || ^7 || ^8" "mongoose": "^6 || ^7 || ^8"
}, },
@@ -45,11 +46,11 @@
}, },
"devDependencies": { "devDependencies": {
"@types/bcrypt": "^5.0.0", "@types/bcrypt": "^5.0.0",
"@types/express": "^4.17.21", "@types/express": "^5.0.0",
"@types/jsonwebtoken": "^9.0.0", "@types/jsonwebtoken": "^9.0.0",
"@types/node": "^20.0.0", "@types/node": "^20.0.0",
"bcrypt": "^5.1.1", "bcrypt": "^5.1.1",
"express": "^4.19.0", "express": "^5.1.0",
"jsonwebtoken": "^9.0.2", "jsonwebtoken": "^9.0.2",
"mongoose": "^8.0.0", "mongoose": "^8.0.0",
"tsx": "^4.7.0", "tsx": "^4.7.0",
+31
View File
@@ -0,0 +1,31 @@
/**
* build 后把契约同步给同级的 shrimp-admin。
*
* 契约的真身在这边,shrimp-admin 那份是派生物——所以是单向覆盖,跟 codegen 一个性质,
* 不是"两份文件互相对齐"。admin 那份的注释头是它自己的(声明自己是副本),同步时保留。
*
* 只在本地开发时生效:找不到同级 shrimp-admin(CI、别人只 clone 了这个仓库)就跳过。
* 挂在 postbuild 而不是 prepare:消费侧从 git 装本包时跑的是 prepare,不该被这事打扰。
*
* 为什么要自动做:上次靠人工复制,漂了一整代没人发现——
* 副本停在旧的 json 类型、缺 object/array/fields/item/parse/refs,
* 而前端对未注册类型静默回落到 string,漂移不报错、只悄悄渲染错。
*/
import { existsSync } from "node:fs"
import { execFileSync } from "node:child_process"
import { fileURLToPath } from "node:url"
const syncer = fileURLToPath(new URL("../../shrimp-admin/scripts/check-contract.mjs", import.meta.url))
if (!existsSync(syncer)) {
console.log("skip: 同级没有 shrimp-admin,契约副本无从同步")
process.exit(0)
}
try {
execFileSync(process.execPath, [syncer, "--fix"], { stdio: "inherit" })
} catch {
// 同步脚本自己挂了(权限、文件被占)。契约漂着不能当没事发生,让 build 失败。
console.error("❌ 契约副本同步失败,见上方输出")
process.exit(1)
}
+9 -5
View File
@@ -1,12 +1,16 @@
/** /**
* Shrimp 类型契约 — 前后端 wire protocol 定义 * Shrimp 类型契约 — 前后端 wire protocol 定义
* *
* @contractVersion 1.0.0 * 这份是契约本身。shrimp-admin/src/IShrimpType.ts 是它的副本,
* 由本仓库 postbuild 自动覆盖过去(scripts/check-admin-contract.mjs),不用手工同步。
* *
* 改动此文件需要: * 改动此文件 = 改 wire protocol,所以:
* 1. 升 @contractVersion(语义化版本) * 1. 发版升 package version(0.x 里破坏性改动升 minor),消费侧按 tag 钉包
* 2. 同步到 shrimp-admin/src/IShrimpType.ts,更新其 @syncedFrom * 2. 通知消费侧对齐
* 3. 通知消费侧对齐 *
* 这里原本另有一个 @contractVersion 轴,删了:它从 1.0.0 起没动过,
* 期间契约丢了 json、多了 object/array/fields/item/parse/refs,数字全程说谎。
* 副本新不新改由字节比对回答(shrimp-admin 的 npm run check:contract)。
*/ */
/** 业务错误码 */ /** 业务错误码 */