建指南：編譯、測試、文檔生成與發(fā)布前全流程)
數(shù)據(jù)庫后端前端【免費(fèi)下載鏈接】tinybaseA reactive data store sync engine.項(xiàng)目地址https://gitcode.com/gh_mirrors/ti/tinybase點(diǎn)擊查看免費(fèi)下載本篇指南面向希望簽出 TinyBase 倉庫、從源碼自行構(gòu)建并參與開發(fā)的開發(fā)者完整介紹 TinyBase 的日常開發(fā)工作流從環(huán)境準(zhǔn)備與依賴安裝到快速/生產(chǎn)編譯、類型檢查與代碼質(zhì)量校驗(yàn)、三套測試體系單元、性能、端到端再到站點(diǎn)文檔的生成與本地預(yù)覽最后是提交與發(fā)布前的主檢查流程。讀完本文你將掌握 TinyBase 倉庫中每個(gè) npm 腳本背后的真實(shí)實(shí)現(xiàn)對應(yīng) gulpfile.mjs 中的 gulp 任務(wù)并能獨(dú)立完成一次從零構(gòu)建到可提 PR 的完整開發(fā)循環(huán)。環(huán)境準(zhǔn)備與代碼簽出TinyBase 的整個(gè)開發(fā)、構(gòu)建體系建立在 Node.js 生態(tài)之上任務(wù)編排統(tǒng)一由 gulp 驅(qū)動(dòng)見倉庫根目錄的 gulpfile.mjs。在簽出代碼前請先確認(rèn)本機(jī)滿足 package.json 中devEngines聲明的最低運(yùn)行環(huán)境工具最低版本要求當(dāng)前倉庫聲明Node.js23.10.0npm10.9.2此外由于開發(fā)依賴中還包含 Bun用于testBun任務(wù)如果計(jì)劃跑全量檢查也建議準(zhǔn)備好 Bun 運(yùn)行時(shí)。簽出倉庫并安裝開發(fā)依賴git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install當(dāng)前倉庫為鏡像如需從鏡像簽出可git clone https://gitcode.com/gh_mirrors/ti/tinybase后執(zhí)行相同的npm install。安裝完成后即可開始。倉庫布局與開發(fā)工作流強(qiáng)相關(guān)srcTypeScript 源碼按模塊組織store、checkpoints、indexes、metrics、queries、relationships、persisters/*、synchronizers/*、ui-react/*、ui-solid/*、ui-svelte/*、schematizers/*等test單元測試unit、性能測試perf、生產(chǎn)包測試prod與端到端測試e2esite站點(diǎn)與文檔的源內(nèi)容Markdown 指南、demo、less、UI 組件源碼gulpfile.mjs所有npm run腳本背后實(shí)際執(zhí)行的 gulp 任務(wù)定義package.json腳本映射、依賴聲明。npm install之后所有腳本即可用。注意所有 npm 腳本都只是 gulp 任務(wù)的薄封裝例如compileForTest: gulp compileForTest因此理解工作流的關(guān)鍵在于讀懂 gulpfile.mjs。編譯從快速測試到生產(chǎn)發(fā)布TinyBase 把編譯分成兩種模式對應(yīng)不同的使用場景?？焖倬幾g供測試使用npm run compileForTest該任務(wù)對應(yīng) gulp 的compileForTest通常只需幾秒鐘。它的目標(biāo)是生成一份可供測試運(yùn)行的可執(zhí)行 JavaScript具體流程見 gulpfile.mjsclearDir(DIST_DIR)清空并重建dist目錄copyPackageFiles()生成dist/package.json剔除private、scripts、devEngines、devDependencies重建exports與typesVersions映射、復(fù)制LICENSE、readme.md、releases.md與agents.mdcopyDefinitions(DIST_DIR)為每個(gè)模塊生成類型聲明文件types/module/index.d.ts遍歷ALL_MODULESgulpfile.mjs 中約 60 個(gè)模塊從核心store到各類persister、synchronizer、UI 綁定與 schematizer逐個(gè)調(diào)用compileModule產(chǎn)出dist/module/index.jscheckExportParity()用 TypeScript 編譯器比對每個(gè)模塊運(yùn)行時(shí)導(dǎo)出與聲明文件導(dǎo)出的一致性防止運(yùn)行時(shí)有、類型沒有或反之。生產(chǎn)編譯壓縮模塊npm run compileForProd對應(yīng) gulp 的compileModulesForProdgulpfile.mjs比快速編譯多出兩件事每個(gè)模塊額外編譯一份min版本dist/min/module/index.js并通過 terser 以toplevel: true, compress: {unsafe: true, passes: 3}做激進(jìn)壓縮最后對產(chǎn)物做 gzipgzipFile壓縮級別 9用于核對體積指標(biāo)每個(gè)模塊還會(huì)生成一份with-schemas變體schema 類型感知的入口。從源碼結(jié)構(gòu)看compileModule的構(gòu)建管線gulpfile.mjs是rollup打包 →rollup-plugin-esbuild目標(biāo)esnext轉(zhuǎn)譯 TS/JSX → 對ui-solid系列模塊額外經(jīng) Babel solid preset 處理 →rollup/plugin-replace重寫 UI 模塊導(dǎo)入路徑 →rollup/plugin-image內(nèi)聯(lián)圖片 → 非壓縮產(chǎn)物經(jīng) prettier 格式化、壓縮產(chǎn)物經(jīng) terser 壓縮。external聲明了 react、solid-js、svelte、yjs、expo-sqlite 等運(yùn)行時(shí)依賴不被打包進(jìn)產(chǎn)物這也是 TinyBase 保持零依賴包體僅 store 模塊 gzipped 約 7.3kB的原因之一。編譯產(chǎn)物統(tǒng)一落在 dist 目錄生產(chǎn)構(gòu)建還會(huì)在其下生成.gz文件測試、類型聲明與發(fā)布包都以此為準(zhǔn)。代碼質(zhì)量類型、Lint 與拼寫TypeScript 全量校驗(yàn)npm run tsgulp 的ts任務(wù)gulpfile.mjs會(huì)做四件事對src、test、site三處分別執(zhí)行tsChecktsCheck內(nèi)部用 TypeScript 編譯器 API 做全量類型診斷getPreEmitDiagnostics并過濾掉node_modules與test/unit/core/types目錄用ts-unused-exports分析tsconfig.json報(bào)告未使用的導(dǎo)出未使用導(dǎo)出會(huì)直接導(dǎo)致任務(wù)失敗確保公共 API 面干凈額外跑兩次svelte-check分別校驗(yàn)src/ui-sveltesvelte.tsconfig.json與test/unit/core/ui-svelte下的 Svelte 組件類型。通常 IDE 會(huì)在你編輯時(shí)持續(xù)做類型檢查這個(gè)命令適合在提交前一次性驗(yàn)證整個(gè)代碼庫。Lint 與格式化npm run lintlint是series(lintDocs, lintFiles)gulpfile.mjslintDocsgulpfile.mjs專門針對src中.js/.d.ts文件里嵌在文檔注釋中的代碼塊正則LINT_BLOCKS匹配 tsx 代碼塊進(jìn)行 prettierprintWidth: 75格式檢查與 eslint 校驗(yàn)超寬行會(huì)被自動(dòng)重排——這保證了文檔中的示例代碼和真實(shí)源碼一樣規(guī)范lintFilesgulpfile.mjs遍歷src、test、site下的.ts、.tsx、.js、.d.ts、.svelte文件先按.prettierrc配置做 prettier 格式化不合規(guī)文件會(huì)被直接寫回修復(fù)再用 ESLint 校驗(yàn)配置見 eslint.config.js含 react、solid、svelte 等插件規(guī)則。拼寫檢查npm run spell拼寫錯(cuò)誤在代碼與文檔中同樣致命。spell任務(wù)基于cspellgulpfile.mjs分別對倉庫根目錄、src、test、site遞歸執(zhí)行npx cspell dir/*深層目錄用**。詞表與忽略規(guī)則集中在 cspell.jsonignorePaths排除了*.tsv、*.webp、*.svg、*.snap、*.json、*.test.ts等文件類型words收錄了 TinyBase 生態(tài)中的專有名詞如tinybase、tinyplex、mergeablestore、schematizer、partykit、各 persister 名稱等新增術(shù)語時(shí)需要同步補(bǔ)充到該文件。測試三層防線TinyBase 有三套主要測試單元測試、性能測試、端到端測試。其中單元測試值得一提的特色是它會(huì)執(zhí)行并斷言文檔中的全部內(nèi)聯(lián)代碼示例。單元測試npm run testUnit前提是代碼已編譯dist就緒對應(yīng) gulp 的testUnitgulpfile.mjs運(yùn)行test([test/unit], true)第二參數(shù)為true表示開啟覆蓋率統(tǒng)計(jì)Istanbul provider匯總寫入 coverage.json。如果在迭代代碼過程中想一步到位npm run compileAndTestUnit它等價(jià)于series(compileForTest, testUnit)——先快速編譯再跑單元測試。若只想聚焦核心模塊倉庫還提供了testUnitFast/compileAndTestUnitFast僅跑test/unit/core。從 vitest.config.ts 可以看到單元測試被拆分為多個(gè) vitest projectunit、unit-charts、unit-synchronizers、unit-types、unit-documentation、unit-persisters以及專門為 Solidsolid、solid-ssr與 Sveltesvelte組件準(zhǔn)備的 project。它們共享happy-dom環(huán)境、test/vitest/setup.ts初始化腳本與自定義 reporter并通過sequence.groupOrder控制執(zhí)行順序圖表、同步器、類型、文檔、persister 依次進(jìn)行persister 測試涉及 PGlite 等真實(shí)數(shù)據(jù)庫單獨(dú)限制為maxWorkers: 2且hookTimeout: 30000。測試文檔內(nèi)聯(lián)代碼的實(shí)現(xiàn)在 test/unit/documentation.test.ts該文件 import 了 TinyBase 全系模塊含 Automerge、PGlite、TypeBox、ArkType、Zod、Solid、Svelte、React 等運(yùn)行時(shí)用 esbuild/Babel 實(shí)時(shí)編譯文檔中的示例代碼塊并執(zhí)行斷言。因此你在 docs/api 中看到的每一個(gè) API 示例都是可執(zhí)行的真代碼。性能測試npm run testPerf對應(yīng)test([test/perf])不啟用覆蓋率。同樣有一步到位的compileAndTestPerf。性能測試的核心機(jī)制在 test/perf/common.ts 的repeat輔助函數(shù)中默認(rèn)將規(guī)模N從stepSize默認(rèn)maxN / stepsmaxN默認(rèn) 10000、steps默認(rèn) 40遞增到maxN逐步測量每個(gè)規(guī)模下的耗時(shí)借助asciichart庫把[maxes, averages, results]三條曲線渲染成 ASCII 圖表輸出到控制臺(tái)圖表中紅線為允許的最大值maxResult藍(lán)線為實(shí)際測量曲線黃線為平均值——只要曲線大體平緩且平均值低于maxResult測試即通過expect(average).toBeLessThan(maxResult)。這正是文檔中每個(gè)性能測試都會(huì)渲染一個(gè)相對平緩的 ASCII 圖表的來源通過肉眼觀察曲線是否突然抬升可以快速發(fā)現(xiàn)是否引入了高時(shí)間復(fù)雜度的算法 bug。具體用例覆蓋了 store-create、store-grow、indexes、metrics、queries、relationships 及 mergeable-store 等核心路徑。端到端測試端到端測試用于驗(yàn)證站點(diǎn)上所有 demo 真實(shí)可用。因?yàn)樗?qū)動(dòng)完整文檔站點(diǎn)前置要求是先做生產(chǎn)編譯并生成文檔npm run compileForProd npm run compileDocs npm run testE2etestE2e等價(jià)于npx playwright testgulpfile.mjs配置見 playwright.config.ts測試目錄為test/e2e只跑 ChromiumDesktop Chrome 視口workers: 4截圖快照存放在test/e2e/doc-shots.test.ts-snapshots/。e2e 測試的編排在 test/e2e/common.ts每個(gè)測試文件通過getServerFunctions(port)獲得startServer/stopServer/expectPage三件套beforeAll啟動(dòng)、afterAll關(guān)閉。服務(wù)器實(shí)現(xiàn)是 test/server.mjs 的createTestServer基于http-server服務(wù)docs目錄并做了兩處關(guān)鍵處理cache: -1禁用緩存保證每次測試讀到最新構(gòu)建產(chǎn)物、gzip 壓縮同時(shí)把頁面中的https://esm.sh/tinybase依賴重寫為本地/pseudo.esm.sh/tinybase對應(yīng) pseudo.esm.sh 目錄中的偽 CDN 模塊使 demo 完全離線可測。用例分為兩類頁面級斷言如 home.test.ts檢查標(biāo)題為TinyBase與 demo 斷言如 test/e2e/demos/hello-world.test.ts訪問/demos/hello-world/hello-world-vanilla/后斷言h1文本并通過expectedFramedElement進(jìn)入頁面 iframe 檢查 demo 渲染結(jié)果doc-shots.test.ts對文檔頁面與 demo 逐頁截圖與倉庫中的 PNG 快照逐像素比對防止文檔渲染意外回歸。倉庫還提供了compileAndTestE2eseries(compileForProdAndDocs, testE2e)一條龍腳本以及用 Bun 運(yùn)行的testBun針對test/unit/persisters/database與test/unit/documentation.test.ts。文檔構(gòu)建與本地預(yù)覽e2e 測試會(huì)自建 web 服務(wù)器驗(yàn)證文檔站點(diǎn)如果你只是想單獨(dú)預(yù)覽 TinyBase 官網(wǎng)則使用npm run compileDocs npm run serveDocs執(zhí)行后網(wǎng)站會(huì)在localhost:8080提供服務(wù)。serveDocs是常駐任務(wù)建議放到獨(dú)立終端窗口運(yùn)行。它同樣調(diào)用 test/server.mjs 的createTestServer以docs目錄為根、8080端口啟動(dòng)服務(wù)器實(shí)現(xiàn)與 e2e 共用可見 gulpfile.mjs。compileDocs是其中最耗時(shí)的一步它會(huì)調(diào)用compileDocsAndAssets()gulpfile.mjs先用 esbuild 將 site/build.ts 打包為tmp/build.js再執(zhí)行其build()函數(shù)生成 docs 下的全部內(nèi)容——包括為每個(gè)模塊從src/types/*/docs.js與index.d.ts中的文檔注釋生成 API 文檔頁面這一過程依賴tinydocs工具。因此如果你只想改站點(diǎn)樣式或交互可以跳過 API 文檔生成npm run compileDocsAssetsOnly該任務(wù)對應(yīng)compileDocsAndAssets(false, false)只編譯站點(diǎn)資源less、js、字體、圖片等源自 site 目錄。如果只改 demo 或指南內(nèi)容則npm run compileDocsPagesOnly對應(yīng)compileDocsAndAssets(false)只生成站點(diǎn)頁面而不重新生成 API 文檔。注意它會(huì)移除所有 API 文檔所以在最終提交前務(wù)必再完整跑一次compileDocs把 API 文檔補(bǔ)回來。發(fā)布前主檢查prePublishPackage在提交代碼或發(fā)布到 npm 之前prePublishPackage是覆蓋一切的超集檢查npm run prePublishPackage它在 gulpfile.mjs 中的完整流水線如下串行執(zhí)行階段內(nèi)容npmInstallnpm ci --legacy-peer-deps按鎖文件重裝依賴compileForTest快速編譯 distparallel(lint, spell, ts)并行執(zhí)行 Lint、拼寫、類型檢查testBunBun 跑數(shù)據(jù)庫與文檔相關(guān)測試testUnit全量單元測試含覆蓋率testPerf性能測試ASCII 圖表compileForProd生產(chǎn)壓縮編譯compileDocs生成完整文檔站點(diǎn)preparePackageForProd生成發(fā)布用包元數(shù)據(jù)testProdattwarethetypeswrong/cli校驗(yàn)包導(dǎo)出與類型聲明對 TypeScript 解析器的兼容性 test/prod 生產(chǎn)包導(dǎo)入測試testE2ePlaywright 端到端全量回歸如果你的改動(dòng)較小、只想在提交前快速自查倉庫還提供了更輕量的preCommitlint spell ts→compileForTest→testBun→testUnit→compileForProd以及正式發(fā)布用的publishPackage在prePublishPackage全部通過后執(zhí)行npm publish ./dist并自動(dòng)根據(jù)版本號中的預(yù)發(fā)布標(biāo)簽選擇 npm tag見 gulpfile.mjs。開發(fā)者工作流速查以下命令覆蓋從簽出到提交的完整閉環(huán)按日常使用頻率整理# 環(huán)境 git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install # 日常迭代改代碼 → 快速編譯 → 單測 npm run compileAndTestUnit # 提交前自查 npm run preCommit # 全量驗(yàn)證 / 發(fā)布前 npm run prePublishPackage整個(gè)流程的設(shè)計(jì)意圖很清晰compileForTest與compileAndTestUnit保證快速反饋ts/lint/spell把類型、風(fēng)格與拼寫問題擋在測試之前testPerf的 ASCII 圖表讓性能回歸一目了然compileDocs e2e 確保文檔與 demo 真實(shí)可運(yùn)行最后prePublishPackage在發(fā)布邊界上做一次全鏈路把關(guān)。按照這套工作流完成改動(dòng)后就可以放心地提交你的 pull request 了。贊分享數(shù)據(jù)庫后端前端【免費(fèi)下載鏈接】tinybaseA reactive data store sync engine.項(xiàng)目地址https://gitcode.com/gh_mirrors/ti/tinybase點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Docker Compose 源碼構(gòu)建指南CLI 編譯、單元測試、E2E 測試與發(fā)布全流程Docker Compose 源碼構(gòu)建指南CLI 編譯、單元測試、E2E 測試與發(fā)布全流程 本指南以倉庫根目錄 BUILDING.md https://lin云原生容器編排DevOpsCLIReScript 編譯器開發(fā)貢獻(xiàn)指南從環(huán)境搭建、源碼構(gòu)建到測試與發(fā)布的全流程實(shí)戰(zhàn)ReScript 編譯器開發(fā)貢獻(xiàn)指南從環(huán)境搭建、源碼構(gòu)建到測試與發(fā)布的全流程實(shí)戰(zhàn) 導(dǎo)讀 本指南面向想要參與 ReScript https://link.git編譯器編程語言開發(fā)工具Pachyderm Python SDK 貢獻(xiàn)指南從 Poetry 環(huán)境搭建到測試、文檔生成與發(fā)布全流程Pachyderm Python SDK 貢獻(xiàn)指南從 Poetry 環(huán)境搭建到測試、文檔生成與發(fā)布全流程 本指南圍繞倉庫中的 python sdk/CONTR數(shù)據(jù)工程后端云原生任務(wù)調(diào)度微服務(wù)上一篇抖音無水印視頻下載終極指南douyin-downloader開源工具完全教程下一篇如何在Windows系統(tǒng)上完整啟用MacBook Pro Touch Bar專業(yè)驅(qū)動(dòng)創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 TinyBase 從源碼構(gòu)建指南：編譯、測試、文檔生成與發(fā)布前全流程
數(shù)據(jù)庫后端前端【免費(fèi)下載鏈接】tinybaseA reactive data store sync engine.項(xiàng)目地址https://gitcode.com/gh_mirrors/ti/tinybase點(diǎn)擊查看免費(fèi)下載本篇指南面向希望簽出 TinyBase 倉庫、從源碼自行構(gòu)建并參與開發(fā)的開發(fā)者完整介紹 TinyBase 的日常開發(fā)工作流從環(huán)境準(zhǔn)備與依賴安裝到快速/生產(chǎn)編譯、類型檢查與代碼質(zhì)量校驗(yàn)、三套測試體系單元、性能、端到端再到站點(diǎn)文檔的生成與本地預(yù)覽最后是提交與發(fā)布前的主檢查流程。讀完本文你將掌握 TinyBase 倉庫中每個(gè) npm 腳本背后的真實(shí)實(shí)現(xiàn)對應(yīng) gulpfile.mjs 中的 gulp 任務(wù)并能獨(dú)立完成一次從零構(gòu)建到可提 PR 的完整開發(fā)循環(huán)。環(huán)境準(zhǔn)備與代碼簽出TinyBase 的整個(gè)開發(fā)、構(gòu)建體系建立在 Node.js 生態(tài)之上任務(wù)編排統(tǒng)一由 gulp 驅(qū)動(dòng)見倉庫根目錄的 gulpfile.mjs。在簽出代碼前請先確認(rèn)本機(jī)滿足 package.json 中devEngines聲明的最低運(yùn)行環(huán)境工具最低版本要求當(dāng)前倉庫聲明Node.js23.10.0npm10.9.2此外由于開發(fā)依賴中還包含 Bun用于testBun任務(wù)如果計(jì)劃跑全量檢查也建議準(zhǔn)備好 Bun 運(yùn)行時(shí)。簽出倉庫并安裝開發(fā)依賴git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install當(dāng)前倉庫為鏡像如需從鏡像簽出可git clone https://gitcode.com/gh_mirrors/ti/tinybase后執(zhí)行相同的npm install。安裝完成后即可開始。倉庫布局與開發(fā)工作流強(qiáng)相關(guān)srcTypeScript 源碼按模塊組織store、checkpoints、indexes、metrics、queries、relationships、persisters/*、synchronizers/*、ui-react/*、ui-solid/*、ui-svelte/*、schematizers/*等test單元測試unit、性能測試perf、生產(chǎn)包測試prod與端到端測試e2esite站點(diǎn)與文檔的源內(nèi)容Markdown 指南、demo、less、UI 組件源碼gulpfile.mjs所有npm run腳本背后實(shí)際執(zhí)行的 gulp 任務(wù)定義package.json腳本映射、依賴聲明。npm install之后所有腳本即可用。注意所有 npm 腳本都只是 gulp 任務(wù)的薄封裝例如compileForTest: gulp compileForTest因此理解工作流的關(guān)鍵在于讀懂 gulpfile.mjs。編譯從快速測試到生產(chǎn)發(fā)布TinyBase 把編譯分成兩種模式對應(yīng)不同的使用場景?？焖倬幾g供測試使用npm run compileForTest該任務(wù)對應(yīng) gulp 的compileForTest通常只需幾秒鐘。它的目標(biāo)是生成一份可供測試運(yùn)行的可執(zhí)行 JavaScript具體流程見 gulpfile.mjsclearDir(DIST_DIR)清空并重建dist目錄copyPackageFiles()生成dist/package.json剔除private、scripts、devEngines、devDependencies重建exports與typesVersions映射、復(fù)制LICENSE、readme.md、releases.md與agents.mdcopyDefinitions(DIST_DIR)為每個(gè)模塊生成類型聲明文件types/module/index.d.ts遍歷ALL_MODULESgulpfile.mjs 中約 60 個(gè)模塊從核心store到各類persister、synchronizer、UI 綁定與 schematizer逐個(gè)調(diào)用compileModule產(chǎn)出dist/module/index.jscheckExportParity()用 TypeScript 編譯器比對每個(gè)模塊運(yùn)行時(shí)導(dǎo)出與聲明文件導(dǎo)出的一致性防止運(yùn)行時(shí)有、類型沒有或反之。生產(chǎn)編譯壓縮模塊npm run compileForProd對應(yīng) gulp 的compileModulesForProdgulpfile.mjs比快速編譯多出兩件事每個(gè)模塊額外編譯一份min版本dist/min/module/index.js并通過 terser 以toplevel: true, compress: {unsafe: true, passes: 3}做激進(jìn)壓縮最后對產(chǎn)物做 gzipgzipFile壓縮級別 9用于核對體積指標(biāo)每個(gè)模塊還會(huì)生成一份with-schemas變體schema 類型感知的入口。從源碼結(jié)構(gòu)看compileModule的構(gòu)建管線gulpfile.mjs是rollup打包 →rollup-plugin-esbuild目標(biāo)esnext轉(zhuǎn)譯 TS/JSX → 對ui-solid系列模塊額外經(jīng) Babel solid preset 處理 →rollup/plugin-replace重寫 UI 模塊導(dǎo)入路徑 →rollup/plugin-image內(nèi)聯(lián)圖片 → 非壓縮產(chǎn)物經(jīng) prettier 格式化、壓縮產(chǎn)物經(jīng) terser 壓縮。external聲明了 react、solid-js、svelte、yjs、expo-sqlite 等運(yùn)行時(shí)依賴不被打包進(jìn)產(chǎn)物這也是 TinyBase 保持零依賴包體僅 store 模塊 gzipped 約 7.3kB的原因之一。編譯產(chǎn)物統(tǒng)一落在 dist 目錄生產(chǎn)構(gòu)建還會(huì)在其下生成.gz文件測試、類型聲明與發(fā)布包都以此為準(zhǔn)。代碼質(zhì)量類型、Lint 與拼寫TypeScript 全量校驗(yàn)npm run tsgulp 的ts任務(wù)gulpfile.mjs會(huì)做四件事對src、test、site三處分別執(zhí)行tsChecktsCheck內(nèi)部用 TypeScript 編譯器 API 做全量類型診斷getPreEmitDiagnostics并過濾掉node_modules與test/unit/core/types目錄用ts-unused-exports分析tsconfig.json報(bào)告未使用的導(dǎo)出未使用導(dǎo)出會(huì)直接導(dǎo)致任務(wù)失敗確保公共 API 面干凈額外跑兩次svelte-check分別校驗(yàn)src/ui-sveltesvelte.tsconfig.json與test/unit/core/ui-svelte下的 Svelte 組件類型。通常 IDE 會(huì)在你編輯時(shí)持續(xù)做類型檢查這個(gè)命令適合在提交前一次性驗(yàn)證整個(gè)代碼庫。Lint 與格式化npm run lintlint是series(lintDocs, lintFiles)gulpfile.mjslintDocsgulpfile.mjs專門針對src中.js/.d.ts文件里嵌在文檔注釋中的代碼塊正則LINT_BLOCKS匹配 tsx 代碼塊進(jìn)行 prettierprintWidth: 75格式檢查與 eslint 校驗(yàn)超寬行會(huì)被自動(dòng)重排——這保證了文檔中的示例代碼和真實(shí)源碼一樣規(guī)范lintFilesgulpfile.mjs遍歷src、test、site下的.ts、.tsx、.js、.d.ts、.svelte文件先按.prettierrc配置做 prettier 格式化不合規(guī)文件會(huì)被直接寫回修復(fù)再用 ESLint 校驗(yàn)配置見 eslint.config.js含 react、solid、svelte 等插件規(guī)則。拼寫檢查npm run spell拼寫錯(cuò)誤在代碼與文檔中同樣致命。spell任務(wù)基于cspellgulpfile.mjs分別對倉庫根目錄、src、test、site遞歸執(zhí)行npx cspell dir/*深層目錄用**。詞表與忽略規(guī)則集中在 cspell.jsonignorePaths排除了*.tsv、*.webp、*.svg、*.snap、*.json、*.test.ts等文件類型words收錄了 TinyBase 生態(tài)中的專有名詞如tinybase、tinyplex、mergeablestore、schematizer、partykit、各 persister 名稱等新增術(shù)語時(shí)需要同步補(bǔ)充到該文件。測試三層防線TinyBase 有三套主要測試單元測試、性能測試、端到端測試。其中單元測試值得一提的特色是它會(huì)執(zhí)行并斷言文檔中的全部內(nèi)聯(lián)代碼示例。單元測試npm run testUnit前提是代碼已編譯dist就緒對應(yīng) gulp 的testUnitgulpfile.mjs運(yùn)行test([test/unit], true)第二參數(shù)為true表示開啟覆蓋率統(tǒng)計(jì)Istanbul provider匯總寫入 coverage.json。如果在迭代代碼過程中想一步到位npm run compileAndTestUnit它等價(jià)于series(compileForTest, testUnit)——先快速編譯再跑單元測試。若只想聚焦核心模塊倉庫還提供了testUnitFast/compileAndTestUnitFast僅跑test/unit/core。從 vitest.config.ts 可以看到單元測試被拆分為多個(gè) vitest projectunit、unit-charts、unit-synchronizers、unit-types、unit-documentation、unit-persisters以及專門為 Solidsolid、solid-ssr與 Sveltesvelte組件準(zhǔn)備的 project。它們共享happy-dom環(huán)境、test/vitest/setup.ts初始化腳本與自定義 reporter并通過sequence.groupOrder控制執(zhí)行順序圖表、同步器、類型、文檔、persister 依次進(jìn)行persister 測試涉及 PGlite 等真實(shí)數(shù)據(jù)庫單獨(dú)限制為maxWorkers: 2且hookTimeout: 30000。測試文檔內(nèi)聯(lián)代碼的實(shí)現(xiàn)在 test/unit/documentation.test.ts該文件 import 了 TinyBase 全系模塊含 Automerge、PGlite、TypeBox、ArkType、Zod、Solid、Svelte、React 等運(yùn)行時(shí)用 esbuild/Babel 實(shí)時(shí)編譯文檔中的示例代碼塊并執(zhí)行斷言。因此你在 docs/api 中看到的每一個(gè) API 示例都是可執(zhí)行的真代碼。性能測試npm run testPerf對應(yīng)test([test/perf])不啟用覆蓋率。同樣有一步到位的compileAndTestPerf。性能測試的核心機(jī)制在 test/perf/common.ts 的repeat輔助函數(shù)中默認(rèn)將規(guī)模N從stepSize默認(rèn)maxN / stepsmaxN默認(rèn) 10000、steps默認(rèn) 40遞增到maxN逐步測量每個(gè)規(guī)模下的耗時(shí)借助asciichart庫把[maxes, averages, results]三條曲線渲染成 ASCII 圖表輸出到控制臺(tái)圖表中紅線為允許的最大值maxResult藍(lán)線為實(shí)際測量曲線黃線為平均值——只要曲線大體平緩且平均值低于maxResult測試即通過expect(average).toBeLessThan(maxResult)。這正是文檔中每個(gè)性能測試都會(huì)渲染一個(gè)相對平緩的 ASCII 圖表的來源通過肉眼觀察曲線是否突然抬升可以快速發(fā)現(xiàn)是否引入了高時(shí)間復(fù)雜度的算法 bug。具體用例覆蓋了 store-create、store-grow、indexes、metrics、queries、relationships 及 mergeable-store 等核心路徑。端到端測試端到端測試用于驗(yàn)證站點(diǎn)上所有 demo 真實(shí)可用。因?yàn)樗?qū)動(dòng)完整文檔站點(diǎn)前置要求是先做生產(chǎn)編譯并生成文檔npm run compileForProd npm run compileDocs npm run testE2etestE2e等價(jià)于npx playwright testgulpfile.mjs配置見 playwright.config.ts測試目錄為test/e2e只跑 ChromiumDesktop Chrome 視口workers: 4截圖快照存放在test/e2e/doc-shots.test.ts-snapshots/。e2e 測試的編排在 test/e2e/common.ts每個(gè)測試文件通過getServerFunctions(port)獲得startServer/stopServer/expectPage三件套beforeAll啟動(dòng)、afterAll關(guān)閉。服務(wù)器實(shí)現(xiàn)是 test/server.mjs 的createTestServer基于http-server服務(wù)docs目錄并做了兩處關(guān)鍵處理cache: -1禁用緩存保證每次測試讀到最新構(gòu)建產(chǎn)物、gzip 壓縮同時(shí)把頁面中的https://esm.sh/tinybase依賴重寫為本地/pseudo.esm.sh/tinybase對應(yīng) pseudo.esm.sh 目錄中的偽 CDN 模塊使 demo 完全離線可測。用例分為兩類頁面級斷言如 home.test.ts檢查標(biāo)題為TinyBase與 demo 斷言如 test/e2e/demos/hello-world.test.ts訪問/demos/hello-world/hello-world-vanilla/后斷言h1文本并通過expectedFramedElement進(jìn)入頁面 iframe 檢查 demo 渲染結(jié)果doc-shots.test.ts對文檔頁面與 demo 逐頁截圖與倉庫中的 PNG 快照逐像素比對防止文檔渲染意外回歸。倉庫還提供了compileAndTestE2eseries(compileForProdAndDocs, testE2e)一條龍腳本以及用 Bun 運(yùn)行的testBun針對test/unit/persisters/database與test/unit/documentation.test.ts。文檔構(gòu)建與本地預(yù)覽e2e 測試會(huì)自建 web 服務(wù)器驗(yàn)證文檔站點(diǎn)如果你只是想單獨(dú)預(yù)覽 TinyBase 官網(wǎng)則使用npm run compileDocs npm run serveDocs執(zhí)行后網(wǎng)站會(huì)在localhost:8080提供服務(wù)。serveDocs是常駐任務(wù)建議放到獨(dú)立終端窗口運(yùn)行。它同樣調(diào)用 test/server.mjs 的createTestServer以docs目錄為根、8080端口啟動(dòng)服務(wù)器實(shí)現(xiàn)與 e2e 共用可見 gulpfile.mjs。compileDocs是其中最耗時(shí)的一步它會(huì)調(diào)用compileDocsAndAssets()gulpfile.mjs先用 esbuild 將 site/build.ts 打包為tmp/build.js再執(zhí)行其build()函數(shù)生成 docs 下的全部內(nèi)容——包括為每個(gè)模塊從src/types/*/docs.js與index.d.ts中的文檔注釋生成 API 文檔頁面這一過程依賴tinydocs工具。因此如果你只想改站點(diǎn)樣式或交互可以跳過 API 文檔生成npm run compileDocsAssetsOnly該任務(wù)對應(yīng)compileDocsAndAssets(false, false)只編譯站點(diǎn)資源less、js、字體、圖片等源自 site 目錄。如果只改 demo 或指南內(nèi)容則npm run compileDocsPagesOnly對應(yīng)compileDocsAndAssets(false)只生成站點(diǎn)頁面而不重新生成 API 文檔。注意它會(huì)移除所有 API 文檔所以在最終提交前務(wù)必再完整跑一次compileDocs把 API 文檔補(bǔ)回來。發(fā)布前主檢查prePublishPackage在提交代碼或發(fā)布到 npm 之前prePublishPackage是覆蓋一切的超集檢查npm run prePublishPackage它在 gulpfile.mjs 中的完整流水線如下串行執(zhí)行階段內(nèi)容npmInstallnpm ci --legacy-peer-deps按鎖文件重裝依賴compileForTest快速編譯 distparallel(lint, spell, ts)并行執(zhí)行 Lint、拼寫、類型檢查testBunBun 跑數(shù)據(jù)庫與文檔相關(guān)測試testUnit全量單元測試含覆蓋率testPerf性能測試ASCII 圖表compileForProd生產(chǎn)壓縮編譯compileDocs生成完整文檔站點(diǎn)preparePackageForProd生成發(fā)布用包元數(shù)據(jù)testProdattwarethetypeswrong/cli校驗(yàn)包導(dǎo)出與類型聲明對 TypeScript 解析器的兼容性 test/prod 生產(chǎn)包導(dǎo)入測試testE2ePlaywright 端到端全量回歸如果你的改動(dòng)較小、只想在提交前快速自查倉庫還提供了更輕量的preCommitlint spell ts→compileForTest→testBun→testUnit→compileForProd以及正式發(fā)布用的publishPackage在prePublishPackage全部通過后執(zhí)行npm publish ./dist并自動(dòng)根據(jù)版本號中的預(yù)發(fā)布標(biāo)簽選擇 npm tag見 gulpfile.mjs。開發(fā)者工作流速查以下命令覆蓋從簽出到提交的完整閉環(huán)按日常使用頻率整理# 環(huán)境 git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install # 日常迭代改代碼 → 快速編譯 → 單測 npm run compileAndTestUnit # 提交前自查 npm run preCommit # 全量驗(yàn)證 / 發(fā)布前 npm run prePublishPackage整個(gè)流程的設(shè)計(jì)意圖很清晰compileForTest與compileAndTestUnit保證快速反饋ts/lint/spell把類型、風(fēng)格與拼寫問題擋在測試之前testPerf的 ASCII 圖表讓性能回歸一目了然compileDocs e2e 確保文檔與 demo 真實(shí)可運(yùn)行最后prePublishPackage在發(fā)布邊界上做一次全鏈路把關(guān)。按照這套工作流完成改動(dòng)后就可以放心地提交你的 pull request 了。贊分享數(shù)據(jù)庫后端前端【免費(fèi)下載鏈接】tinybaseA reactive data store sync engine.項(xiàng)目地址https://gitcode.com/gh_mirrors/ti/tinybase點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Docker Compose 源碼構(gòu)建指南CLI 編譯、單元測試、E2E 測試與發(fā)布全流程Docker Compose 源碼構(gòu)建指南CLI 編譯、單元測試、E2E 測試與發(fā)布全流程 本指南以倉庫根目錄 BUILDING.md https://lin云原生容器編排DevOpsCLIReScript 編譯器開發(fā)貢獻(xiàn)指南從環(huán)境搭建、源碼構(gòu)建到測試與發(fā)布的全流程實(shí)戰(zhàn)ReScript 編譯器開發(fā)貢獻(xiàn)指南從環(huán)境搭建、源碼構(gòu)建到測試與發(fā)布的全流程實(shí)戰(zhàn) 導(dǎo)讀 本指南面向想要參與 ReScript https://link.git編譯器編程語言開發(fā)工具Pachyderm Python SDK 貢獻(xiàn)指南從 Poetry 環(huán)境搭建到測試、文檔生成與發(fā)布全流程Pachyderm Python SDK 貢獻(xiàn)指南從 Poetry 環(huán)境搭建到測試、文檔生成與發(fā)布全流程 本指南圍繞倉庫中的 python sdk/CONTR數(shù)據(jù)工程后端云原生任務(wù)調(diào)度微服務(wù)上一篇抖音無水印視頻下載終極指南douyin-downloader開源工具完全教程下一篇如何在Windows系統(tǒng)上完整啟用MacBook Pro Touch Bar專業(yè)驅(qū)動(dòng)創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考