From 55503dd2cd7a91fc4dceba3d936e6c0f6122d704 Mon Sep 17 00:00:00 2001 From: Yamada Dev Date: Sat, 8 Feb 2025 11:12:29 +0900 Subject: [PATCH] chore: update release note section in repomix-instruction.md --- .github/copilot-instructions.md | 199 +++++++++++++++++++++++++++++++ repomix-instruction.md | 200 +++++++++++++++++++++----------- 2 files changed, 330 insertions(+), 69 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2c8e5ada..c82f22a1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -22,3 +22,202 @@ ``` - Mock dependencies by passing test doubles through deps object - Use vi.mock() only when dependency injection is not feasible + +# Generate Comprehensive Output +- Include all content without abbreviation, unless specified otherwise +- Optimize for handling large codebases while maintaining output quality + +# GitHub Release Note Guidelines +Here are some examples of release notes that follow the guidelines: + +v0.2.25 +````md +This release brings significant improvements to output formatting and introduces flexible remote repository handling capabilities along with enhanced logging features. + +# Improvements ⚡ + +## Remote Repository Enhancement (#335) +- Added branch/tag parsing directly from repository URLs: +```bash +repomix --remote https://github.com/yamadashy/repomix/tree/0.1.x +``` +Functions identically to: +```bash +repomix --remote https://github.com/yamadashy/repomix --remote-branch 0.1.x +``` + +Special thanks to @huy-trn for implementing this user-friendly feature! + +## Enhanced Output Formatting (#328, #329, #330) +- Added "End of Codebase" marker for better clarity in output +- Improved output header accuracy: + - Better representation of codebase scope + - Clear indication when using `--include` or `--ignore` options + +Special thanks to @gitkenan for adding the "End of Codebase" marker and reporting the header issue! + +## Path Pattern Support (#337) +- Added support for special characters in paths: + - Handles parentheses in include patterns (e.g., `src/(categories)/**/*`) + - Improved escaping for `[]` and `{}` + - Essential for Next.js route groups and similar frameworks + +Thank you @matheuscoelhomalta for improving path pattern support! + +# How to Update + +```bash +npm update -g repomix +``` + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. +```` + +v0.2.24 +````md +This release significantly enhances configuration flexibility with comprehensive CLI flag support and expands default ignore patterns for better project scaffolding. + +# What's New 🚀 + +## CLI Flags Revolution (#324) +- New command-line configuration now available. + +``` +- `--no-gitignore`: Disable .gitignore file usage +- `--no-default-patterns`: Disable default patterns +- `--header-text `: Custom text to include in the file header +- `--instruction-file-path `: Path to a file containing detailed custom instructions +- `--include-empty-directories`: Include empty directories in the output +``` + +Special recognition to @massdo for driving ecosystem growth. + +# Improvements ⚡ + +## Enhanced Ignore Patterns (#318, #322) +- Expanded default ignores for Rust projects: + - `target/`, `Cargo.lock`, build artifacts + - PHP, Ruby, Go, Elixir, Haskell: package manager lock files + +To @boralg for helping curate Rust-specific patterns! + +# How to Update +```bash +npm update -g repomix +``` + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. +```` + +v0.2.23 +````md +This release adds significant performance improvements for large repositories, making Repomix faster and more efficient when needed. + +# Improvements ⚡ + +## Parallel Processing Enhancement (#309) +- Implemented worker threads using [Piscina](https://github.com/piscinajs/piscina) for parallel processing + +### Benchmark Results +- `yamadashy.repomix`: No significant change + - Before: 868.73 millis + - After: 671.26 millis +- `facebook/react`: 29x faster + - Before: 123.31 secs + - After: 4.19 secs +- `vercel/next.js`: 58x faster + - Before: 17.85 mins + - After: 17.27 secs + +Note: While Repomix is not primarily designed for processing large repositories, and speed is not a primary goal, faster processing can provide a better user experience when working with larger codebases. + +# How to Update + +```bash +npm update -g repomix +``` + + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. +```` + +v0.2.22 +````md +This release introduces significant improvements to large file handling and expands the Repomix ecosystem with new tools and community channels. + +# Improvements ⚡ + +## Improved Large File Handling (#302) + +- Added a file size limit check (50MB) to prevent memory issues +- Graceful error handling for large files with clear user guidance: + +Special thanks to @slavashvets for their continued contributions! + +# Ecosystem Growth 🤝 + +## New VS Code Extension (#300) +A community-created VS Code extension "Repomix Runner" is now available: +- Run Repomix directly from VS Code +- Extension by @massdo: [View on VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=DorianMassoulier.repomix-runner) + +Thank you @massdo for bringing Repomix to VS Code and expanding our tooling ecosystem! + +## Official Social Media +- Launched official Repomix X (Twitter) account: [@repomix_ai](https://x.com/repomix_ai) + - Follow for updates, tips, and community highlights + +# How to Update + +```bash +npm update -g repomix +``` + +--- + +Join our growing community on [Discord](https://discord.gg/BF8GxZHE2C) and follow us on [X](https://x.com/repomix_ai) for updates! +```` + +v0.2.21 +````md +This release introduces significant improvements to output formatting and documentation, featuring a new parsable style option for enhanced XML handling. + +# What's New 🚀 + +## Enhanced Output Style Control (#287) +- Added new `parsableStyle` option for better output handling: + - Ensures output strictly follows the specification of the chosen format + - Provides properly escaped XML output with fast-xml-parser + - Dynamically adjusts markdown code block delimiters to avoid content conflicts +- Available via CLI flag `--parsable-style` or in configuration file + +Special thanks to @atollk for their first contribution! + +# Documentation 📚 + +## README Enhancements (#296) +- Updated Homebrew installation documentation to include Linux support + +Special thanks to @chenrui333 for their continued contributions! + +## Website Multi-Language Support (#293) +- Enhanced multi-language support in [repomix.com](https://repomix.com) + +# How to Update + +To update to the latest version, run: +```bash +npm update -g repomix +``` + + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. +```` diff --git a/repomix-instruction.md b/repomix-instruction.md index e7adb290..c82f22a1 100644 --- a/repomix-instruction.md +++ b/repomix-instruction.md @@ -30,32 +30,41 @@ # GitHub Release Note Guidelines Here are some examples of release notes that follow the guidelines: -v0.1.40 +v0.2.25 ````md -This release introduces improvements to file handling and output formatting, enhancing Repomix's functionality and user experience. +This release brings significant improvements to output formatting and introduces flexible remote repository handling capabilities along with enhanced logging features. -## Improvements +# Improvements ⚡ -### Enhanced Markdown Support (#86, #95) +## Remote Repository Enhancement (#335) +- Added branch/tag parsing directly from repository URLs: +```bash +repomix --remote https://github.com/yamadashy/repomix/tree/0.1.x +``` +Functions identically to: +```bash +repomix --remote https://github.com/yamadashy/repomix --remote-branch 0.1.x +``` -- Improved code block formatting in Markdown output: - - Added language identifiers to code blocks for better syntax highlighting - - Extended support for various file extensions to improve language detection -- Dynamic output file extension: - - The extension of the output file now changes based on the selected style (e.g., `.md` for Markdown, `.xml` for XML) - - This behavior only applies when no specific output file path is provided by the user +Special thanks to @huy-trn for implementing this user-friendly feature! -### Enhanced Exclusion of Package Manager Lock Files (#90, #94) +## Enhanced Output Formatting (#328, #329, #330) +- Added "End of Codebase" marker for better clarity in output +- Improved output header accuracy: + - Better representation of codebase scope + - Clear indication when using `--include` or `--ignore` options -- Improved exclusion of common package manager lock files: - - npm: `package-lock.json` - - Yarn: `yarn.lock` - - pnpm: `pnpm-lock.yaml` - - These files are now automatically excluded from the packed output, including those in subdirectories +Special thanks to @gitkenan for adding the "End of Codebase" marker and reporting the header issue! -## How to Update +## Path Pattern Support (#337) +- Added support for special characters in paths: + - Handles parentheses in include patterns (e.g., `src/(categories)/**/*`) + - Improved escaping for `[]` and `{}` + - Essential for Next.js route groups and similar frameworks -To update to the latest version, run: +Thank you @matheuscoelhomalta for improving path pattern support! + +# How to Update ```bash npm update -g repomix @@ -63,99 +72,152 @@ npm update -g repomix --- -We value your feedback and contributions in making Repomix better! If you encounter any issues or have suggestions, please share them through our GitHub issues. +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. ```` -v0.1.38 +v0.2.24 ````md -This release introduces a new Markdown output style, providing users with an additional option for formatting their repository content. +This release significantly enhances configuration flexibility with comprehensive CLI flag support and expands default ignore patterns for better project scaffolding. -## What's New +# What's New 🚀 -### Markdown Output Style (#86, #87) +## CLI Flags Revolution (#324) +- New command-line configuration now available. -- Added new 'markdown' output style option - - Users can now generate output in Markdown format, alongside existing plain text and XML options +``` +- `--no-gitignore`: Disable .gitignore file usage +- `--no-default-patterns`: Disable default patterns +- `--header-text `: Custom text to include in the file header +- `--instruction-file-path `: Path to a file containing detailed custom instructions +- `--include-empty-directories`: Include empty directories in the output +``` -## How to Use +Special recognition to @massdo for driving ecosystem growth. -To use the new Markdown output style, use the `--style markdown` option: +# Improvements ⚡ -```bash -repomix --style markdown -``` +## Enhanced Ignore Patterns (#318, #322) +- Expanded default ignores for Rust projects: + - `target/`, `Cargo.lock`, build artifacts + - PHP, Ruby, Go, Elixir, Haskell: package manager lock files -Or update your `repomix.config.json`: +To @boralg for helping curate Rust-specific patterns! -```json -{ - "output": { - "style": "markdown" - } -} +# How to Update +```bash +npm update -g repomix ``` --- -To update, simply run: +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. +```` + +v0.2.23 +````md +This release adds significant performance improvements for large repositories, making Repomix faster and more efficient when needed. + +# Improvements ⚡ + +## Parallel Processing Enhancement (#309) +- Implemented worker threads using [Piscina](https://github.com/piscinajs/piscina) for parallel processing + +### Benchmark Results +- `yamadashy.repomix`: No significant change + - Before: 868.73 millis + - After: 671.26 millis +- `facebook/react`: 29x faster + - Before: 123.31 secs + - After: 4.19 secs +- `vercel/next.js`: 58x faster + - Before: 17.85 mins + - After: 17.27 secs + +Note: While Repomix is not primarily designed for processing large repositories, and speed is not a primary goal, faster processing can provide a better user experience when working with larger codebases. + +# How to Update + ```bash npm update -g repomix ``` -As always, we appreciate your feedback and contributions to make Repomix even better! If you encounter any issues or have suggestions regarding this new feature, please let us know through our GitHub issues. + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. ```` -v0.1.36 +v0.2.22 ````md -This release introduces a new configuration option that allows users to control the security check feature, providing more flexibility in how Repomix handles sensitive information detection. +This release introduces significant improvements to large file handling and expands the Repomix ecosystem with new tools and community channels. -## What's New +# Improvements ⚡ -### Configurable Security Check (#74, #75) +## Improved Large File Handling (#302) -- Added new configuration option `security.enableSecurityCheck` (default: `true`) - - Users can now disable the security check when needed, such as when working with cryptographic libraries or known false positives +- Added a file size limit check (50MB) to prevent memory issues +- Graceful error handling for large files with clear user guidance: -## How to Use +Special thanks to @slavashvets for their continued contributions! -To **disable** the security check, add the following to your `repomix.config.json`: +# Ecosystem Growth 🤝 -```json -{ - "security": { - "enableSecurityCheck": false - } -} -``` +## New VS Code Extension (#300) +A community-created VS Code extension "Repomix Runner" is now available: +- Run Repomix directly from VS Code +- Extension by @massdo: [View on VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=DorianMassoulier.repomix-runner) -**Note:** Disabling the security check may expose sensitive information. Use this option with caution and only when necessary. +Thank you @massdo for bringing Repomix to VS Code and expanding our tooling ecosystem! ---- +## Official Social Media +- Launched official Repomix X (Twitter) account: [@repomix_ai](https://x.com/repomix_ai) + - Follow for updates, tips, and community highlights + +# How to Update -To update, simply run: ```bash npm update -g repomix ``` -As always, we appreciate your feedback and contributions to make Repomix even better! If you encounter any issues or have suggestions regarding this new feature, please let us know through our GitHub issues. +--- + +Join our growing community on [Discord](https://discord.gg/BF8GxZHE2C) and follow us on [X](https://x.com/repomix_ai) for updates! ```` -v0.1.32 +v0.2.21 ````md -This release focuses on improving performance and user experience, particularly when processing large repositories. +This release introduces significant improvements to output formatting and documentation, featuring a new parsable style option for enhanced XML handling. -## Bug Fixes -### Fixed an issue where the application appeared to hang (#63, #65) +# What's New 🚀 -- Fixed an issue where the application appeared to hang during the security check process on large repositories. -- Reduced the impact on the event loop to prevent hanging when processing a large number of files. -- Implemented more frequent console updates during file processing and security checks. +## Enhanced Output Style Control (#287) +- Added new `parsableStyle` option for better output handling: + - Ensures output strictly follows the specification of the chosen format + - Provides properly escaped XML output with fast-xml-parser + - Dynamically adjusts markdown code block delimiters to avoid content conflicts +- Available via CLI flag `--parsable-style` or in configuration file ---- -To update, simply run: -``` +Special thanks to @atollk for their first contribution! + +# Documentation 📚 + +## README Enhancements (#296) +- Updated Homebrew installation documentation to include Linux support + +Special thanks to @chenrui333 for their continued contributions! + +## Website Multi-Language Support (#293) +- Enhanced multi-language support in [repomix.com](https://repomix.com) + +# How to Update + +To update to the latest version, run: +```bash npm update -g repomix ``` -As always, we appreciate your feedback and contributions to make Repomix even better! + +--- + +As always, if you encounter any issues or have suggestions, please let us know through our GitHub issues or join our [Discord community](https://discord.gg/wNYzTwZFku) for support. ````