docs: Add bundling guide for library usage#1075
Conversation
…languages Add bundling documentation explaining external dependencies (tinypool, tiktoken) and WASM file requirements for all 12 language versions of the library usage guide.
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughThis pull request adds documentation for bundling Repomix across multiple language versions of the library usage guide, specifying external dependencies and WASM file handling requirements for tools like Rolldown and esbuild. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary of ChangesHello @yamadashy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by adding a comprehensive guide on how to properly bundle Repomix when integrating it as a library. The new documentation clarifies the handling of specific external dependencies and WebAssembly (WASM) files, which are crucial for successful integration with modern bundlers like Rolldown or esbuild. This ensures that developers can more easily and correctly set up Repomix in their projects, improving the overall developer experience and reducing potential integration issues. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation on how to bundle Repomix when used as a library. The changes are clear and have been applied consistently across multiple languages. I have a couple of minor suggestions to improve consistency and adhere to file formatting best practices.
Code ReviewSummaryThis is a well-structured documentation-only PR that adds bundling guidance for library users. The documentation is accurate, comprehensive, and properly localized across all 14 language versions. ✅ Strengths
📝 Minor ObservationsDetailsSlight wording inconsistency between README and website docs:
The website version with "required" is clearer. Consider aligning README.md with this wording for consistency. This is minor and non-blocking. Placement in Indonesian version: 🔍 Premortem AnalysisPotential Failure Scenarios & Mitigations
✅ VerdictApproved - This PR improves the developer experience for library users with accurate and well-organized documentation. The checklist items (lint, test) are marked complete, and since this is documentation-only, there are no code changes to review for bugs or security issues. The translations appear accurate and maintain technical precision across all language versions. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1075 +/- ##
=======================================
Coverage 87.19% 87.19%
=======================================
Files 116 116
Lines 4350 4350
Branches 1011 1011
=======================================
Hits 3793 3793
Misses 557 557 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (1)
1740-1748: Consider adding brief context for why dependencies/WASM files need special handling.The bundling section is clear and actionable, but adding a one-line explanation of why
tinypoolandtiktokencannot be bundled (e.g., "runtime dependencies") would help users understand the requirements without needing to consult the example.🔎 Example enhancement (optional)
**External dependencies (cannot be bundled):** -- `tinypool` - Spawns worker threads using file paths -- `tiktoken` - Loads WASM files dynamically at runtime +- `tinypool` — Spawns worker threads using file paths (runtime dependency) +- `tiktoken` — Dynamically loads WASM modules at runtime (runtime dependency)Alternatively, add a brief intro:
+When bundling repomix with tools like Rolldown or esbuild, some dependencies must remain external (because they require runtime file/module loading) and WASM files need to be copied: + **External dependencies (cannot be bundled):**website/client/src/ja/guide/development/using-repomix-as-a-library.md (1)
84-96: Consider adding links to bundler documentation for improved guidance.While the bundling requirements are clearly stated, users unfamiliar with Rolldown or esbuild configuration might benefit from direct references to official documentation. This is optional but could improve the user experience for developers less familiar with these tools.
Consider adding inline links to:
- Rolldown's external/externals configuration: https://rolldown.rs/guide/configure-bundler (or latest docs)
- esbuild's external option: https://esbuild.github.io/api/#external
Alternatively, you could add a brief note like: "See your bundler's documentation for configuring external dependencies" after the bullet point about
tinypoolandtiktoken.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
README.mdwebsite/client/src/de/guide/development/using-repomix-as-a-library.mdwebsite/client/src/en/guide/development/using-repomix-as-a-library.mdwebsite/client/src/es/guide/development/using-repomix-as-a-library.mdwebsite/client/src/fr/guide/development/using-repomix-as-a-library.mdwebsite/client/src/hi/guide/development/using-repomix-as-a-library.mdwebsite/client/src/id/guide/development/using-repomix-as-a-library.mdwebsite/client/src/it/guide/development/using-repomix-as-a-library.mdwebsite/client/src/ja/guide/development/using-repomix-as-a-library.mdwebsite/client/src/ko/guide/development/using-repomix-as-a-library.mdwebsite/client/src/pt-br/guide/development/using-repomix-as-a-library.mdwebsite/client/src/ru/guide/development/using-repomix-as-a-library.mdwebsite/client/src/vi/guide/development/using-repomix-as-a-library.mdwebsite/client/src/zh-cn/guide/development/using-repomix-as-a-library.mdwebsite/client/src/zh-tw/guide/development/using-repomix-as-a-library.md
🧰 Additional context used
🪛 LanguageTool
website/client/src/es/guide/development/using-repomix-as-a-library.md
[grammar] ~88-~88: Cambia la palabra o signo.
Context: ...cias externas (no se pueden empaquetar):** - tinypool - Genera hilos de trabajo usando rutas d...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_SPACE)
[grammar] ~89-~89: Cambia la palabra o signo.
Context: ...ilos de trabajo usando rutas de archivos - tiktoken - Carga archivos WASM dinámicamente en t...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_OTHER)
[grammar] ~90-~90: Aquí puede haber un error.
Context: ...ASM dinámicamente en tiempo de ejecución Archivos WASM a copiar: - `web-tree-si...
(QB_NEW_ES)
[grammar] ~92-~92: Cambia la palabra o signo.
Context: ... de ejecución Archivos WASM a copiar: - web-tree-sitter.wasm → Mismo directorio que el JS empaquetado...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_SPACE)
[grammar] ~93-~93: Cambia la palabra o signo.
Context: ...para la función de compresión de código) - Archivos de lenguaje Tree-sitter → Direc...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_SPACE)
[grammar] ~94-~94: Aquí puede haber un error.
Context: ... especificado por la variable de entorno REPOMIX_WASM_DIR Para un ejemplo funcional, consulta [web...
(QB_NEW_ES)
website/client/src/fr/guide/development/using-repomix-as-a-library.md
[grammar] ~86-~86: Il y a peut-être une erreur ici
Context: ...ernes et les fichiers WASM doivent être copiés : **Dépendances externes (ne peuvent pas êtr...
(QB_NEW_FR)
[typographical] ~88-~88: Le trait d’union est employé sans espaces pour former des mots, alors que le tiret est encadré par des espaces et placé entre deux mots distincts.
Context: ...externes (ne peuvent pas être bundlées) :** - tinypool - Lance des threads de travail en utilisa...
(TIRET)
[style] ~89-~89: Une autre structure plus directe dynamisera votre phrase.
Context: ...inypool- Lance des threads de travail en utilisant des chemins de fichiers -tiktoken` - ...
(EN_UTILISANT)
[style] ~89-~89: Un tiret long ou un autre signe de ponctuation plus approprié, car le trait d’union ne s’utilise que pour former un mot.
Context: ... de travail en utilisant des chemins de fichiers - tiktoken - Charge les fichiers WASM dynamiquement à l'exé...
(TIRET_LONG_1)
[grammar] ~90-~90: Il y a peut-être une erreur ici
Context: ...ichiers WASM dynamiquement à l'exécution Fichiers WASM à copier : - `web-tree-s...
(QB_NEW_FR)
[grammar] ~92-~92: Envisagez un remplacement
Context: ...uement à l'exécution Fichiers WASM à copier : - web-tree-sitter.wasm → Même répertoire que le JS bundlé (requis pou...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_SPACE_
__
)
website/client/src/id/guide/development/using-repomix-as-a-library.md
[grammar] ~258-~258: Ensure spelling is correct
Context: ...m` → Direktori yang sama dengan JS yang dibundle (diperlukan untuk fitur kompresi kode) ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
website/client/src/de/guide/development/using-repomix-as-a-library.md
[grammar] ~88-~88: Korrigiere die Fehler
Context: ...gkeiten (können nicht gebündelt werden):** - tinypool - Startet Worker-Threads unter Verwendung...
(QB_NEW_DE_OTHER_ERROR_IDS_REPLACEMENT_MULTITOKEN)
[grammar] ~89-~89: Entferne das Symbol
Context: ...Threads unter Verwendung von Dateipfaden - tiktoken - Lädt WASM-Dateien dynamisch zur Laufzei...
(QB_NEW_DE_OTHER_ERROR_IDS_UNNECESSARY_OTHER)
[grammar] ~92-~92: Korrigiere das Wort
Context: ...dynamisch zur Laufzeit Zu kopierende WASM-Dateien: - web-tree-sitter.wasm → Gleiches Verzeichnis wie das gebündelt...
(QB_NEW_DE_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_SPACE)
[grammar] ~96-~96: Hier könnte ein Fehler sein.
Context: ...unter website/server/scripts/bundle.mjs. ## Reales Beispiel Die Repomix-Website ([r...
(QB_NEW_DE)
website/client/src/pt-br/guide/development/using-repomix-as-a-library.md
[locale-violation] ~96-~96: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...um exemplo funcional, consulte [website/server/scripts/bundle.mjs](https://github.com/...
(PT_BARBARISMS_REPLACE_SERVER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)
- GitHub Check: Build and run (macos-latest, 24.x)
- GitHub Check: Build and run (windows-latest, 25.x)
- GitHub Check: Test (ubuntu-latest, 22.x)
- GitHub Check: Test (ubuntu-latest, 25.x)
- GitHub Check: Test (macos-latest, 22.x)
- GitHub Check: Test (windows-latest, 25.x)
- GitHub Check: Build and run (windows-latest, 24.x)
- GitHub Check: Test (macos-latest, 24.x)
- GitHub Check: Test (windows-latest, 22.x)
- GitHub Check: Build and run (macos-latest, 20.x)
- GitHub Check: Build and run (macos-latest, 25.x)
- GitHub Check: Test (windows-latest, 24.x)
- GitHub Check: Test coverage
- GitHub Check: claude-review
- GitHub Check: Cloudflare Pages
🔇 Additional comments (17)
website/client/src/es/guide/development/using-repomix-as-a-library.md (1)
84-96: Documentation content is accurate and complete. ✓The "Bundling" section clearly explains:
- External dependencies that cannot be bundled (tinypool, tiktoken) with concise rationales
- WASM files requiring special handling (web-tree-sitter.wasm and Tree-sitter language files) with their placement requirements
- A helpful reference to the working example implementation
The information aligns with the PR objectives and provides sufficient guidance for developers integrating Repomix with bundlers like Rolldown or esbuild.
Minor: Address LanguageTool grammar warnings for consistency.
The static analysis tool flagged several spacing/punctuation suggestions on lines 88–94 related to list item formatting. While these may be false positives related to how Markdown list syntax is interpreted, you may want to review them to ensure the Spanish grammar and formatting meet your style guide. The most flagged issues appear to be around the dash (–) character in list items.
If you'd like, I can help verify that the Spanish grammar and punctuation conform to standard conventions. Would you like me to check the other language versions of this guide for consistency?
website/client/src/it/guide/development/using-repomix-as-a-library.md (2)
84-96: Verify bundler names: Rollup vs Rolldown discrepancy.The PR objectives mention "Rollup or esbuild," but the documentation specifies "Rolldown or esbuild" (line 86). Rollup and Rolldown are distinct bundlers—confirm whether this change is intentional or if the documentation should align with the PR objectives.
Since this bundling section is mirrored across multiple language versions, also verify that all language versions consistently reference the same bundler name.
84-96: Well-structured bundling documentation with clear guidance.The Bundling section provides clear, actionable guidance:
- Explains why external dependencies must remain unbundled (file paths, dynamic WASM loading)
- Specifies where WASM files must be placed (adjacent directory and environment-variable-specified directory)
- References a concrete working example for developers to follow
The Italian localization is grammatically correct and idiomatically appropriate. The inclusion of specific rationale for external dependencies (e.g., "spawns worker threads using file paths," "loads WASM files dynamically at runtime") helps developers understand the constraints.
website/client/src/vi/guide/development/using-repomix-as-a-library.md (1)
307-319: Documentation clearly and accurately covers bundling requirements.The new Bundling section is well-structured, clearly identifies external dependencies (tinypool, tiktoken) and WASM files that require special handling (web-tree-sitter.wasm, Tree-sitter language files via REPOMIX_WASM_DIR), and references a working example. The Vietnamese translation is natural and consistent with the rest of the document.
Please verify that the
REPOMIX_WASM_DIRenvironment variable is documented elsewhere in the guide or codebase so users understand its purpose and expected value. If it is not yet documented, consider adding a brief explanation of what this variable should contain.website/client/src/zh-tw/guide/development/using-repomix-as-a-library.md (1)
84-96: Bundling section content is clear and well-structured.The explanation of external dependencies and WASM file handling is concise and actionable. Terminology and formatting are consistent with the existing documentation style.
To ensure completeness, please verify that the referenced example at
website/server/scripts/bundle.mjsexists and is accessible from the main branch.website/client/src/id/guide/development/using-repomix-as-a-library.md (1)
249-261: Bundling section is clear and consistently aligned with other language versions.The Indonesian translation is idiomatic and the technical details (external dependencies, WASM file handling, REPOMIX_WASM_DIR) are accurately conveyed. The static analysis hint flagging English orthography on Indonesian text is a false positive and can be safely ignored.
As with the other language versions, please verify that
website/server/scripts/bundle.mjsexists and is properly referenced.website/client/src/zh-cn/guide/development/using-repomix-as-a-library.md (1)
84-96: Bundling section is well-written and maintains consistency across language versions.The Simplified Chinese translation is accurate and idiomatic. Technical requirements for external dependencies and WASM file handling are clearly communicated and aligned with the other language versions.
Please verify that the example file at
website/server/scripts/bundle.mjsexists and is accessible in the repository.website/client/src/en/guide/development/using-repomix-as-a-library.md (1)
84-96: Well-structured bundling documentation with clear guidance.The Bundling section is clear, concise, and provides essential information for library consumers using bundlers. The distinction between external dependencies and WASM file handling is well-explained, and the reference to the working example is helpful.
website/client/src/ko/guide/development/using-repomix-as-a-library.md (1)
84-96: Korean translation is accurate and well-localized.The Korean version properly translates the bundling guidance while maintaining technical accuracy. Environment variables and package names are appropriately preserved, and the overall structure mirrors the English version for consistency.
website/client/src/de/guide/development/using-repomix-as-a-library.md (1)
84-96: Review German grammar and formatting detected by LanguageTool.The German version has been flagged by automated grammar checking at multiple locations (lines 88–89, 92, 96). While the content is understandable, please review and correct these grammar/punctuation issues to maintain documentation quality. Common issues appear to involve list formatting, word spacing, and punctuation between list items.
README.md (2)
1738-1738: Verify bundler name consistency: "Rolldown" vs. "Rollup".Line 1738 mentions "Rolldown" but the PR objectives reference "Rollup or esbuild". Please confirm whether this is intentional (possibly a newer/alternative bundler) or should be corrected to match the PR description.
1736-1748: The GitHub link to the working example is valid and accessible.The file at
website/server/scripts/bundle.mjsexists and is publicly accessible at the provided URL, returning HTTP 200 status.website/client/src/hi/guide/development/using-repomix-as-a-library.md (1)
208-220: Bundling section is clear and well-integrated.The new section provides essential bundling guidance with proper structure: external dependencies (tinypool, tiktoken) with brief explanations of why they cannot be bundled, WASM files to copy (web-tree-sitter.wasm and Tree-sitter language files), environment variable guidance (REPOMIX_WASM_DIR), and a reference to a working example. The Hindi translation is consistent with the rest of the document. Placement before the "What's next?" section is logical and maintains document flow.
website/client/src/pt-br/guide/development/using-repomix-as-a-library.md (1)
84-95: Bundling section is clear and well-structured.The new bundling documentation provides clear guidance on external dependencies and WASM file handling. The technical details are accurate and properly formatted for user reference. The section effectively communicates the requirements for bundling Repomix with tools like Rolldown and esbuild.
website/client/src/ru/guide/development/using-repomix-as-a-library.md (1)
84-96: No issues detected. The referenced example file exists, and "Rolldown" is used consistently across the English version, Russian translation, README, and all other language versions of the guide.website/client/src/ja/guide/development/using-repomix-as-a-library.md (1)
84-96: Well-structured bundling guide with verified accuracy.The new section effectively documents the bundling constraints and WASM file handling requirements. All verification confirms the content is technically sound:
- The referenced
website/server/scripts/bundle.mjsfile exists and is a production-ready example that correctly configurestinypoolandtiktokenas external dependencies- Bundling sections are consistently present across multiple language versions (en, fr, de, es, it, ko, pt-br, ru, vi, zh-cn, zh-tw)
- Documentation accurately reflects the bundler configuration requirements shown in the actual implementation
The section is clear, properly formatted, and follows the existing document structure.
website/client/src/fr/guide/development/using-repomix-as-a-library.md (1)
84-96: Content is accurate, well-structured, and requires no changes.The bundling section correctly documents external dependencies (tinypool, tiktoken), required WASM files, and references the working example. The French grammar and punctuation are correct, and the formatting is consistent with all other language versions (de, en, es, it, pt-br, ru, etc.).
website/client/src/pt-br/guide/development/using-repomix-as-a-library.md
Show resolved
Hide resolved
Change "for code compression feature" to "required for code compression feature" for consistency with other documentation pages as suggested in PR review.
Deploying repomix with
|
| Latest commit: |
bca6992
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fe3574f1.repomix.pages.dev |
| Branch Preview URL: | https://docs-library-bundling-guide.repomix.pages.dev |
Code Review UpdateSummaryThis documentation-only PR adds comprehensive bundling guidance for library users across the README and 14 localized website documentation versions. ✅ Assessment: ApprovedThe changes are well-structured and technically accurate:
AI Bot Comment EvaluationCodeRabbit suggestions (nitpicks):
Gemini Code Assist: Summary only, no actionable inline comments Premortem Analysis
VerdictThis PR improves developer experience with clear, accurate bundling documentation. No blocking issues identified. |
Add release notes for v1.11.1 covering: - Multi-root directory labels (#1024) - Non-interactive skill generation options (#1022) - Remote git command timeout fix (#1078) - CLI output visibility fix for light themes (#1088) - Library bundling documentation (#1075) Improve release note generation guidelines: - Clarify "What's New" vs "Improvements" usage - Add rule to include related issue numbers with PRs - Add rule to include links in documentation sections
1 participant
Add documentation explaining how to bundle Repomix when using it as a library with tools like Rolldown or esbuild.
Changes
Content
The bundling guide explains:
tinypool- spawns worker threads using file pathstiktoken- loads WASM files dynamically at runtimeweb-tree-sitter.wasm→ same directory as bundled JS (for code compression)REPOMIX_WASM_DIRwebsite/server/scripts/bundle.mjsChecklist
npm run testnpm run lint(Documentation-only change, no code changes)