search

yamadashy / repomix

📦 Repomix (formerly Repopack) 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, and Gemini.
MIT License
4.36k stars 202 forks source link

Refactor Styles & OutputGenerate functions to streamline generation process #129

Closed iNerdStack closed 1 month ago

iNerdStack commented 1 month ago

This refactor fixes the duplication of renderContext and the generation process for each style while maintaining functionality.

All Changes

  1. Modified outputGenerate.ts:

    • Added a new createRenderContext function
    • Centralized template compilation and rendering in generateOutput function

  2. plainStyle.ts, xmlStyle.ts, and markdownStyle.ts now return template strings

  3. Updated tests to reflect new changes:

    • Modified tests function for all styles
    • Ensured tests cover template structure, placeholder presence, and correct rendering

    All existing tests have been updated, passed and manually tested to ensure output remains consistent with previous versions

related: #125

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces significant changes to the output generation functionality in the codebase. It replaces existing direct style generation functions with template retrieval functions that utilize Handlebars for rendering. A new function, `createRenderContext`, is added to encapsulate the context creation for templating. The modifications affect multiple files, including the removal of older style generation methods and the introduction of new template functions for Markdown, plain text, and XML outputs. Corresponding test files are updated to reflect these changes. ## Changes | File Path | Change Summary | |------------------------------------------|-------------------------------------------------------------------------------------------------------------| | `src/core/output/outputGenerate.ts` | Introduced `createRenderContext`, modified `generateOutput` to use Handlebars templates for output generation. | | `src/core/output/outputStyles/markdownStyle.ts` | Replaced `generateMarkdownStyle` with `getMarkdownTemplate`, which returns a markdown template string directly. | | `src/core/output/outputStyles/plainStyle.ts` | Removed `generatePlainStyle`, added `getPlainTemplate` that returns a plain text template string. | | `src/core/output/outputStyles/xmlStyle.ts` | Replaced `generateXmlStyle` with `getXmlTemplate`, returning a direct XML template string. | | `tests/core/output/outputStyles/markdownStyle.test.ts` | Updated tests to use `generateOutput` instead of `generateMarkdownStyle`. | | `tests/core/output/outputStyles/plainStyle.test.ts` | Updated tests to use `generateOutput` instead of `generatePlainStyle`. | | `tests/core/output/outputStyles/xmlStyle.test.ts` | Updated tests to use `generateOutput` instead of `generateXmlStyle`. | ## Possibly related issues - **yamadashy/repopack#125**: The changes in this PR centralize the render context and style generation logic, addressing the issue's proposal to move common logic into a shared utility file. ## Possibly related PRs - **#87**: Introduces a new Markdown output style, directly related to the enhancements made in this PR. - **#95**: Improves markdown style generation, aligning with the focus on template retrieval functions. - **#126**: Allows "markdown" as a valid configuration option, relevant to the new Markdown output generation capabilities introduced in this PR.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
yamadashy commented 1 month ago

@iNerdStack Thank you so much for this implementation! The changes look great at first glance.

I'll review the changes in detail when I get home.

Thanks again for your contribution to Repopack!

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 76.01%. Comparing base (f43d35e) to head (12dce72). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #129 +/- ## ========================================== - Coverage 76.40% 76.01% -0.39% ========================================== Files 36 36 Lines 1653 1618 -35 Branches 266 267 +1 ========================================== - Hits 1263 1230 -33 + Misses 390 388 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yamadashy commented 1 month ago

@iNerdStack The changes look perfect and address exactly what I was aiming for with this refactor.

I'll merge this. Thanks!