#!/usr/bin/env python3 # -*- coding: utf-8 -*- """`new-page.sh` 的生成器:按「契约 + DDL」生成前端三件套。 🔴 **为什么要有它**(HANDOFF §3 批次 12 交付物 ②): 「加一个业务模块」在前端要碰 **3 处**(api 文件 / view 页面 / App.tsx 路由), 全靠手抄模板 ⇒ 抄漏一处就是「页面 404」「列表永远空」「解构 undefined」, 而且**只在运行时才炸**。而这两处的真源本来都是机器可读的: · `docs/contract.md` 的 `[MODULE]` 区段 ⇒ `urlAddress`(= Route path)、`apiFile` · 表 DDL(`db/schema.sql` 或 `packs//schema/*.sql`)⇒ 列清单 ⇒ 直接从真源生成,**不猜**。契约里没有的模块直接拒绝生成(先登记契约)。 🔴 **幂等**:目标文件已存在 ⇒ 默认**不覆盖**(要覆盖加 `--force`); App.tsx 的路由按 `path="/"` 判重 ⇒ 重复跑不会加出两条路由。 用法(正常从 `new-page.sh` 进来): python3 scripts/new-page-gen.py [--force] [--dry-run] """ import glob import io import os import re import sys SCRIPTS = os.path.dirname(os.path.abspath(__file__)) ROOT = os.path.dirname(SCRIPTS) sys.path.insert(0, SCRIPTS) import contract_expect as CE # noqa: E402 (同目录,纯标准库) FE = os.path.join(ROOT, "src", "frontend") # 🔴 **平台列**:不属于业务字段,生成的表单/表格里**不出现**。 # `f_id` 是主键(列表里要给 `key`、删除要给 `id`,但不进表单)。 PLATFORM_COLS = { "f_id", "f_tenant_id", "f_delete_mark", "f_creator_user_id", "f_creator_time", "f_last_modify_user_id", "f_last_modify_time", "f_flow_id", "f_flow_state", } def die(msg): sys.stderr.write("new-page-gen: %s\n" % msg) sys.exit(2) # ---------------------------------------------------------------- 读契约 def _sections(): """契约各区段(进程内缓存一次;`load_sections` 每次都读文件+校验,别调两遍)。""" global _SECS if _SECS is None: try: _SECS = CE.load_sections() except CE.ContractError as exc: die("读契约失败:%s" % exc) return _SECS _SECS = None def module_row(app, entity): """从契约 `[MODULE]` 取该模块那一行(dict,列名见 `contract_expect.SCHEMAS`)。""" for r in _sections().get("MODULE", []): if r.get("app") == app and r.get("entity") == entity: return r return None def menu_full_name(menu_id): """菜单 id ⇒ 菜单全名(页面标题用)。 🔴 **不是猜的**:`[MODULE].menuId` 指向 `[MENU]` 的一行,那一行有 `fullName`。 生成器拿它当页面标题 ⇒ 标题与菜单**天然一致**,不会出现 「菜单叫『数据资源』、页面标题叫 DataResource」这种割裂。 """ for r in _sections().get("MENU", []): if r.get("id") == menu_id: return r.get("fullName") or "" return "" # ---------------------------------------------------------------- 找 DDL def ddl_block(table): """在**所有可能的位置**找建表块:平台 schema.sql → 各业务包 schema/*.sql。 🔴 两处都要找(批次 12 交付物 ③):业务表的 DDL 已经搬进 `packs//schema/`, 只查平台 `schema.sql` ⇒ 新加的表一律「找不到」⇒ 生成器会误报「没有这张表」。 """ cands = [os.path.join(ROOT, "src", "backend", "db", "schema.sql")] cands += sorted(glob.glob(os.path.join(ROOT, "packs", "*", "schema", "*.sql"))) pat = re.compile(r"^CREATE TABLE (?:IF NOT EXISTS )?%s\s*\(" % re.escape(table)) for path in cands: if not os.path.isfile(path): continue lines = io.open(path, encoding="utf-8").read().split("\n") for i, ln in enumerate(lines): if pat.match(ln): blk = [] for ln2 in lines[i:]: blk.append(ln2) if ln2.startswith(");"): break return "\n".join(blk), path return None, None def ddl_columns(block): """建表块 ⇒ [(列名, SQL 类型)],**滤掉表级约束**(PRIMARY KEY / UNIQUE / …)。 🔴 必须滤:官方风格的主键是表级约束 `PRIMARY KEY (f_id, f_tenant_id)`, 不过滤会被当成一个叫 `PRIMARY` 的列 ⇒ 生成的表单里多一个乱字段。 """ cols = [] for ln in block.split("\n"): m = re.match(r"^\s{2}([A-Za-z_][A-Za-z0-9_]*)\s+([A-Za-z_][A-Za-z0-9_()\s,]*?)\s*(?:,)?$", ln) if not m: continue name = m.group(1) if name.lower() in ("primary", "unique", "constraint", "foreign", "check", "key", "index"): continue cols.append((name, m.group(2).strip())) return cols def ts_type(sql_type): """SQL 类型 ⇒ (TS 类型, 输入框类型)。""" t = sql_type.upper() if "INT" in t or "NUMERIC" in t or "DECIMAL" in t or "REAL" in t or "DOUBLE" in t: return "number", "number" if "TIMESTAMP" in t or "DATE" in t: return "string", "datetime-local" return "string", "text" # ---------------------------------------------------------------- 生成 def pascal(s): return "".join(p[:1].upper() + p[1:] for p in re.split(r"[^A-Za-z0-9]+", s) if p) def camel(s): p = pascal(s) return p[:1].lower() + p[1:] def plural(word): """自然英语复数(与 check-module.sh 的 `plural()` **必须一致**)。 🔴 两边不一致 ⇒ 生成 `listDataResources` 而尺子找 `listDataResource s` 之外的写法 ⇒ 尺子报「缺 export」而文件明明有。改这里请同步 `check-module.sh`。 """ w = word if re.search(r"(s|x|ch|sh)$", w): return w + "es" if re.search(r"(ay|ey|oy|uy)$", w): return w + "s" if w.endswith("y"): return w[:-1] + "ies" return w + "s" API_TPL = """import request from './request'; // {ENT} 业务 API —— 端点对应后端 `api/ssw/{app}/{ENT}/{{List|Save|Delete}}`(面 A)。 // // 🔴 本文件由 `scripts/new-page.sh {app} {ENT}` 生成(真源 = 契约 [MODULE] + 表 DDL)。 // 生成后**归业务所有**:可以直接改(加参数、改返回类型)——重跑生成器会跳过已存在的文件。 export const {listFn} = () => request.get('/ssw/{url}/List'); export const {saveFn} = (dto: any) => request.post('/ssw/{url}/Save', dto); export const {delFn} = (id: string) => request.delete(`/ssw/{url}/Delete?id=${{id}}`); """ VIEW_TPL = """import {{ useEffect, useState }} from 'react'; import {{ {listFn}, {saveFn}, {delFn} }} from '../api/{apifile}'; import {{ wrap, card, btn, btnDanger, input as inputStyle, tableStyle, th, td }} from './ui'; // 🔴 由 `scripts/new-page.sh {app} {ENT}` 生成:字段来自表 `{table}` 的 DDL, // 平台列(f_id / f_tenant_id / f_delete_mark / f_creator_* …)已经滤掉。 // `label` 暂时等于列名 —— **中文标签请按业务改**(生成器不可能猜出业务语义)。 // ⚠️ 字段名用**去前缀**名(`f_name` ⇒ `name`):后端 Jackson 会剥掉 `f_` 前缀。 interface Row {{ id: string; {ts_fields} }} const FIELDS: Array<{{ key: keyof Row; label: string; type: string }}> = [ {field_defs} ]; const EMPTY: Record = {{ {empty_defs} }}; export default function {ENT}() {{ const [items, setItems] = useState([]); const [form, setForm] = useState>(EMPTY); async function load() {{ const data = await {listFn}(); setItems(data || []); }} useEffect(() => {{ load(); }}, []); function update(k: string, v: string) {{ setForm((f) => ({{ ...f, [k]: v }})); }} async function add() {{ const dto: Record = {{}}; for (const f of FIELDS) {{ const raw = form[f.key as string]; if (raw === undefined || raw === '') continue; dto[f.key as string] = f.type === 'number' ? Number(raw) : raw; }} await {saveFn}(dto); setForm(EMPTY); load(); }} async function del(id: string) {{ await {delFn}(id); load(); }} return (

