…allation (#4283)

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please select the option that is relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

[ ] Windows
[ ] macOS
[x] Linux (Ubuntu 24.04)

If you checked Linux, please specify the distro and version.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

[x] I have updated website/src/pages/changelog.mdx with details of this PR
[x] My code follows the general coding style of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes

Summary by CodeRabbit

New Features
- Automatically runs dependency tidy-up after initializing a new project, ensuring cleaner project setup.
- Added an option to skip running dependency tidy-up during project initialization.
Documentation
- Updated changelog to reflect the new automatic dependency tidy-up feature.
- Clarified CLI documentation to explain the new skip option for module tidying during initialization.

May 16 '25 18:05 triadmoko

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

A new helper function was introduced to run go mod tidy automatically after initializing a project, with an option to skip this step via a new flag. Documentation and changelog were updated to reflect this behavior, and a new boolean flag was added to the relevant struct for controlling the feature.

Changes

Cohort / File(s)	Change Summary
Go Mod Tidy Helper & Integration `v3/internal/templates/templates.go`	Added `goModTidy` helper function to execute `go mod tidy` in project directory; integrated call in `Install` with skip logic; reordered imports.
Init Command Flag `v3/internal/flags/init.go`	Introduced `SkipGoModTidy` boolean field to `Init` struct for controlling `go mod tidy` execution.
CLI Documentation `docs/src/content/docs/guides/cli.mdx`	Updated `init` command documentation to note `go mod tidy` execution and new `-skipgomodtidy` flag.
Changelog Update `v3/UNRELEASED_CHANGELOG.md`	Added entry for automatic `go mod tidy` after `wails init` and adjusted header level.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Templates
    participant OS

    User->>CLI: Run "wails init"
    CLI->>Templates: Call Install(options)
    Templates->>Templates: Extract template files
    Templates->>Templates: Clean up temp directories
    alt SkipGoModTidy is false
        Templates->>OS: Execute "go mod tidy" in project dir
        OS-->>Templates: Return output or error
        Templates-->>CLI: Return error if go mod tidy fails
    else SkipGoModTidy is true
        Templates->>Templates: Skip go mod tidy
    end
    Templates-->>CLI: Complete Install
    CLI-->>User: Project initialized

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

wailsapp/wails#4286: Adds the same goModTidy function and integrates it into the Install function with the SkipGoModTidy flag, making it directly related at the code level.

Suggested reviewers

leaanthony

Poem

🐇
Hopped into templates, what did I find?
A helper for tidy, to keep things aligned!
With a skip flag to choose,
And docs to peruse,
Now wails init is streamlined!
🚀✨

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 71f7a4d9f63f50161db7195b0d947fba5a6036fb and 94c7f0bb8faf72ec3d4064986b7df809edad8b1a.

📒 Files selected for processing (1)

v3/UNRELEASED_CHANGELOG.md (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

[ ] Create PR with unit tests
[ ] Post copyable unit tests in a comment

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

May 16 '25 18:05 coderabbitai[bot]

Thanks for taking the time to open this 🙏 Could you please add a flag for the init command to skip this? Something like -nogomodtidy. If possible, please update the doc at docs/src/content/docs/guides/cli.mdx. Thanks again 🙏

May 16 '25 23:05 leaanthony

Thanks for taking the time to open this 🙏 Could you please add a flag for the init command to skip this? Something like -nogomodtidy. If possible, please update the doc at docs/src/content/docs/guides/cli.mdx. Thanks again 🙏

ok. i have added explanation in the file

May 19 '25 03:05 triadmoko

We will need to have a way of disabling this automatic behaviour. Perhaps a -skipgomodtidy command in init?

May 19 '25 11:05 leaanthony