Skip to content

Major Refactor and New Features: Modularization, Enhanced CLI, and Logging#20

Merged
mufeedvh merged 38 commits intomufeedvh:mainfrom
ODAncona:main
May 30, 2024
Merged

Major Refactor and New Features: Modularization, Enhanced CLI, and Logging#20
mufeedvh merged 38 commits intomufeedvh:mainfrom
ODAncona:main

Conversation

@ODAncona
Copy link
Copy Markdown
Collaborator

@ODAncona ODAncona commented May 26, 2024

Hello,

I've found your tool incredibly useful and have contributed some enhancements to extend its functionality:

Enhancements and New Features:

  • Improved Include/Exclude Capabilities: Implemented with glob patterns for flexible file selection.
  • New CLI Options:
    • --include: Specify patterns to include files.
    • --exclude: Specify patterns to exclude files.
    • --include-priority: Prioritize file inclusion in conflicts.
    • --no-clipboard: Disable clipboard usage, ideal for remote installations.
  • Cross-Compatibility Clipboard Integration: Integrated arboard for cross-platform support.

Code Improvements:

  • Code Refactoring: Reorganized the codebase into modules (git, lib, main, token, template, path, filter) for better readability and maintainability.
  • Function Renaming and Relocation: Updated function names and locations for clarity.
  • Consolidation of CLI Options: Merged various CLI options into --include and --exclude for simplicity.

Quality Assurance:

  • Unit Tests: Added tests to ensure reliability and ease future testing.
  • Enhanced Error Handling: Improved using 'anyhow' for better context in debugging.
  • Logging: Implemented logging with the 'log' crate for enhanced traceability.

Documentation:

  • Comprehensive Documentation: Added to enhance usability and support future development.

Semantic Versioning:
Due to breaking API changes

  • Current Version: 1.0.0
  • New Version: 2.0.0

Migration Notes:

  • CLI Changes: Users should transition to the new --include and --exclude options, replacing the previous filtering options.

Thank you for creating such a fantastic tool! I hope these improvements further enhance its capabilities.

Best regards,

Olivier D'Ancona


@ODAncona ODAncona marked this pull request as draft May 29, 2024 07:28
@ODAncona ODAncona marked this pull request as ready for review May 29, 2024 07:51
@ODAncona ODAncona changed the title code2prompt improved Major Refactor and New Features: Modularization, Enhanced CLI, and Logging May 29, 2024
@ODAncona ODAncona marked this pull request as draft May 29, 2024 08:06
@ODAncona ODAncona marked this pull request as ready for review May 29, 2024 08:07
@mufeedvh
Copy link
Copy Markdown
Owner

Hi @ODAncona, this is incredible, thank you so much! I've reviewed the changes and everything LGTM! Merging right away! ❤️ 🙌

Will prepare the v2.0.0 release candidate shortly! 🎉

@mufeedvh mufeedvh merged commit 96b3a8e into mufeedvh:main May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants