Skip to content

@kekkai/blueprintArchitecture as Code

將前端設計理念,轉譯成 ESLint 規則、供人閱讀的架構手冊、AI Agent 的守則,以及 CI 檢核流程。

blueprint

一份 config,轉譯出全部

blueprint.config.mjs
eslint.config.mjs Enforce —— 結構規則+內嵌 plugin
docs/architecture-handbook.md Explain —— 給人讀的架構手冊
CLAUDE.md · AGENTS.md · … Collaborate —— AI Agent 的守則
.github/workflows/blueprint-ci.yml Gate —— lint + inspect 進 CI
inspect · deps Verify —— 讀同一份 config 的唯讀指令

改 config、重新生成,所有產出物一起動 —— 它們不會漂移,因為全部是同一份來源轉譯出來的。完整長相見 init 產出物

為什麼需要它

AI Agent 寫 code 又快又多,但檔案要放哪、誰可以 import 誰,全看它當下 context 裡有什麼。而架構文件、ESLint 設定、CLAUDE.md 是三份各自手動維護的東西 —— 遲早講的不是同一套。

blueprint 把它們收斂成一份 config:規範怎麼寫,lint 就怎麼擋、手冊就怎麼講、Agent 就怎麼守。

直接丟給你的 Agent

既有專案想全自動導入?把這段貼給你的 Agent:

text
請協助導入 @kekkai/blueprint,並自主完成:
執行 `npx @kekkai/blueprint init --authoring`,
將其產出的 blueprint-authoring.md 全數完整執行完畢。

驗收(`blueprint doctor` 要過):
- lint、`inspect --baseline`、原有測試都要過
- emitLint 真的接進 ESLint(不留 reference 檔)
- 不改任何 source code —— 既有債鎖進帳本:架構用 `inspect --update-baseline`,
  lint 用 `eslint --suppress-all`

每條驗收在防什麼、流程長怎樣,見 AI 協助導入

建議搭配使用的資源

Blueprint 負責 AI Agent 協作裡的「架構」層面:程式碼該放哪、哪些分層可以互相匯入、Agent 要守住哪些判斷。以下兩項資源補足 blueprint 刻意不涉入的層面:

搭配資源補足的層面
vercel-labs/agent-skills為 AI Agent 精選、可直接安裝的技能包,涵蓋各框架與工具鏈的最佳實務。與 blueprint 守則一同載入後,Agent 同時拿到專案的結構規範與生態圈的慣用寫法。
vuejs/docsVue 官方文件的原始碼 repo。提供給 Agent(clone 到本機,或設定為參考來源)作為 API 的權威依據,跟 Vue 預設藍圖搭配使用尤其合適。

一份守則管「程式碼放哪」(blueprint)、一組技能包管「框架怎麼用得對」(agent-skills)、一份權威文件回答「API 實際長怎樣」(官方文件)。三項輸入幾乎不重疊,合起來可以大幅縮短「能跑」跟「寫得對」之間的距離。