数据库后端前端【免费下载链接】tinybaseA reactive data store sync engine.项目地址https://gitcode.com/gh_mirrors/ti/tinybase点击查看免费下载本篇指南面向希望签出 TinyBase 仓库、从源码自行构建并参与开发的开发者完整介绍 TinyBase 的日常开发工作流从环境准备与依赖安装到快速/生产编译、类型检查与代码质量校验、三套测试体系单元、性能、端到端再到站点文档的生成与本地预览最后是提交与发布前的主检查流程。读完本文你将掌握 TinyBase 仓库中每个 npm 脚本背后的真实实现对应 gulpfile.mjs 中的 gulp 任务并能独立完成一次从零构建到可提 PR 的完整开发循环。环境准备与代码签出TinyBase 的整个开发、构建体系建立在 Node.js 生态之上任务编排统一由 gulp 驱动见仓库根目录的 gulpfile.mjs。在签出代码前请先确认本机满足 package.json 中devEngines声明的最低运行环境工具最低版本要求当前仓库声明Node.js23.10.0npm10.9.2此外由于开发依赖中还包含 Bun用于testBun任务如果计划跑全量检查也建议准备好 Bun 运行时。签出仓库并安装开发依赖git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install当前仓库为镜像如需从镜像签出可git clone https://gitcode.com/gh_mirrors/ti/tinybase后执行相同的npm install。安装完成后即可开始。仓库布局与开发工作流强相关srcTypeScript 源码按模块组织store、checkpoints、indexes、metrics、queries、relationships、persisters/*、synchronizers/*、ui-react/*、ui-solid/*、ui-svelte/*、schematizers/*等test单元测试unit、性能测试perf、生产包测试prod与端到端测试e2esite站点与文档的源内容Markdown 指南、demo、less、UI 组件源码gulpfile.mjs所有npm run脚本背后实际执行的 gulp 任务定义package.json脚本映射、依赖声明。npm install之后所有脚本即可用。注意所有 npm 脚本都只是 gulp 任务的薄封装例如compileForTest: gulp compileForTest因此理解工作流的关键在于读懂 gulpfile.mjs。编译从快速测试到生产发布TinyBase 把编译分成两种模式对应不同的使用场景。快速编译供测试使用npm run compileForTest该任务对应 gulp 的compileForTest通常只需几秒钟。它的目标是生成一份可供测试运行的可执行 JavaScript具体流程见 gulpfile.mjsclearDir(DIST_DIR)清空并重建dist目录copyPackageFiles()生成dist/package.json剔除private、scripts、devEngines、devDependencies重建exports与typesVersions映射、复制LICENSE、readme.md、releases.md与agents.mdcopyDefinitions(DIST_DIR)为每个模块生成类型声明文件types/module/index.d.ts遍历ALL_MODULESgulpfile.mjs 中约 60 个模块从核心store到各类persister、synchronizer、UI 绑定与 schematizer逐个调用compileModule产出dist/module/index.jscheckExportParity()用 TypeScript 编译器比对每个模块运行时导出与声明文件导出的一致性防止运行时有、类型没有或反之。生产编译压缩模块npm run compileForProd对应 gulp 的compileModulesForProdgulpfile.mjs比快速编译多出两件事每个模块额外编译一份min版本dist/min/module/index.js并通过 terser 以toplevel: true, compress: {unsafe: true, passes: 3}做激进压缩最后对产物做 gzipgzipFile压缩级别 9用于核对体积指标每个模块还会生成一份with-schemas变体schema 类型感知的入口。从源码结构看compileModule的构建管线gulpfile.mjs是rollup打包 →rollup-plugin-esbuild目标esnext转译 TS/JSX → 对ui-solid系列模块额外经 Babel solid preset 处理 →rollup/plugin-replace重写 UI 模块导入路径 →rollup/plugin-image内联图片 → 非压缩产物经 prettier 格式化、压缩产物经 terser 压缩。external声明了 react、solid-js、svelte、yjs、expo-sqlite 等运行时依赖不被打包进产物这也是 TinyBase 保持零依赖包体仅 store 模块 gzipped 约 7.3kB的原因之一。编译产物统一落在 dist 目录生产构建还会在其下生成.gz文件测试、类型声明与发布包都以此为准。代码质量类型、Lint 与拼写TypeScript 全量校验npm run tsgulp 的ts任务gulpfile.mjs会做四件事对src、test、site三处分别执行tsChecktsCheck内部用 TypeScript 编译器 API 做全量类型诊断getPreEmitDiagnostics并过滤掉node_modules与test/unit/core/types目录用ts-unused-exports分析tsconfig.json报告未使用的导出未使用导出会直接导致任务失败确保公共 API 面干净额外跑两次svelte-check分别校验src/ui-sveltesvelte.tsconfig.json与test/unit/core/ui-svelte下的 Svelte 组件类型。通常 IDE 会在你编辑时持续做类型检查这个命令适合在提交前一次性验证整个代码库。Lint 与格式化npm run lintlint是series(lintDocs, lintFiles)gulpfile.mjslintDocsgulpfile.mjs专门针对src中.js/.d.ts文件里嵌在文档注释中的代码块正则LINT_BLOCKS匹配 tsx 代码块进行 prettierprintWidth: 75格式检查与 eslint 校验超宽行会被自动重排——这保证了文档中的示例代码和真实源码一样规范lintFilesgulpfile.mjs遍历src、test、site下的.ts、.tsx、.js、.d.ts、.svelte文件先按.prettierrc配置做 prettier 格式化不合规文件会被直接写回修复再用 ESLint 校验配置见 eslint.config.js含 react、solid、svelte 等插件规则。拼写检查npm run spell拼写错误在代码与文档中同样致命。spell任务基于cspellgulpfile.mjs分别对仓库根目录、src、test、site递归执行npx cspell dir/*深层目录用**。词表与忽略规则集中在 cspell.jsonignorePaths排除了*.tsv、*.webp、*.svg、*.snap、*.json、*.test.ts等文件类型words收录了 TinyBase 生态中的专有名词如tinybase、tinyplex、mergeablestore、schematizer、partykit、各 persister 名称等新增术语时需要同步补充到该文件。测试三层防线TinyBase 有三套主要测试单元测试、性能测试、端到端测试。其中单元测试值得一提的特色是它会执行并断言文档中的全部内联代码示例。单元测试npm run testUnit前提是代码已编译dist就绪对应 gulp 的testUnitgulpfile.mjs运行test([test/unit], true)第二参数为true表示开启覆盖率统计Istanbul provider汇总写入 coverage.json。如果在迭代代码过程中想一步到位npm run compileAndTestUnit它等价于series(compileForTest, testUnit)——先快速编译再跑单元测试。若只想聚焦核心模块仓库还提供了testUnitFast/compileAndTestUnitFast仅跑test/unit/core。从 vitest.config.ts 可以看到单元测试被拆分为多个 vitest projectunit、unit-charts、unit-synchronizers、unit-types、unit-documentation、unit-persisters以及专门为 Solidsolid、solid-ssr与 Sveltesvelte组件准备的 project。它们共享happy-dom环境、test/vitest/setup.ts初始化脚本与自定义 reporter并通过sequence.groupOrder控制执行顺序图表、同步器、类型、文档、persister 依次进行persister 测试涉及 PGlite 等真实数据库单独限制为maxWorkers: 2且hookTimeout: 30000。测试文档内联代码的实现在 test/unit/documentation.test.ts该文件 import 了 TinyBase 全系模块含 Automerge、PGlite、TypeBox、ArkType、Zod、Solid、Svelte、React 等运行时用 esbuild/Babel 实时编译文档中的示例代码块并执行断言。因此你在 docs/api 中看到的每一个 API 示例都是可执行的真代码。性能测试npm run testPerf对应test([test/perf])不启用覆盖率。同样有一步到位的compileAndTestPerf。性能测试的核心机制在 test/perf/common.ts 的repeat辅助函数中默认将规模N从stepSize默认maxN / stepsmaxN默认 10000、steps默认 40递增到maxN逐步测量每个规模下的耗时借助asciichart库把[maxes, averages, results]三条曲线渲染成 ASCII 图表输出到控制台图表中红线为允许的最大值maxResult蓝线为实际测量曲线黄线为平均值——只要曲线大体平缓且平均值低于maxResult测试即通过expect(average).toBeLessThan(maxResult)。这正是文档中每个性能测试都会渲染一个相对平缓的 ASCII 图表的来源通过肉眼观察曲线是否突然抬升可以快速发现是否引入了高时间复杂度的算法 bug。具体用例覆盖了 store-create、store-grow、indexes、metrics、queries、relationships 及 mergeable-store 等核心路径。端到端测试端到端测试用于验证站点上所有 demo 真实可用。因为它要驱动完整文档站点前置要求是先做生产编译并生成文档npm run compileForProd npm run compileDocs npm run testE2etestE2e等价于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每个测试文件通过getServerFunctions(port)获得startServer/stopServer/expectPage三件套beforeAll启动、afterAll关闭。服务器实现是 test/server.mjs 的createTestServer基于http-server服务docs目录并做了两处关键处理cache: -1禁用缓存保证每次测试读到最新构建产物、gzip 压缩同时把页面中的https://esm.sh/tinybase依赖重写为本地/pseudo.esm.sh/tinybase对应 pseudo.esm.sh 目录中的伪 CDN 模块使 demo 完全离线可测。用例分为两类页面级断言如 home.test.ts检查标题为TinyBase与 demo 断言如 test/e2e/demos/hello-world.test.ts访问/demos/hello-world/hello-world-vanilla/后断言h1文本并通过expectedFramedElement进入页面 iframe 检查 demo 渲染结果doc-shots.test.ts对文档页面与 demo 逐页截图与仓库中的 PNG 快照逐像素比对防止文档渲染意外回归。仓库还提供了compileAndTestE2eseries(compileForProdAndDocs, testE2e)一条龙脚本以及用 Bun 运行的testBun针对test/unit/persisters/database与test/unit/documentation.test.ts。文档构建与本地预览e2e 测试会自建 web 服务器验证文档站点如果你只是想单独预览 TinyBase 官网则使用npm run compileDocs npm run serveDocs执行后网站会在localhost:8080提供服务。serveDocs是常驻任务建议放到独立终端窗口运行。它同样调用 test/server.mjs 的createTestServer以docs目录为根、8080端口启动服务器实现与 e2e 共用可见 gulpfile.mjs。compileDocs是其中最耗时的一步它会调用compileDocsAndAssets()gulpfile.mjs先用 esbuild 将 site/build.ts 打包为tmp/build.js再执行其build()函数生成 docs 下的全部内容——包括为每个模块从src/types/*/docs.js与index.d.ts中的文档注释生成 API 文档页面这一过程依赖tinydocs工具。因此如果你只想改站点样式或交互可以跳过 API 文档生成npm run compileDocsAssetsOnly该任务对应compileDocsAndAssets(false, false)只编译站点资源less、js、字体、图片等源自 site 目录。如果只改 demo 或指南内容则npm run compileDocsPagesOnly对应compileDocsAndAssets(false)只生成站点页面而不重新生成 API 文档。注意它会移除所有 API 文档所以在最终提交前务必再完整跑一次compileDocs把 API 文档补回来。发布前主检查prePublishPackage在提交代码或发布到 npm 之前prePublishPackage是覆盖一切的超集检查npm run prePublishPackage它在 gulpfile.mjs 中的完整流水线如下串行执行阶段内容npmInstallnpm ci --legacy-peer-deps按锁文件重装依赖compileForTest快速编译 distparallel(lint, spell, ts)并行执行 Lint、拼写、类型检查testBunBun 跑数据库与文档相关测试testUnit全量单元测试含覆盖率testPerf性能测试ASCII 图表compileForProd生产压缩编译compileDocs生成完整文档站点preparePackageForProd生成发布用包元数据testProdattwarethetypeswrong/cli校验包导出与类型声明对 TypeScript 解析器的兼容性 test/prod 生产包导入测试testE2ePlaywright 端到端全量回归如果你的改动较小、只想在提交前快速自查仓库还提供了更轻量的preCommitlint spell ts→compileForTest→testBun→testUnit→compileForProd以及正式发布用的publishPackage在prePublishPackage全部通过后执行npm publish ./dist并自动根据版本号中的预发布标签选择 npm tag见 gulpfile.mjs。开发者工作流速查以下命令覆盖从签出到提交的完整闭环按日常使用频率整理# 环境 git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install # 日常迭代改代码 → 快速编译 → 单测 npm run compileAndTestUnit # 提交前自查 npm run preCommit # 全量验证 / 发布前 npm run prePublishPackage整个流程的设计意图很清晰compileForTest与compileAndTestUnit保证快速反馈ts/lint/spell把类型、风格与拼写问题挡在测试之前testPerf的 ASCII 图表让性能回归一目了然compileDocs e2e 确保文档与 demo 真实可运行最后prePublishPackage在发布边界上做一次全链路把关。按照这套工作流完成改动后就可以放心地提交你的 pull request 了。赞分享数据库后端前端【免费下载链接】tinybaseA reactive data store sync engine.项目地址https://gitcode.com/gh_mirrors/ti/tinybase点击查看免费下载相关推荐Docker Compose 源码构建指南CLI 编译、单元测试、E2E 测试与发布全流程Docker Compose 源码构建指南CLI 编译、单元测试、E2E 测试与发布全流程 本指南以仓库根目录 BUILDING.md https://lin云原生容器编排DevOpsCLIReScript 编译器开发贡献指南从环境搭建、源码构建到测试与发布的全流程实战ReScript 编译器开发贡献指南从环境搭建、源码构建到测试与发布的全流程实战 导读 本指南面向想要参与 ReScript https://link.git编译器编程语言开发工具Pachyderm Python SDK 贡献指南从 Poetry 环境搭建到测试、文档生成与发布全流程Pachyderm Python SDK 贡献指南从 Poetry 环境搭建到测试、文档生成与发布全流程 本指南围绕仓库中的 python sdk/CONTR数据工程后端云原生任务调度微服务上一篇抖音无水印视频下载终极指南douyin-downloader开源工具完全教程下一篇如何在Windows系统上完整启用MacBook Pro Touch Bar专业驱动创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 TinyBase 从源码构建指南：编译、测试、文档生成与发布前全流程
数据库后端前端【免费下载链接】tinybaseA reactive data store sync engine.项目地址https://gitcode.com/gh_mirrors/ti/tinybase点击查看免费下载本篇指南面向希望签出 TinyBase 仓库、从源码自行构建并参与开发的开发者完整介绍 TinyBase 的日常开发工作流从环境准备与依赖安装到快速/生产编译、类型检查与代码质量校验、三套测试体系单元、性能、端到端再到站点文档的生成与本地预览最后是提交与发布前的主检查流程。读完本文你将掌握 TinyBase 仓库中每个 npm 脚本背后的真实实现对应 gulpfile.mjs 中的 gulp 任务并能独立完成一次从零构建到可提 PR 的完整开发循环。环境准备与代码签出TinyBase 的整个开发、构建体系建立在 Node.js 生态之上任务编排统一由 gulp 驱动见仓库根目录的 gulpfile.mjs。在签出代码前请先确认本机满足 package.json 中devEngines声明的最低运行环境工具最低版本要求当前仓库声明Node.js23.10.0npm10.9.2此外由于开发依赖中还包含 Bun用于testBun任务如果计划跑全量检查也建议准备好 Bun 运行时。签出仓库并安装开发依赖git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install当前仓库为镜像如需从镜像签出可git clone https://gitcode.com/gh_mirrors/ti/tinybase后执行相同的npm install。安装完成后即可开始。仓库布局与开发工作流强相关srcTypeScript 源码按模块组织store、checkpoints、indexes、metrics、queries、relationships、persisters/*、synchronizers/*、ui-react/*、ui-solid/*、ui-svelte/*、schematizers/*等test单元测试unit、性能测试perf、生产包测试prod与端到端测试e2esite站点与文档的源内容Markdown 指南、demo、less、UI 组件源码gulpfile.mjs所有npm run脚本背后实际执行的 gulp 任务定义package.json脚本映射、依赖声明。npm install之后所有脚本即可用。注意所有 npm 脚本都只是 gulp 任务的薄封装例如compileForTest: gulp compileForTest因此理解工作流的关键在于读懂 gulpfile.mjs。编译从快速测试到生产发布TinyBase 把编译分成两种模式对应不同的使用场景。快速编译供测试使用npm run compileForTest该任务对应 gulp 的compileForTest通常只需几秒钟。它的目标是生成一份可供测试运行的可执行 JavaScript具体流程见 gulpfile.mjsclearDir(DIST_DIR)清空并重建dist目录copyPackageFiles()生成dist/package.json剔除private、scripts、devEngines、devDependencies重建exports与typesVersions映射、复制LICENSE、readme.md、releases.md与agents.mdcopyDefinitions(DIST_DIR)为每个模块生成类型声明文件types/module/index.d.ts遍历ALL_MODULESgulpfile.mjs 中约 60 个模块从核心store到各类persister、synchronizer、UI 绑定与 schematizer逐个调用compileModule产出dist/module/index.jscheckExportParity()用 TypeScript 编译器比对每个模块运行时导出与声明文件导出的一致性防止运行时有、类型没有或反之。生产编译压缩模块npm run compileForProd对应 gulp 的compileModulesForProdgulpfile.mjs比快速编译多出两件事每个模块额外编译一份min版本dist/min/module/index.js并通过 terser 以toplevel: true, compress: {unsafe: true, passes: 3}做激进压缩最后对产物做 gzipgzipFile压缩级别 9用于核对体积指标每个模块还会生成一份with-schemas变体schema 类型感知的入口。从源码结构看compileModule的构建管线gulpfile.mjs是rollup打包 →rollup-plugin-esbuild目标esnext转译 TS/JSX → 对ui-solid系列模块额外经 Babel solid preset 处理 →rollup/plugin-replace重写 UI 模块导入路径 →rollup/plugin-image内联图片 → 非压缩产物经 prettier 格式化、压缩产物经 terser 压缩。external声明了 react、solid-js、svelte、yjs、expo-sqlite 等运行时依赖不被打包进产物这也是 TinyBase 保持零依赖包体仅 store 模块 gzipped 约 7.3kB的原因之一。编译产物统一落在 dist 目录生产构建还会在其下生成.gz文件测试、类型声明与发布包都以此为准。代码质量类型、Lint 与拼写TypeScript 全量校验npm run tsgulp 的ts任务gulpfile.mjs会做四件事对src、test、site三处分别执行tsChecktsCheck内部用 TypeScript 编译器 API 做全量类型诊断getPreEmitDiagnostics并过滤掉node_modules与test/unit/core/types目录用ts-unused-exports分析tsconfig.json报告未使用的导出未使用导出会直接导致任务失败确保公共 API 面干净额外跑两次svelte-check分别校验src/ui-sveltesvelte.tsconfig.json与test/unit/core/ui-svelte下的 Svelte 组件类型。通常 IDE 会在你编辑时持续做类型检查这个命令适合在提交前一次性验证整个代码库。Lint 与格式化npm run lintlint是series(lintDocs, lintFiles)gulpfile.mjslintDocsgulpfile.mjs专门针对src中.js/.d.ts文件里嵌在文档注释中的代码块正则LINT_BLOCKS匹配 tsx 代码块进行 prettierprintWidth: 75格式检查与 eslint 校验超宽行会被自动重排——这保证了文档中的示例代码和真实源码一样规范lintFilesgulpfile.mjs遍历src、test、site下的.ts、.tsx、.js、.d.ts、.svelte文件先按.prettierrc配置做 prettier 格式化不合规文件会被直接写回修复再用 ESLint 校验配置见 eslint.config.js含 react、solid、svelte 等插件规则。拼写检查npm run spell拼写错误在代码与文档中同样致命。spell任务基于cspellgulpfile.mjs分别对仓库根目录、src、test、site递归执行npx cspell dir/*深层目录用**。词表与忽略规则集中在 cspell.jsonignorePaths排除了*.tsv、*.webp、*.svg、*.snap、*.json、*.test.ts等文件类型words收录了 TinyBase 生态中的专有名词如tinybase、tinyplex、mergeablestore、schematizer、partykit、各 persister 名称等新增术语时需要同步补充到该文件。测试三层防线TinyBase 有三套主要测试单元测试、性能测试、端到端测试。其中单元测试值得一提的特色是它会执行并断言文档中的全部内联代码示例。单元测试npm run testUnit前提是代码已编译dist就绪对应 gulp 的testUnitgulpfile.mjs运行test([test/unit], true)第二参数为true表示开启覆盖率统计Istanbul provider汇总写入 coverage.json。如果在迭代代码过程中想一步到位npm run compileAndTestUnit它等价于series(compileForTest, testUnit)——先快速编译再跑单元测试。若只想聚焦核心模块仓库还提供了testUnitFast/compileAndTestUnitFast仅跑test/unit/core。从 vitest.config.ts 可以看到单元测试被拆分为多个 vitest projectunit、unit-charts、unit-synchronizers、unit-types、unit-documentation、unit-persisters以及专门为 Solidsolid、solid-ssr与 Sveltesvelte组件准备的 project。它们共享happy-dom环境、test/vitest/setup.ts初始化脚本与自定义 reporter并通过sequence.groupOrder控制执行顺序图表、同步器、类型、文档、persister 依次进行persister 测试涉及 PGlite 等真实数据库单独限制为maxWorkers: 2且hookTimeout: 30000。测试文档内联代码的实现在 test/unit/documentation.test.ts该文件 import 了 TinyBase 全系模块含 Automerge、PGlite、TypeBox、ArkType、Zod、Solid、Svelte、React 等运行时用 esbuild/Babel 实时编译文档中的示例代码块并执行断言。因此你在 docs/api 中看到的每一个 API 示例都是可执行的真代码。性能测试npm run testPerf对应test([test/perf])不启用覆盖率。同样有一步到位的compileAndTestPerf。性能测试的核心机制在 test/perf/common.ts 的repeat辅助函数中默认将规模N从stepSize默认maxN / stepsmaxN默认 10000、steps默认 40递增到maxN逐步测量每个规模下的耗时借助asciichart库把[maxes, averages, results]三条曲线渲染成 ASCII 图表输出到控制台图表中红线为允许的最大值maxResult蓝线为实际测量曲线黄线为平均值——只要曲线大体平缓且平均值低于maxResult测试即通过expect(average).toBeLessThan(maxResult)。这正是文档中每个性能测试都会渲染一个相对平缓的 ASCII 图表的来源通过肉眼观察曲线是否突然抬升可以快速发现是否引入了高时间复杂度的算法 bug。具体用例覆盖了 store-create、store-grow、indexes、metrics、queries、relationships 及 mergeable-store 等核心路径。端到端测试端到端测试用于验证站点上所有 demo 真实可用。因为它要驱动完整文档站点前置要求是先做生产编译并生成文档npm run compileForProd npm run compileDocs npm run testE2etestE2e等价于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每个测试文件通过getServerFunctions(port)获得startServer/stopServer/expectPage三件套beforeAll启动、afterAll关闭。服务器实现是 test/server.mjs 的createTestServer基于http-server服务docs目录并做了两处关键处理cache: -1禁用缓存保证每次测试读到最新构建产物、gzip 压缩同时把页面中的https://esm.sh/tinybase依赖重写为本地/pseudo.esm.sh/tinybase对应 pseudo.esm.sh 目录中的伪 CDN 模块使 demo 完全离线可测。用例分为两类页面级断言如 home.test.ts检查标题为TinyBase与 demo 断言如 test/e2e/demos/hello-world.test.ts访问/demos/hello-world/hello-world-vanilla/后断言h1文本并通过expectedFramedElement进入页面 iframe 检查 demo 渲染结果doc-shots.test.ts对文档页面与 demo 逐页截图与仓库中的 PNG 快照逐像素比对防止文档渲染意外回归。仓库还提供了compileAndTestE2eseries(compileForProdAndDocs, testE2e)一条龙脚本以及用 Bun 运行的testBun针对test/unit/persisters/database与test/unit/documentation.test.ts。文档构建与本地预览e2e 测试会自建 web 服务器验证文档站点如果你只是想单独预览 TinyBase 官网则使用npm run compileDocs npm run serveDocs执行后网站会在localhost:8080提供服务。serveDocs是常驻任务建议放到独立终端窗口运行。它同样调用 test/server.mjs 的createTestServer以docs目录为根、8080端口启动服务器实现与 e2e 共用可见 gulpfile.mjs。compileDocs是其中最耗时的一步它会调用compileDocsAndAssets()gulpfile.mjs先用 esbuild 将 site/build.ts 打包为tmp/build.js再执行其build()函数生成 docs 下的全部内容——包括为每个模块从src/types/*/docs.js与index.d.ts中的文档注释生成 API 文档页面这一过程依赖tinydocs工具。因此如果你只想改站点样式或交互可以跳过 API 文档生成npm run compileDocsAssetsOnly该任务对应compileDocsAndAssets(false, false)只编译站点资源less、js、字体、图片等源自 site 目录。如果只改 demo 或指南内容则npm run compileDocsPagesOnly对应compileDocsAndAssets(false)只生成站点页面而不重新生成 API 文档。注意它会移除所有 API 文档所以在最终提交前务必再完整跑一次compileDocs把 API 文档补回来。发布前主检查prePublishPackage在提交代码或发布到 npm 之前prePublishPackage是覆盖一切的超集检查npm run prePublishPackage它在 gulpfile.mjs 中的完整流水线如下串行执行阶段内容npmInstallnpm ci --legacy-peer-deps按锁文件重装依赖compileForTest快速编译 distparallel(lint, spell, ts)并行执行 Lint、拼写、类型检查testBunBun 跑数据库与文档相关测试testUnit全量单元测试含覆盖率testPerf性能测试ASCII 图表compileForProd生产压缩编译compileDocs生成完整文档站点preparePackageForProd生成发布用包元数据testProdattwarethetypeswrong/cli校验包导出与类型声明对 TypeScript 解析器的兼容性 test/prod 生产包导入测试testE2ePlaywright 端到端全量回归如果你的改动较小、只想在提交前快速自查仓库还提供了更轻量的preCommitlint spell ts→compileForTest→testBun→testUnit→compileForProd以及正式发布用的publishPackage在prePublishPackage全部通过后执行npm publish ./dist并自动根据版本号中的预发布标签选择 npm tag见 gulpfile.mjs。开发者工作流速查以下命令覆盖从签出到提交的完整闭环按日常使用频率整理# 环境 git clone gitgithub.com:tinyplex/tinybase.git cd tinybase npm install # 日常迭代改代码 → 快速编译 → 单测 npm run compileAndTestUnit # 提交前自查 npm run preCommit # 全量验证 / 发布前 npm run prePublishPackage整个流程的设计意图很清晰compileForTest与compileAndTestUnit保证快速反馈ts/lint/spell把类型、风格与拼写问题挡在测试之前testPerf的 ASCII 图表让性能回归一目了然compileDocs e2e 确保文档与 demo 真实可运行最后prePublishPackage在发布边界上做一次全链路把关。按照这套工作流完成改动后就可以放心地提交你的 pull request 了。赞分享数据库后端前端【免费下载链接】tinybaseA reactive data store sync engine.项目地址https://gitcode.com/gh_mirrors/ti/tinybase点击查看免费下载相关推荐Docker Compose 源码构建指南CLI 编译、单元测试、E2E 测试与发布全流程Docker Compose 源码构建指南CLI 编译、单元测试、E2E 测试与发布全流程 本指南以仓库根目录 BUILDING.md https://lin云原生容器编排DevOpsCLIReScript 编译器开发贡献指南从环境搭建、源码构建到测试与发布的全流程实战ReScript 编译器开发贡献指南从环境搭建、源码构建到测试与发布的全流程实战 导读 本指南面向想要参与 ReScript https://link.git编译器编程语言开发工具Pachyderm Python SDK 贡献指南从 Poetry 环境搭建到测试、文档生成与发布全流程Pachyderm Python SDK 贡献指南从 Poetry 环境搭建到测试、文档生成与发布全流程 本指南围绕仓库中的 python sdk/CONTR数据工程后端云原生任务调度微服务上一篇抖音无水印视频下载终极指南douyin-downloader开源工具完全教程下一篇如何在Windows系统上完整启用MacBook Pro Touch Bar专业驱动创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考