{title}

{{FIELDS.map((f) => ( update(f.key as string, e.target.value)}} placeholder={{f.label}} style={{inputStyle}} /> ))}}
{{FIELDS.map((f) => ( ))}} {{items.map((it) => ( {{FIELDS.map((f) => ( ))}} ))}} {{items.length === 0 && ( )}}
{{f.label}} 操作
{{String(it[f.key] ?? '')}}
暂无数据
); }} """ def gen_api(app, ent, url, apifile): return API_TPL.format( app=app, ENT=ent, url=url, apifile=apifile, listFn="list" + plural(ent), saveFn="save" + ent, delFn="delete" + ent, ) def gen_view(app, ent, table, cols, apifile, title): biz = [(c, t) for (c, t) in cols if c not in PLATFORM_COLS] ts_lines = [] field_defs = [] empty_defs = [] for name, sql_t in biz: key = name[2:] if name.startswith("f_") else name tst, input_type = ts_type(sql_t) ts_lines.append(" %s?: %s;" % (key, tst)) field_defs.append(" { key: '%s', label: '%s', type: '%s' }," % (key, key, input_type)) empty_defs.append(" %s: ''," % key) if not empty_defs: empty_defs.append(" id: '',") return VIEW_TPL.format( app=app, ENT=ent, table=table, title=title or ent, apifile=os.path.basename(apifile)[:-3], listFn="list" + plural(ent), saveFn="save" + ent, delFn="delete" + ent, ts_fields="\n".join(ts_lines) if ts_lines else " name?: string;", field_defs="\n".join(field_defs) if field_defs else " { key: 'name', label: 'name', type: 'text' },", empty_defs="\n".join(empty_defs), ) def patch_app(ent, url, dry): """把 import + 插进 App.tsx(幂等:按 path 判重)。 返回 (是否需要改, 新内容)。 """ path = os.path.join(FE, "src", "App.tsx") src = io.open(path, encoding="utf-8").read() if re.search(r'path="/%s"' % re.escape(url), src): return False, src out = src imp = "import %s from './views/%s';\n" % (ent, ent) if imp not in out: # 插在**最后一个** `import X from './views/...';` 之后 —— 视图 import 聚在一起 anchors = list(re.finditer(r"(?m)^import \w+ from '\./views/[\w]+';\n", out)) if anchors: at = anchors[-1].end() else: # 没有视图 import(新项目)⇒ 插在最后一个 import 之后 anchors = list(re.finditer(r"(?m)^import .+;\n", out)) at = anchors[-1].end() if anchors else 0 out = out[:at] + imp + out[at:] block = ( " \n" " <%s />\n" " \n" " }\n" " />\n" % (url, ent) ) m = re.search(r"(?m)^(\s*)", out) if not m: die("App.tsx 里找不到 ,无法插入路由") out = out[: m.start()] + block + out[m.start():] return True, out def write_file(path, content, force, dry): exists = os.path.isfile(path) tag = "覆盖" if (exists and force) else ("跳过(已存在)" if exists else "新建") if exists and not force: print(" ⏭ %s %s" % (os.path.relpath(path, ROOT), tag)) return False if dry: print(" ✏️ %s %s(--dry-run,未落盘)" % (os.path.relpath(path, ROOT), tag)) return True os.makedirs(os.path.dirname(path), exist_ok=True) with io.open(path, "w", encoding="utf-8") as fh: fh.write(content) print(" ✅ %s %s" % (os.path.relpath(path, ROOT), tag)) return True def main(argv): force = "--force" in argv dry = "--dry-run" in argv args = [a for a in argv if not a.startswith("--")] if len(args) != 2: die("用法: new-page.sh [--force] [--dry-run]") app, ent = args if not os.path.isdir(FE): die("本仓没有 src/frontend(后端-only)⇒ 不需要生成前端三件套") row = module_row(app, ent) if row is None: die( "契约 [MODULE] 里没有 %s:%s —— 先在 docs/contract.md 附录 A 登记," "再跑本脚本(生成器的期望值全部来自契约,不猜)。" % (app, ent) ) url = row.get("urlAddress") or "" apifile = row.get("apiFile") or "" table = row.get("table") or "" if not url or not table: die("契约里 %s:%s 的 urlAddress / table 是空的,先补齐" % (app, ent)) if apifile != "有": print( " ⏭ %s:%s 的 apiFile = %s ⇒ 走「view 直连」分支," "**不生成** api 文件(这是契约的选择,不是遗漏)" % (app, ent, apifile or "空") ) block, ddl_at = ddl_block(table) if block is None: die("所有 DDL 里都没有表 %s(db/schema.sql 与 packs/*/schema/*.sql 都查过)" % table) cols = ddl_columns(block) if not cols: die("表 %s 的建表块里没解析出列(DDL 写法变了?)" % table) lc = ent.lower() # 🔴 与 check-module.sh 的 `lower "$ENT"` 一致(多词实体也是全小写) api_path = os.path.join(FE, "src", "api", lc + ".ts") view_path = os.path.join(FE, "src", "views", ent + ".tsx") print("生成 %s:%s(urlAddress=%s,表=%s @ %s)" % (app, ent, url, table, os.path.relpath(ddl_at, ROOT))) if apifile == "有": write_file(api_path, gen_api(app, ent, url, lc + ".ts"), force, dry) write_file(view_path, gen_view(app, ent, table, cols, lc + ".ts", menu_full_name(row.get("menuId") or "")), force, dry) changed, new_src = patch_app(ent, url, dry) app_path = os.path.join(FE, "src", "App.tsx") if not changed: print(" ⏭ %s 已有 path=\"/%s\"" % (os.path.relpath(app_path, ROOT), url)) elif dry: print(" ✏️ %s 会插入 (--dry-run,未落盘)" % (os.path.relpath(app_path, ROOT), url)) else: with io.open(app_path, "w", encoding="utf-8") as fh: fh.write(new_src) print(" ✅ %s 插入 " % (os.path.relpath(app_path, ROOT), url)) print("\n下一步:bash scripts/check-module.sh %s %s (确认 3 个前端接触点转绿)" % (app, ent)) return 0 if __name__ == "__main__": sys.exit(main(sys.argv[1:]))