3棧自動(dòng)生成樣板代碼,終結(jié)手寫(xiě)同步煩惱)
凌晨?jī)牲c(diǎn)我盯著屏幕上那條報(bào)錯(cuò)心里只剩一個(gè)念頭再也不手寫(xiě)樣板代碼了。當(dāng)時(shí)我正在維護(hù)一個(gè)基于 T3 代碼棧Next.js tRPC Prisma Zod的中型項(xiàng)目數(shù)據(jù)模型里的字段從字符串改成了枚舉Prisma 這邊改完忘了同步 tRPC 路由里的 Zod schema。結(jié)果前端提交訂單時(shí)服務(wù)端校驗(yàn)直接把請(qǐng)求給攔了線(xiàn)上反饋接二連三。問(wèn)題不算大但讓我意識(shí)到一個(gè)事實(shí)整個(gè) T3 生態(tài)最引以為傲的端到端類(lèi)型安全恰恰在最容易出錯(cuò)的環(huán)節(jié)——模型、校驗(yàn)、路由、前端類(lèi)型之間的手工同步——把壓力全留給了開(kāi)發(fā)者。我就是為了解決這件事寫(xiě)的 t3code。它是一個(gè)面向 T3 代碼棧的 CLI 代碼生成與同步檢測(cè)工具核心思路是把 Prisma 數(shù)據(jù)模型當(dāng)作唯一事實(shí)來(lái)源自動(dòng)生成 Zod 校驗(yàn) schema、tRPC 路由模板、前端類(lèi)型定義和 API 調(diào)用封裝順帶在 CI 里幫你強(qiáng)制檢查模型改了但代碼沒(méi)跟上的情況。如果你正在用 Next.js 和 tRPC 寫(xiě)全棧應(yīng)用又被重復(fù)的 CRUD 樣板拖得心煩這篇文章應(yīng)該能給你一點(diǎn)實(shí)際的參考。1. T3 代碼棧里的重復(fù)勞動(dòng)從一次半夜事故說(shuō)起T3 代碼棧用著確實(shí)爽路由、數(shù)據(jù)庫(kù)、校驗(yàn)全在 TypeScript 的類(lèi)型系統(tǒng)里閉環(huán)幾乎每個(gè)環(huán)節(jié)都有類(lèi)型兜底。但閉環(huán)不等于自動(dòng)鏈條里所有的連接件都需要你手寫(xiě)去接Prisma 模型定義了數(shù)據(jù)庫(kù)結(jié)構(gòu)Zod 要單獨(dú)寫(xiě)一份輸入校驗(yàn)tRPC 路由里要寫(xiě)查詢(xún)和變更邏輯前端還得自己掛 React Query 的 hook 才能消費(fèi)這些 API。四套代碼描述同一個(gè)實(shí)體任何一處不一致線(xiàn)上就會(huì)給你顏色看。1.1 那一次的線(xiàn)上故障一次字段改名引發(fā)的連鎖反應(yīng)說(shuō)回開(kāi)頭那次事故。業(yè)務(wù)上我需要把訂單的status字段從字符串改成聯(lián)合類(lèi)型PENDING | PAID | SHIPPED | COMPLETED | CANCELLED。Prisma 模型里改枚舉幾分鐘的事數(shù)據(jù)庫(kù)遷移順手做了但 tRPC 路由的入?yún)⑿r?yàn)里對(duì)應(yīng)的 Zod schema 還是老樣子——z.string()。前端按新枚舉提交PAID服務(wù)端校驗(yàn)自然通過(guò)問(wèn)題出在另一個(gè)老接口某個(gè)回調(diào)邏輯還在傳舊字符串paid小寫(xiě)Zod 直接拒絕訂單狀態(tài)更新全部失敗。排查過(guò)程不算難schema 不匹配的報(bào)錯(cuò)一眼就能定位。但這件事讓我真正難受的是這類(lèi)問(wèn)題幾乎不可防。只要模型和校驗(yàn)之間存在手工同步就永遠(yuǎn)存在改了一處、漏了一處的可能。TypeScript 能保證的是同一份代碼里類(lèi)型一致可保證不了不同文件里手寫(xiě)的類(lèi)型定義和數(shù)據(jù)庫(kù)模型一致。一次字段改名的連鎖反應(yīng)大致是這樣修改schema.prisma中Order.status枚舉定義執(zhí)行遷移并重新生成 Prisma Client手改 Zod 校驗(yàn)中的status字段手改 tRPC 路由中的輸出類(lèi)型手改前端對(duì)應(yīng)的類(lèi)型定義和枚舉常量五步里只要漏掉任何一步編譯期大概率不報(bào)錯(cuò)運(yùn)行期才炸。這比編譯錯(cuò)誤可怕得多因?yàn)榫€(xiàn)上反饋有延遲用戶(hù)已經(jīng)遭殃了你才知道。1.2 樣板代碼到底有多少統(tǒng)計(jì)一個(gè)典型 CRUD 模塊后來(lái)我做了一次統(tǒng)計(jì)更堅(jiān)定了要寫(xiě)工具的決心。一個(gè)典型的博客文章資源模塊只算基礎(chǔ) CRUD不加任何業(yè)務(wù)規(guī)則需要手寫(xiě)哪些東西文件/位置大致內(nèi)容手寫(xiě)行數(shù)Prisma modelPost模型的字段、關(guān)系、索引30-50 行Zod schema創(chuàng)建、更新、查詢(xún)參數(shù)的校驗(yàn)80-120 行tRPC routercreatePost、getPost、updatePost、deletePost、列表查詢(xún)150-200 行前端類(lèi)型從后端類(lèi)型手動(dòng)推導(dǎo)或重新聲明40-60 行API 封裝fetch/axios調(diào)用 錯(cuò)誤處理60-100 行React Query hooksuseQuery、useMutation封裝80-120 行加起來(lái)一個(gè)模塊 440-650 行而且是最枯燥、最沒(méi)技術(shù)含量、最容易抄錯(cuò)的那部分。我要說(shuō)句實(shí)話(huà)這種代碼的價(jià)值低到幾乎為零但出錯(cuò)的成本高到離譜。字段多一個(gè)、少一個(gè)類(lèi)型不一致空值處理漏了都是這類(lèi)手寫(xiě)樣板的高發(fā)問(wèn)題。t3code 的第一個(gè)目標(biāo)就是把這些低價(jià)值、高錯(cuò)誤率的樣板代碼從日常開(kāi)發(fā)里拿掉讓你把精力留給真正重要的業(yè)務(wù)邏輯。2. t3code 的設(shè)計(jì)思路與核心取舍寫(xiě)工具之前我先把需求想清楚了。當(dāng)時(shí)市面上一堆低代碼平臺(tái)和可視化搭建看著很美好但你真用在生產(chǎn)項(xiàng)目里就知道生成的東西一復(fù)雜就不可維護(hù)。所以 t3code 的定位從一開(kāi)始就很克制——它不是可視化平臺(tái)不跟你搶業(yè)務(wù)邏輯只是一個(gè)幫你把類(lèi)型同步做好、把樣板補(bǔ)齊的代碼生成器。2.1 為什么是 CLI 而不是 VSCode 插件其實(shí)第一版我也考慮過(guò)做 VSCode 插件那樣保存文件自動(dòng)生成體驗(yàn)更順滑。但后來(lái)我放棄了原因有三CLI 可以進(jìn) CI。插件只能在本地用可模型改了代碼沒(méi)跟上這個(gè)問(wèn)題最應(yīng)該攔截的地方是代碼評(píng)審和 CI 階段。CLI 加一個(gè)check命令誰(shuí)改了 Prisma schema 沒(méi)跑生成CI 直接紅這才是真正的防護(hù)。CLI 不挑編輯器。團(tuán)隊(duì)里有人用 VSCode有人用 JetBrains有人用 Neovim插件方案會(huì)制造工具割裂。CLI 可以串流程。prisma generate t3code generate一條命令鏈解決所有生成問(wèn)題插件做不到這種組合能力。所以最后我選擇了純 CLI 方案npx t3code搞定一切。這也讓工具天然具備腳本化的能力后續(xù)接 CI、接打包鉤子都很方便。2.2 一張表驅(qū)動(dòng)一切以數(shù)據(jù)模型為唯一事實(shí)來(lái)源t3code 最核心的設(shè)計(jì)決策是把 Prisma schema 當(dāng)作唯一事實(shí)來(lái)源其他一切代碼都從這里推導(dǎo)出來(lái)。為什么不從 tRPC router 反推因?yàn)?router 里混著業(yè)務(wù)代碼解析起來(lái)不干凈為什么不搞一個(gè)獨(dú)立的數(shù)據(jù)字典文件因?yàn)槎嘁粋€(gè)文件就多一份約束成本開(kāi)發(fā)者遲早會(huì)忘記維護(hù)。Prisma schema 本身就是團(tuán)隊(duì)的數(shù)據(jù)契約你本來(lái)就要維護(hù)它拿它當(dāng)源頭最省事。整個(gè)生成鏈路是這樣的schema.prisma唯一事實(shí)來(lái)源 ↓ 解析模型字段、枚舉、關(guān)系 Zod schema 生成輸入校驗(yàn)、輸出類(lèi)型 ↓ tRPC router 模板生成自動(dòng)包含 CRUD 基礎(chǔ)實(shí)現(xiàn) ↓ 前端類(lèi)型 API 封裝 React Query hooks這條鏈路解決了一個(gè)核心問(wèn)題同一個(gè)實(shí)體的描述只有一份其他全是推導(dǎo)結(jié)果。Post模型里的title: String生成了 Zod 的z.string()生成了 tRPC 的輸入類(lèi)型生成了前端 hook 的入?yún)㈩?lèi)型天然一致再無(wú)手寫(xiě)同步這回事。2.3 生成策略可覆蓋、可保留、可手動(dòng)接管代碼生成工具最怕什么怕把你手寫(xiě)的代碼覆蓋掉。t3code 的生成策略是三檔自動(dòng)生成文件文件頂部帶// generated by t3code標(biāo)記再次生成時(shí)整體覆蓋。這類(lèi)文件包括 Zod schema、前端類(lèi)型、API 封裝它們本來(lái)就該是純推導(dǎo)結(jié)果你不應(yīng)該手改。半自動(dòng)模板文件t3code 生成 tRPC router 的骨架但用// t3code-preserved-start和// t3code-preserved-end標(biāo)記出保留區(qū)。保留區(qū)里的業(yè)務(wù)代碼在重新生成時(shí)不會(huì)動(dòng)保留區(qū)外的模板部分會(huì)被刷新。這樣既享受生成效率又不犧牲業(yè)務(wù)靈活性。手動(dòng)接管任何文件只要去掉頂部生成標(biāo)記t3code 就再也不碰它。適合那種已經(jīng)被你重度改造、和模板差距太大的文件。這個(gè)設(shè)計(jì)參考了代碼生成領(lǐng)域常見(jiàn)的做法生成器只負(fù)責(zé)生成交接給使用時(shí)要有清晰的邊界。模板代碼和手寫(xiě)代碼混在一個(gè)文件里靠保留區(qū)做隔離是我試過(guò)的最穩(wěn)定的方案。3. 上手實(shí)操?gòu)某跏蓟脚芡ㄒ粋€(gè) CRUD 模塊光聊設(shè)計(jì)理念沒(méi)有用真正好不好用得跑一遍才知道。下面我用一個(gè)具體的例子完整演示怎么用 t3code 從零生成一個(gè)帶 CRUD 的模塊。3.1 安裝與初始化t3code 可以直接通過(guò) npx 使用也可以裝成項(xiàng)目依賴(lài)。我建議裝成 devDependencies保證團(tuán)隊(duì)里所有人版本一致CI 環(huán)境也好復(fù)現(xiàn)pnpm add -D t3code然后執(zhí)行初始化npx t3code init初始化向?qū)?huì)問(wèn)你幾個(gè)問(wèn)題項(xiàng)目路徑、是否啟用 React Query hooks 生成、包管理器類(lèi)型等等。初始化完成后項(xiàng)目根目錄生成一個(gè)t3code.config.tsimport { defineConfig } from t3code; export default defineConfig({ project: ., prismaSchema: prisma/schema.prisma, output: { zod: src/server/schemas, trpc: src/server/routers, client: src/lib/api, hooks: src/hooks, }, conventions: { inputSuffix: Input, outputSuffix: Output, }, features: { reactQuery: true, swr: false, }, });注意一個(gè)容易被忽略的點(diǎn)配置文件里所有路徑都是相對(duì)于配置文件所在目錄的不是相對(duì)于你執(zhí)行命令的目錄。這個(gè)設(shè)計(jì)是我踩過(guò)坑之后特意確定的因?yàn)?CLI 工具最容易出的問(wèn)題就是在子目錄里跑命令生成位置全錯(cuò)了。后面我會(huì)在踩坑章節(jié)詳細(xì)說(shuō)。3.2 第一個(gè)生成命令跑通一個(gè) Post 模塊假設(shè)prisma/schema.prisma里有這樣一個(gè)模型model Post { id String id default(cuid()) title String content String published Boolean default(false) authorId String author User relation(fields: [authorId], references: [id]) createdAt DateTime default(now()) updatedAt DateTime updatedAt }執(zhí)行生成命令npx t3code generate默認(rèn)情況下t3code 會(huì)為每個(gè)模型生成一套完整的 CRUD 代碼。生成的目錄結(jié)構(gòu)大致是src/ ├── server/ │ ├── schemas/ │ │ └── post.schema.ts │ └── routers/ │ └── post.router.ts ├── lib/ │ └── api/ │ └── post.ts └── hooks/ └── use-post.ts其中post.schema.ts長(zhǎng)這樣// generated by t3code - 手動(dòng)修改此文件將被覆蓋 import { z } from zod; export const PostInput z.object({ title: z.string().min(1), content: z.string(), published: z.boolean().default(false), authorId: z.string().min(1), }); export const PostOutput z.object({ id: z.string(), title: z.string(), content: z.string(), published: z.boolean(), authorId: z.string(), createdAt: z.date(), updatedAt: z.date(), }); export type PostInput z.infertypeof PostInput; export type PostOutput z.infertypeof PostOutput;post.router.ts里的 CRUD 骨架大概是這樣import { router, publicProcedure } from ../trpc; import { PostInput } from ../schemas/post.schema; export const postRouter router({ create: publicProcedure .input(PostInput) .mutation(async ({ ctx, input }) { // t3code-preserved-start // 這里可以寫(xiě)自定義業(yè)務(wù)邏輯比如權(quán)限校驗(yàn)、事件發(fā)布等 // t3code-preserved-end return ctx.prisma.post.create({ data: input }); }), list: publicProcedure .query(async ({ ctx }) { return ctx.prisma.post.findMany(); }), detail: publicProcedure .input(z.object({ id: z.string() })) .query(async ({ ctx, input }) { return ctx.prisma.post.findUnique({ where: { id: input.id } }); }), });可以看到生成的文件覆蓋了創(chuàng)建、列表、詳情這三個(gè)最常用的操作。更新和刪除默認(rèn)沒(méi)有生成因?yàn)楦律婕白侄渭?jí)別的權(quán)限控制刪除涉及級(jí)聯(lián)行為這些跟業(yè)務(wù)耦合太深模板化了反而不安全。需要的時(shí)候你在保留區(qū)里手寫(xiě)就好或者把 router 文件頭部的生成標(biāo)記刪掉完全手動(dòng)接管。3.3 增量更新與 watch 模式開(kāi)發(fā)過(guò)程中最頻繁的場(chǎng)景是模型加了一個(gè)字段或者改了一個(gè)字段名。跑一遍t3code generate能全量刷新但每次都手動(dòng)跑很煩所以我加了watch模式npx t3code watch這個(gè)命令會(huì)監(jiān)聽(tīng)prisma/schema.prisma的變化每次保存自動(dòng)增量生成。請(qǐng)注意它不是簡(jiǎn)單地全量重跑而是做了字段級(jí)別的 diff只有新增或修改的字段對(duì)應(yīng)的 Zod、類(lèi)型、API 封裝才會(huì)被重新生成其他文件保持不變。這樣 git diff 干凈評(píng)審時(shí)一眼就能看到改動(dòng)影響范圍。舉個(gè)例子我把Post模型加上tags String[]保存schema.prisma的瞬間watch 會(huì)自動(dòng)幫我把PostInput和PostOutput里的tags: z.array(z.string())加上同時(shí)src/lib/api/post.ts里的類(lèi)型定義也跟著更新。整個(gè)過(guò)程不需要我碰任何一個(gè)手寫(xiě)文件類(lèi)型安全鏈條自動(dòng)閉合。4. 把 t3code 接入真實(shí)項(xiàng)目工作流工具寫(xiě)出來(lái)只是第一步讓它融入團(tuán)隊(duì)日常開(kāi)發(fā)流程才是關(guān)鍵。我實(shí)際推進(jìn)的過(guò)程中發(fā)現(xiàn)代碼生成器最怕的不是功能不夠而是沒(méi)人記得跑。所以需要把生成動(dòng)作嵌進(jìn)已有的工作流里形成習(xí)慣甚至形成強(qiáng)制約束。4.1 與 CI/CD 結(jié)合讓類(lèi)型同步變成強(qiáng)制約束前面提到模型改了但代碼沒(méi)跟上這類(lèi)問(wèn)題最好的攔截點(diǎn)其實(shí)是 CI。t3code 專(zhuān)門(mén)提供了一個(gè)check命令它會(huì)重新生成一遍代碼然后和當(dāng)前倉(cāng)庫(kù)里的文件做對(duì)比如果有差異就返回非零退出碼。在package.json里加一個(gè)腳本{ scripts: { typecheck: tsc --noEmit, codegen:check: t3code check } }然后在 CI 流程里加一步- name: Check type-safe codegen run: pnpm codegen:check有了這一步誰(shuí)要是改了 Prisma schema 忘了跑 generateCI 直接紅PR 根本合不進(jìn)去。這比任何代碼評(píng)審建議都管用因?yàn)闄C(jī)器檢查是零成本、零遺漏的人審總會(huì)漏。我甚至見(jiàn)過(guò)團(tuán)隊(duì)把這個(gè) check 和 lint 合并成一個(gè) pre-push hook本地就能擋住大部分問(wèn)題。4.2 與編輯器 Task 整合保存即生成無(wú)感使用CI 解決的是事后攔截但本地開(kāi)發(fā)里字段改完馬上自動(dòng)生成體驗(yàn)更順。我不建議每個(gè)人手動(dòng)開(kāi)一個(gè)t3code watch終端更好的方式是交給編輯器任務(wù)。在 VSCode 里.vscode/tasks.json可以這樣配置{ version: 2.0.0, tasks: [ { label: t3code: watch, type: shell, command: npx t3code watch, isBackground: true, problemMatcher: [] } ] }配合.vscode/settings.json讓它在打開(kāi)項(xiàng)目時(shí)自動(dòng)啟動(dòng){ task.autoDetect: on }這樣團(tuán)隊(duì)里每個(gè)人 clone 完項(xiàng)目、打開(kāi) VSCodewatch 任務(wù)自動(dòng)在后臺(tái)跑起來(lái)不需要任何人背命令。這套組合拳打下來(lái)生成器才算真正隱形了——你感覺(jué)不到它的存在但它的確在替你守著類(lèi)型安全。4.3 生成的代碼到底要不要提交進(jìn)倉(cāng)庫(kù)這個(gè)問(wèn)題團(tuán)隊(duì)里爭(zhēng)論了很久我的結(jié)論是提交且必須提交。理由很簡(jiǎn)單tRPC 路由、Zod schema 這些生成物直接參與運(yùn)行時(shí)邏輯如果只留在本地那么 CI 類(lèi)型檢查、部署構(gòu)建、壞境復(fù)現(xiàn)全部依賴(lài)先跑一次生成。但凡哪一步漏了線(xiàn)上跑的就是和倉(cāng)庫(kù)里不一致的代碼排查起來(lái)非常痛苦。生成物提交進(jìn)倉(cāng)庫(kù)配合上面的check命令能保證倉(cāng)庫(kù)狀態(tài)和生成器始終一致。這也是很多成熟代碼生成工具比如 Prisma Client 本身的生成產(chǎn)物的做法。你只需要在 README 里寫(xiě)清楚改 schema 后請(qǐng)跑pnpm codegen并提交生成文件即可。生成的文件不用能工去考究格式反正都是機(jī)器產(chǎn)物git 歷史看起來(lái)丑一點(diǎn)也無(wú)所謂。5. 踩坑實(shí)錄我在真實(shí)項(xiàng)目中遇到的六個(gè)問(wèn)題任何工具寫(xiě)出來(lái)都要經(jīng)歷真槍實(shí)彈的考驗(yàn)。下面是 t3code 在落地過(guò)程中遇到的最典型的六個(gè)問(wèn)題每一個(gè)都是血淚教訓(xùn)寫(xiě)出來(lái)幫你避坑。5.1 路徑解析的坑cwd 不等于配置文件目錄CLI 工具最常見(jiàn)的 bug 就是路徑錯(cuò)亂。用戶(hù)可能在packages/web目錄下執(zhí)行npx t3code generate但配置文件在項(xiàng)目根目錄而 Prisma schema 可能又指向prisma/schema.prisma這個(gè)相對(duì)路徑。我第一版實(shí)現(xiàn)用的是process.cwd()來(lái)解析所有路徑立刻被隊(duì)友噴了——只要你在子目錄里跑命令生成位置就全亂了。后來(lái)改成所有相對(duì)路徑都以配置文件所在目錄為基準(zhǔn)解析命令行參數(shù)只能是絕對(duì)路徑或相對(duì)配置文件的路徑。順手加了一條校驗(yàn)如果檢測(cè)到 cwd 和配置目錄不一致打印一行提示。這個(gè)改動(dòng)之后再?zèng)]出現(xiàn)過(guò)生成到哪去了的疑惑。5.2 Prisma Client 生成順序生成的代碼引用了還不存在的 clientt3code 生成的 router 代碼會(huì)有ctx.prisma依賴(lài)而ctx.prisma來(lái)源于 Prisma Client。如果你剛 clone 完項(xiàng)目、還沒(méi)跑過(guò)prisma generate就直接跑t3code generate生成的 TypeScript 文件會(huì)因?yàn)檎也坏絧risma/client類(lèi)型而報(bào)錯(cuò)。解決方式是在項(xiàng)目腳本里把兩條命令串起來(lái){ scripts: { codegen: prisma generate t3code generate } }這里有一個(gè)小細(xì)節(jié)prisma generate必須在t3code generate之前跑不能反過(guò)來(lái)因?yàn)?t3code 解析 Prisma schema 時(shí)需要用到 Prisma 的某些內(nèi)部類(lèi)型定義尤其是枚舉類(lèi)型。順序反了會(huì)出現(xiàn)莫名的解析錯(cuò)誤別問(wèn)我怎么知道的。5.3 Zod 枚舉和 Prisma 枚舉的類(lèi)型一致性Prisma 里的enum字段和 Zod 里的校驗(yàn)看起來(lái)是一一對(duì)應(yīng)的但有個(gè)隱藏的坑Prisma 生成的是 TS 的enumZod 的z.enum()接受的是只讀字符串元組。兩者形態(tài)不一致導(dǎo)致你從 Prisma 枚舉類(lèi)型直接構(gòu)造 Zod schema 時(shí)會(huì)遇到類(lèi)型兼容問(wèn)題。t3code 的默認(rèn)處理是把 Prisma 枚舉轉(zhuǎn)成as const的對(duì)象再用z.nativeEnum()來(lái)兼容import { PostStatus } from prisma/client; export const PostStatusSchema z.nativeEnum(PostStatus);這比z.enum([DRAFT, PUBLISHED])強(qiáng)在哪里強(qiáng)在當(dāng)你改 Prisma 枚舉時(shí)Zod 這里天然跟隨不需要手動(dòng)維護(hù)字符串列表。如果你用z.enum手寫(xiě)就等于在另一個(gè)地方復(fù)制了一份枚舉又回到了兩處同步的老問(wèn)題。5.4 模板覆蓋手寫(xiě)代碼保留區(qū)解析的邊界問(wèn)題保留區(qū)機(jī)制好用但也不是萬(wàn)無(wú)一失。最開(kāi)始的版本我用正則匹配t3code-preserved-start和t3code-preserved-end來(lái)切分文件結(jié)果被隊(duì)友搞出過(guò)一個(gè)詭異 bug業(yè)務(wù)代碼里有人寫(xiě)了一句注釋里面碰巧包含了保留區(qū)標(biāo)記文本導(dǎo)致生成時(shí)保留區(qū)范圍錯(cuò)亂、手寫(xiě)代碼被覆蓋。后來(lái)我把保留區(qū)的識(shí)別改成了基于模板引擎的結(jié)構(gòu)化注釋塊解析只認(rèn)單獨(dú)一行且格式完全匹配的標(biāo)記并且生成前先做一次手寫(xiě)代碼被覆蓋檢查如果檢測(cè)到某個(gè)文件有未標(biāo)記的手寫(xiě)改動(dòng)就拒絕覆蓋并輸出 warning。這個(gè)策略雖然保守一點(diǎn)但安全第一寧可讓你手動(dòng)合并也不能靜默丟代碼。5.5 watch 模式在 monorepo 里的表現(xiàn)如果你在 monorepopnpm workspace、turborepo 等里跑t3code watch第一反應(yīng)可能是每個(gè)子包都開(kāi)一個(gè) watch。這樣會(huì)有大問(wèn)題schema 文件通常只有一個(gè)但多個(gè) watch 實(shí)例會(huì)同時(shí)響應(yīng)同一個(gè)文件的變更可能互相覆蓋生成產(chǎn)物。我的建議是watch 任務(wù)只在擁有 Prisma schema 的那個(gè)包啟動(dòng)其他包的配置文件通過(guò)extends復(fù)用根配置。t3code 配置支持繼承機(jī)制export default defineConfig({ extends: ../../t3code.config.ts, output: { zod: src/server/schemas, trpc: src/server/routers, }, });子包只覆蓋output路徑其他設(shè)置繼承根配置。這樣 monorepo 下只有一處 watch生成物分發(fā)到各包干凈利落。5.6 命名風(fēng)格自動(dòng)轉(zhuǎn)換PascalCase 和 camelCase 的邊界數(shù)據(jù)庫(kù)字段和 TypeScript 代碼之間有個(gè)繞不過(guò)去的坎Prisma 模型名是PascalCase但變量名和文件名習(xí)慣用camelCase。t3code 做自動(dòng)轉(zhuǎn)換看似簡(jiǎn)單真的寫(xiě)起來(lái)才發(fā)現(xiàn)邊界情況多到頭疼BlogPost→blogPost標(biāo)準(zhǔn)轉(zhuǎn)換沒(méi)問(wèn)題APIKey→apikey還是apiKey縮寫(xiě)詞到底拆不拆UserID→userId還是uid每個(gè)團(tuán)隊(duì)習(xí)慣不一樣這個(gè)問(wèn)題的解決方案不是技術(shù)性的而是約定性的t3code 默認(rèn)只做大小寫(xiě)首字母轉(zhuǎn)換不猜縮寫(xiě)語(yǔ)義。同時(shí)暴露一個(gè)naming配置項(xiàng)允許你自定義轉(zhuǎn)換函數(shù)。畢竟命名這東西工具不該替團(tuán)隊(duì)做決定做錯(cuò)了反而讓人難受。你只需要統(tǒng)一模型名必須 PascalCase、生成變量名必須 camelCase這一條基礎(chǔ)約定就夠了。結(jié)尾說(shuō)一點(diǎn)個(gè)人體會(huì)。t3code 寫(xiě)了半年最大的收獲不是我有個(gè)工具能自動(dòng)生成代碼而是想明白了一個(gè)道理代碼生成器的價(jià)值不在生成本身而在它能強(qiáng)制維護(hù)單一事實(shí)來(lái)源。手寫(xiě)代碼時(shí)模型改字段、校驗(yàn)改規(guī)則、類(lèi)型改聲明全是腦力負(fù)擔(dān)隨時(shí)可能漏有了生成器這些同步變成了機(jī)器的任務(wù)人只需要管業(yè)務(wù)。開(kāi)發(fā)效率的提升不是一點(diǎn)點(diǎn)而是根本上少了一類(lèi)問(wèn)題的煩惱。如果你想試一下我建議從小處著手先拿一兩個(gè)模型跑通生成看看保留區(qū)的業(yè)務(wù)代碼和生成模板之間的配合是不是符合你們團(tuán)隊(duì)的習(xí)慣再?zèng)Q定要不要全面推開(kāi)。工具的設(shè)計(jì)是我根據(jù)自身經(jīng)驗(yàn)做的取舍不一定全適合你的項(xiàng)目但自動(dòng)同步 強(qiáng)制檢查這個(gè)流程思路值得每個(gè) T3 項(xiàng)目借鑒。