Repomix 开源贡献指南从环境搭建、代码规范到提交 PR 与发布流程【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomixRepomix 是一款将整个代码仓库打包为单个 AI 友好文件的命令行工具方便把代码库喂给 Claude、ChatGPT、DeepSeek、Gemini 等大语言模型。本文基于仓库内的开发者贡献指南website/client/src/es/guide/development/index.md及根目录 CONTRIBUTING.md系统讲解如何参与 Repomix 的开发包括本地环境搭建、开发命令速查、编码规范、测试与 lint 体系、Nix/Docker 开发方式、项目目录结构、网站开发以及版本发布流程。读完本文你将具备独立为 Repomix 提交高质量 Pull Request 的完整能力。参与贡献的多种方式Repomix 欢迎任何形式的参与并不局限于写代码。官方指南列出的贡献途径包括给仓库点 Star表达对项目的支持帮助项目获得更多曝光创建 Issue发现 Bug、有新功能想法时通过 Issue 与维护者沟通提交 Pull Request发现问题或想改进的地方直接提交 PR对外推广在社交媒体、博客或技术社区分享 Repomix 的使用经验实际使用把 Repomix 集成到自己的项目中真实场景的反馈最有价值赞助通过成为赞助者支持项目长期发展。其中代码贡献的核心路径是「先讨论、后实现」。根据 CONTRIBUTING.md 的约定对于新功能、行为变更或非平凡的修复建议先创建 Issue 或在该 Issue 下评论与维护者对齐设计与范围后再动手写代码避免双方重复劳动——未经过事先讨论的 PR 可能被直接关闭。本地开发环境搭建环境要求前置条件开发 Repomix 需要以下工具工具版本要求说明Node.js≥ 22.0.0见根目录 package.json 中engines字段这是硬性约束Git任意较新版本克隆仓库与版本管理npm随 Node.js 附带依赖安装与脚本执行要求 ≥ 1.22.22见engines.yarnDocker可选用于容器化运行或本地启动文档网站快速开始git clone https://gitcode.com/GitHub_Trending/rep/repomix.git cd repomix npm install # 运行 CLI会自动先构建再执行 npm run repomixnpm run repomix实际执行的是node --run build node --enable-source-maps --trace-warnings bin/repomix.cjs见 package.json即先通过 TypeScript 编译产出lib/目录再启动 CLI 入口脚本。由于prepare钩子绑定了npm run build在npm install时也会自动触发一次构建。开发命令速查Repomix 的全部开发脚本集中在根目录 package.json 的scripts字段常用命令如下# 构建清空 lib/ 后执行 tsc 编译 npm run build # 运行 CLI等价于 npm run repomix npm run repomix # 运行测试Vitest默认 watch: false npm run test # 运行测试并生成覆盖率报告text/json/html 三种格式 npm run test-coverage # 运行全部 lint 检查 npm run lint值得说明的是npm run lint并非单一检查而是串联了四层工具链lint: node --run lint-biome node --run lint-oxlint node --run lint-ts node --run lint-secretlint lint-biome: biome check --write lint-oxlint: oxlint --fix lint-ts: tsc --noEmit lint-secretlint: secretlint **/* --secretlintignore .gitignore即依次执行Biome格式与 lint自动写入修复、oxlint快速 JS/TS lint自动修复、tsc --noEmit类型检查以及secretlint扫描代码中是否泄漏密钥、token 等敏感信息。四层全部通过才算通过 lint这也是提交 PR 前的硬性门槛。此外还有一些实用脚本npm run repomix-src仅打包src与tests目录用于自举验证npm run repomix-website仅打包website目录npm run bench构建后使用 hyperfine 对 CLI 做 10 轮基准测试npm run memory-check运行 CLI 并输出内存占用信息。编码规范与代码风格Repomix 的代码风格要求非常明确官方指南与 CONTRIBUTING.md 共同规定了以下几点使用 Biome 进行 lint 与格式化Biome 是项目的统一格式化与静态检查工具具体规则见根目录 biome.json缩进使用 2 个空格indentStyle: space、indentWidth: 2行宽上限 120 字符lineWidth: 120JavaScript 采用单引号、行尾分号、尾逗号quoteStyle: single、semicolons: always、trailingCommas: all覆盖范围包括src、tests、website、browser、.github等目录及所有package.json/tsconfig.json并显式排除了构建产物目录.vitepress/dist、server/dist、browser/dist等。依赖注入DI以提升可测试性从源码结构看src/core/file/fileProcess.ts、src/core/packager.ts 等核心模块大量采用依赖注入模式将文件收集、内容处理、输出生成等阶段解耦这也是测试能够稳定覆盖各环节的基础。保持单个文件不超过 250 行这是项目刻意维持的约束配合依赖注入保证每个模块职责单一、易于阅读和评审。新功能必须附带测试新增或修改功能时必须在tests/下补齐对应测试用例。测试体系Vitest 与镜像式目录结构Repomix 使用 Vitestexport default defineConfig({ test: { globals: true, environment: node, include: [tests/**/*.test.ts], setupFiles: [tests/testing/vitestSetup.ts], coverage: { include: [src/**/*], exclude: [src/index.ts], reporter: [text, json, html], }, watch: false, testTimeout: 15000, }, });关键点测试文件统一放在tests/目录下且目录结构与src/一一镜像例如 src/core/metrics/TokenCounter.ts 对应 tests/core/metrics/TokenCounter.test.ts覆盖率统计范围是src/**/*但排除了src/index.ts入口文件仅做导出转发覆盖率支持text终端、json、html三种报告格式npm run test-coverage会生成 html 报告便于人工查看分支覆盖情况单测超时上限 15 秒适合文件处理、tree-sitter 解析等较重场景。运行方式npm run test # 运行全部测试 npm run test-coverage # 运行测试并输出覆盖率提交 Pull Request 的规范按照 CONTRIBUTING.md 与开发者指南提交 PR 前必须完成以下检查清单通过全部测试执行npm run test通过全部 lint 检查执行npm run lint即上述四层检查全部通过更新文档如果新增或修改了功能需同步更新 README 及相应文档指南约定只需更新英文版多语言翻译由维护者统一处理遵循既有代码风格保持 250 行/文件、依赖注入、注释规范等既有约定。此外为减少维护成本新功能或行为变更请先开 Issue 讨论方向再提交 PR。使用 Nix 进行可复现开发如果你安装了支持 flakes 的 Nix可以直接进入一个预置了 Node.js 24 和 Git 的可复现开发环境nix develop该 shell 由仓库根目录的 flake.nix 定义环境内容为pkgs.nodejs_24Node.js 24pkgs.git进入 shell 时自动打印 Node/npm 版本提示并提醒依次执行npm ci、npm run build在 shell 内标准 npm 工作流即可按预期运行npm ci npm run build npm run test npm run lint注意该开发 shell 是用于开发 Repomix 本身而不是把 Repomix 作为 CLI 安装到全局使用。使用 Docker 开发与运行构建镜像并运行# 构建镜像 docker build -t repomix . # 运行容器将当前目录挂载到 /app docker run -v ./:/app -it --rm repomix镜像设计要点根目录 Dockerfile 揭示了镜像的关键设计基础镜像为node:22-slim并额外安装git与ca-certificates——因为 Repomix 支持处理远程 Git 仓库容器内必须包含 Git 客户端构建阶段执行npm ci后通过npm link将 Repomix 链接为全局命令随后npm prune --omitdev移除开发依赖以压缩镜像体积工作目录切到/app即挂载卷位置并用repomix --version与repomix --help验证安装正确性容器入口ENTRYPOINT直接是repomix因此docker run -v ./:/app -it --rm repomix等价于在/app目录下执行 repomix 命令。项目目录结构解析官方指南给出了项目顶层结构结合当前仓库实际内容可以进一步细化src/ ├── cli/ # CLI 实现cliRun、cliReport、cliSpinner、actions 等 ├── config/ # 配置加载与 schema 校验configLoad、configSchema ├── core/ # 核心功能 │ ├── file/ # 文件收集与处理fileCollect、fileProcess、fileRead、fileSearch 等 │ ├── git/ # Git 集成远程仓库解析、归档拉取、diff/log 处理 │ ├── metrics/ # 指标计算与 token 统计TokenCounter、calculateFileMetrics 等 │ ├── output/ # 输出生成markdown/plain/xml 风格、outputGenerate、outputSplit │ ├── packager/ # 打包主流程produceOutput、writeOutputToDisk │ ├── security/ # 安全扫描securityCheck、secretlint worker、过滤不可信文件 │ ├── skill/ # Agent Skill 打包生成 │ ├── tokenCount/ # token 计数结构构建 │ └── treeSitter/ # 基于 tree-sitter 的代码结构解析支持多种语言查询 ├── mcp/ # MCP 服务器集成mcpServer、tools、pathScope └── shared/ # 共享工具asyncMap、logger、patternUtils、processConcurrency 等 tests/ # 与 src/ 结构一一镜像的测试目录 website/ # 文档网站 ├── client/ # 前端Vue 组件、按语言组织的 guide 文档、composables └── server/ # 后端 APICloudflare Worker 风格含 wrangler.jsonc 配置 browser/ # 浏览器扩展WXT 框架background/content scripts scripts/ # 辅助脚本与基准测试bench-cores.sh 等作为印证src/index.ts 对外导出了核心 API包括打包入口pack、文件收集collectFiles、搜索searchFiles、Git 远程地址解析、安全扫描runSecurityCheck、token 计数TokenCounter、tree-sitter 解析parseFile、配置加载loadFileConfig与defineConfig以及 CLI 入口runCli等可以作为理解各模块职责的索引。文档网站开发Repomix 的文档网站位于website/目录前端部分website/client包含 Vue 组件如Home.vue、TryIt.vue、Hero.vue等以及按 14 种语言组织的指南文档website/client/src/zh-cn/guide 等后端website/server提供打包 API 服务。启动本地网站开发服务器需要 Dockernpm run website # 访问 http://localhost:5173/npm run website实际执行的是docker compose -f website/compose.yml build --no-cache docker compose -f website/compose.yml up即通过 Docker Compose 同时拉起前后端。文档维护约定更新文档时只需先更新英文版website/client/src/en/guide其他语言的翻译工作由维护者统一负责贡献者无需自行维护多语言。版本发布流程发布操作由维护者执行但贡献者了解流程有助于理解版本节奏# 1. 更新版本号patch / minor / major 三选一 npm version patch # 或 minor / major # 2. 运行测试与构建验证 npm run test-coverage npm run build # 3. 发布到 npm npm publishnpm version patch|minor|major会同时更新 package.json 中的version字段并打 Git tag发布前必须通过覆盖率测试与构建构建产物为lib/TypeScript 编译输出发布文件清单files字段包含lib/、bin/、README.md与LICENSE新版本由维护者统一管理如果认为有必要发布新版本请先开 Issue 讨论而不是自行发布。遇到问题怎么办遇到 Bug 或功能建议创建 Issue 描述问题想与社区交流加入 Discord 频道地址见开发者指南末尾不确定如何贡献先阅读 CONTRIBUTING.md 与本文再从小而清晰的改动如修复文档、补充测试开始。Repomix 的核心哲学是「把代码库变成 LLM 可理解的形式」而贡献者的每一次 PR 都在让这个工具对 AI 时代开发者更友好。按照本文的规范完成环境搭建、编码、测试与提交流程你就能顺利成为 Repomix 的贡献者。【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
Repomix 开源贡献指南：从环境搭建、代码规范到提交 PR 与发布流程
Repomix 开源贡献指南从环境搭建、代码规范到提交 PR 与发布流程【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomixRepomix 是一款将整个代码仓库打包为单个 AI 友好文件的命令行工具方便把代码库喂给 Claude、ChatGPT、DeepSeek、Gemini 等大语言模型。本文基于仓库内的开发者贡献指南website/client/src/es/guide/development/index.md及根目录 CONTRIBUTING.md系统讲解如何参与 Repomix 的开发包括本地环境搭建、开发命令速查、编码规范、测试与 lint 体系、Nix/Docker 开发方式、项目目录结构、网站开发以及版本发布流程。读完本文你将具备独立为 Repomix 提交高质量 Pull Request 的完整能力。参与贡献的多种方式Repomix 欢迎任何形式的参与并不局限于写代码。官方指南列出的贡献途径包括给仓库点 Star表达对项目的支持帮助项目获得更多曝光创建 Issue发现 Bug、有新功能想法时通过 Issue 与维护者沟通提交 Pull Request发现问题或想改进的地方直接提交 PR对外推广在社交媒体、博客或技术社区分享 Repomix 的使用经验实际使用把 Repomix 集成到自己的项目中真实场景的反馈最有价值赞助通过成为赞助者支持项目长期发展。其中代码贡献的核心路径是「先讨论、后实现」。根据 CONTRIBUTING.md 的约定对于新功能、行为变更或非平凡的修复建议先创建 Issue 或在该 Issue 下评论与维护者对齐设计与范围后再动手写代码避免双方重复劳动——未经过事先讨论的 PR 可能被直接关闭。本地开发环境搭建环境要求前置条件开发 Repomix 需要以下工具工具版本要求说明Node.js≥ 22.0.0见根目录 package.json 中engines字段这是硬性约束Git任意较新版本克隆仓库与版本管理npm随 Node.js 附带依赖安装与脚本执行要求 ≥ 1.22.22见engines.yarnDocker可选用于容器化运行或本地启动文档网站快速开始git clone https://gitcode.com/GitHub_Trending/rep/repomix.git cd repomix npm install # 运行 CLI会自动先构建再执行 npm run repomixnpm run repomix实际执行的是node --run build node --enable-source-maps --trace-warnings bin/repomix.cjs见 package.json即先通过 TypeScript 编译产出lib/目录再启动 CLI 入口脚本。由于prepare钩子绑定了npm run build在npm install时也会自动触发一次构建。开发命令速查Repomix 的全部开发脚本集中在根目录 package.json 的scripts字段常用命令如下# 构建清空 lib/ 后执行 tsc 编译 npm run build # 运行 CLI等价于 npm run repomix npm run repomix # 运行测试Vitest默认 watch: false npm run test # 运行测试并生成覆盖率报告text/json/html 三种格式 npm run test-coverage # 运行全部 lint 检查 npm run lint值得说明的是npm run lint并非单一检查而是串联了四层工具链lint: node --run lint-biome node --run lint-oxlint node --run lint-ts node --run lint-secretlint lint-biome: biome check --write lint-oxlint: oxlint --fix lint-ts: tsc --noEmit lint-secretlint: secretlint **/* --secretlintignore .gitignore即依次执行Biome格式与 lint自动写入修复、oxlint快速 JS/TS lint自动修复、tsc --noEmit类型检查以及secretlint扫描代码中是否泄漏密钥、token 等敏感信息。四层全部通过才算通过 lint这也是提交 PR 前的硬性门槛。此外还有一些实用脚本npm run repomix-src仅打包src与tests目录用于自举验证npm run repomix-website仅打包website目录npm run bench构建后使用 hyperfine 对 CLI 做 10 轮基准测试npm run memory-check运行 CLI 并输出内存占用信息。编码规范与代码风格Repomix 的代码风格要求非常明确官方指南与 CONTRIBUTING.md 共同规定了以下几点使用 Biome 进行 lint 与格式化Biome 是项目的统一格式化与静态检查工具具体规则见根目录 biome.json缩进使用 2 个空格indentStyle: space、indentWidth: 2行宽上限 120 字符lineWidth: 120JavaScript 采用单引号、行尾分号、尾逗号quoteStyle: single、semicolons: always、trailingCommas: all覆盖范围包括src、tests、website、browser、.github等目录及所有package.json/tsconfig.json并显式排除了构建产物目录.vitepress/dist、server/dist、browser/dist等。依赖注入DI以提升可测试性从源码结构看src/core/file/fileProcess.ts、src/core/packager.ts 等核心模块大量采用依赖注入模式将文件收集、内容处理、输出生成等阶段解耦这也是测试能够稳定覆盖各环节的基础。保持单个文件不超过 250 行这是项目刻意维持的约束配合依赖注入保证每个模块职责单一、易于阅读和评审。新功能必须附带测试新增或修改功能时必须在tests/下补齐对应测试用例。测试体系Vitest 与镜像式目录结构Repomix 使用 Vitestexport default defineConfig({ test: { globals: true, environment: node, include: [tests/**/*.test.ts], setupFiles: [tests/testing/vitestSetup.ts], coverage: { include: [src/**/*], exclude: [src/index.ts], reporter: [text, json, html], }, watch: false, testTimeout: 15000, }, });关键点测试文件统一放在tests/目录下且目录结构与src/一一镜像例如 src/core/metrics/TokenCounter.ts 对应 tests/core/metrics/TokenCounter.test.ts覆盖率统计范围是src/**/*但排除了src/index.ts入口文件仅做导出转发覆盖率支持text终端、json、html三种报告格式npm run test-coverage会生成 html 报告便于人工查看分支覆盖情况单测超时上限 15 秒适合文件处理、tree-sitter 解析等较重场景。运行方式npm run test # 运行全部测试 npm run test-coverage # 运行测试并输出覆盖率提交 Pull Request 的规范按照 CONTRIBUTING.md 与开发者指南提交 PR 前必须完成以下检查清单通过全部测试执行npm run test通过全部 lint 检查执行npm run lint即上述四层检查全部通过更新文档如果新增或修改了功能需同步更新 README 及相应文档指南约定只需更新英文版多语言翻译由维护者统一处理遵循既有代码风格保持 250 行/文件、依赖注入、注释规范等既有约定。此外为减少维护成本新功能或行为变更请先开 Issue 讨论方向再提交 PR。使用 Nix 进行可复现开发如果你安装了支持 flakes 的 Nix可以直接进入一个预置了 Node.js 24 和 Git 的可复现开发环境nix develop该 shell 由仓库根目录的 flake.nix 定义环境内容为pkgs.nodejs_24Node.js 24pkgs.git进入 shell 时自动打印 Node/npm 版本提示并提醒依次执行npm ci、npm run build在 shell 内标准 npm 工作流即可按预期运行npm ci npm run build npm run test npm run lint注意该开发 shell 是用于开发 Repomix 本身而不是把 Repomix 作为 CLI 安装到全局使用。使用 Docker 开发与运行构建镜像并运行# 构建镜像 docker build -t repomix . # 运行容器将当前目录挂载到 /app docker run -v ./:/app -it --rm repomix镜像设计要点根目录 Dockerfile 揭示了镜像的关键设计基础镜像为node:22-slim并额外安装git与ca-certificates——因为 Repomix 支持处理远程 Git 仓库容器内必须包含 Git 客户端构建阶段执行npm ci后通过npm link将 Repomix 链接为全局命令随后npm prune --omitdev移除开发依赖以压缩镜像体积工作目录切到/app即挂载卷位置并用repomix --version与repomix --help验证安装正确性容器入口ENTRYPOINT直接是repomix因此docker run -v ./:/app -it --rm repomix等价于在/app目录下执行 repomix 命令。项目目录结构解析官方指南给出了项目顶层结构结合当前仓库实际内容可以进一步细化src/ ├── cli/ # CLI 实现cliRun、cliReport、cliSpinner、actions 等 ├── config/ # 配置加载与 schema 校验configLoad、configSchema ├── core/ # 核心功能 │ ├── file/ # 文件收集与处理fileCollect、fileProcess、fileRead、fileSearch 等 │ ├── git/ # Git 集成远程仓库解析、归档拉取、diff/log 处理 │ ├── metrics/ # 指标计算与 token 统计TokenCounter、calculateFileMetrics 等 │ ├── output/ # 输出生成markdown/plain/xml 风格、outputGenerate、outputSplit │ ├── packager/ # 打包主流程produceOutput、writeOutputToDisk │ ├── security/ # 安全扫描securityCheck、secretlint worker、过滤不可信文件 │ ├── skill/ # Agent Skill 打包生成 │ ├── tokenCount/ # token 计数结构构建 │ └── treeSitter/ # 基于 tree-sitter 的代码结构解析支持多种语言查询 ├── mcp/ # MCP 服务器集成mcpServer、tools、pathScope └── shared/ # 共享工具asyncMap、logger、patternUtils、processConcurrency 等 tests/ # 与 src/ 结构一一镜像的测试目录 website/ # 文档网站 ├── client/ # 前端Vue 组件、按语言组织的 guide 文档、composables └── server/ # 后端 APICloudflare Worker 风格含 wrangler.jsonc 配置 browser/ # 浏览器扩展WXT 框架background/content scripts scripts/ # 辅助脚本与基准测试bench-cores.sh 等作为印证src/index.ts 对外导出了核心 API包括打包入口pack、文件收集collectFiles、搜索searchFiles、Git 远程地址解析、安全扫描runSecurityCheck、token 计数TokenCounter、tree-sitter 解析parseFile、配置加载loadFileConfig与defineConfig以及 CLI 入口runCli等可以作为理解各模块职责的索引。文档网站开发Repomix 的文档网站位于website/目录前端部分website/client包含 Vue 组件如Home.vue、TryIt.vue、Hero.vue等以及按 14 种语言组织的指南文档website/client/src/zh-cn/guide 等后端website/server提供打包 API 服务。启动本地网站开发服务器需要 Dockernpm run website # 访问 http://localhost:5173/npm run website实际执行的是docker compose -f website/compose.yml build --no-cache docker compose -f website/compose.yml up即通过 Docker Compose 同时拉起前后端。文档维护约定更新文档时只需先更新英文版website/client/src/en/guide其他语言的翻译工作由维护者统一负责贡献者无需自行维护多语言。版本发布流程发布操作由维护者执行但贡献者了解流程有助于理解版本节奏# 1. 更新版本号patch / minor / major 三选一 npm version patch # 或 minor / major # 2. 运行测试与构建验证 npm run test-coverage npm run build # 3. 发布到 npm npm publishnpm version patch|minor|major会同时更新 package.json 中的version字段并打 Git tag发布前必须通过覆盖率测试与构建构建产物为lib/TypeScript 编译输出发布文件清单files字段包含lib/、bin/、README.md与LICENSE新版本由维护者统一管理如果认为有必要发布新版本请先开 Issue 讨论而不是自行发布。遇到问题怎么办遇到 Bug 或功能建议创建 Issue 描述问题想与社区交流加入 Discord 频道地址见开发者指南末尾不确定如何贡献先阅读 CONTRIBUTING.md 与本文再从小而清晰的改动如修复文档、补充测试开始。Repomix 的核心哲学是「把代码库变成 LLM 可理解的形式」而贡献者的每一次 PR 都在让这个工具对 AI 时代开发者更友好。按照本文的规范完成环境搭建、编码、测试与提交流程你就能顺利成为 Repomix 的贡献者。【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
