search

hay-kot / scaffold

A cookie cutter alternative with in-project scaffolding for generating components, controllers, or other common code patterns.
https://hay-kot.github.io/scaffold/
MIT License
63 stars 8 forks source link

feat: update subdirectory support #224

Closed hay-kot closed 1 month ago

hay-kot commented 1 month ago

Closes #4 Closes #1

To Do's

Summary by CodeRabbit

hay-kot commented 1 month ago

@coderabbitai - review this pr

coderabbitai[bot] commented 1 month ago

@hay-kot: I will review this PR.

:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve multiple modifications across various files, primarily focusing on enhancing functionality and structure. Key updates include the introduction of new methods and types, such as Package, ListTree, and Version, as well as improvements to existing methods like List, New, and Update. Additionally, the .gitignore file has been updated to ignore specific files. The overall changes aim to improve the organization and handling of scaffolds, versioning, and repository interactions.

Changes

File Change Summary
.gitignore Added entries for .env and .cache, adjusted formatting, and included a comment for the vendor/ directory.
app/commands/cmd_list.go Updated List method to create a structured list of system scaffolds using printer.ListTree.
app/commands/cmd_new.go Modified New method for better handling of project names and refined fuzzyFallBack method for scaffold matching.
app/commands/cmd_update.go Changed Update method to consistently reference s.Root instead of s for scaffolds.
app/scaffold/pkgs/cloner.go Updated Clone method signatures in Cloner interface and ClonerFunc type to include a new version parameter.
app/scaffold/pkgs/list.go Introduced PackageList struct and updated ListSystem function to return a slice of PackageList.
app/scaffold/pkgs/pkgs.go Added Package struct and methods for managing package information, and revamped ParseRemote function.
app/scaffold/pkgs/pkgs_test.go Renamed and updated tests for parsing remote repository paths to reflect new behavior.
app/scaffold/pkgs/pkgurl/url.go Introduced Parts struct for parsed URLs and added parsing functionality.
app/scaffold/pkgs/resolver.go Enhanced NewResolver and resolveRemote methods to handle versioning and improved path handling.
app/scaffold/pkgs/resolver_test.go Updated ClonerFunc signature in tests to include version parameter.
app/scaffold/pkgs/update.go Added Update function to handle updating Git repositories.
app/scaffold/pkgs/version.go Introduced Version struct and methods for managing versioning information.
internal/printer/printer.go Added ListTree type and method for hierarchical printing of lists.
taskfile.yml Added environment variable entry for .env and adjusted formatting for existing entries.

Assessment against linked issues

Objective Addressed Explanation
Determine what version is pulled by default? (#4) ✅
Support repository tags (#1) ✅

🐰 In the garden where ideas bloom,
New structures rise, dispelling gloom.
With trees of lists and packages bright,
Our code now dances, a joyful sight!
Versioning clear, paths defined,
A rabbit's delight, in code aligned! 🐇✨

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): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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.