Add goModTidy function to clean up Go module dependencies during inst…

[triadmoko]

…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)
• 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
• 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:

• I have updated website/src/pages/changelog.mdx with details of this PR
• My code follows the general coding style of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• 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
• 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.

[coderabbitai]

Walkthrough

A helper function to run go mod tidy within a specified project directory was added to the template handling logic. The Install function now invokes this helper after extracting template files, unless skipped by a new flag. The changelog was updated to document this new behavior under the "Unreleased" section. The CLI documentation was clarified to note the addition of a -skipgomodtidy flag and that go mod tidy is run by default during project initialization.

Changes

File(s)	Change Summary
v3/internal/templates/templates.go	Added goModTidy helper to run go mod tidy; updated Install to invoke it post-extraction unless skipped; reordered imports.
v3/internal/flags/init.go	Added SkipGoModTidy boolean flag to Init struct to control skipping go mod tidy.
docs/src/content/docs/guides/cli.mdx	Added -skipgomodtidy flag to init command; clarified documentation about running/skipping go mod tidy.
website/src/pages/changelog.mdx	Added an "Added" entry under "Unreleased" to document the new automatic go mod tidy execution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InstallFunction
    participant goModTidy
    participant OSExec

    User->>InstallFunction: Run Install
    InstallFunction->>InstallFunction: Extract template files
    alt SkipGoModTidy is false
        InstallFunction->>goModTidy: Call goModTidy(projectDir)
        goModTidy->>OSExec: Execute 'go mod tidy' in projectDir
        OSExec-->>goModTidy: Return command output/result
        goModTidy-->>InstallFunction: Return error or success
    else SkipGoModTidy is true
        InstallFunction-->>InstallFunction: Skip goModTidy call
    end
    InstallFunction-->>User: Return result or error

Loading

Poem

In the warren of code, a tidy new day,
Now go mod tidy hops in after init’s play.
Templates unpack, dependencies align,
The changelog records it—oh, how divine!
With each little hop, our projects grow neat,
Thanks to a bunny who keeps things complete. 🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 13717cd and 2fc914f.

📒 Files selected for processing (1)

• docs/src/content/docs/guides/cli.mdx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/src/content/docs/guides/cli.mdx

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[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 🙏

[triadmoko]

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

[leaanthony]

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

[triadmoko]

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

ok. i will try to add a flag to bypass go mod tidy

[triadmoko]

what is the default value to be used for skipgomodtidy ?

[leaanthony]

what is the default value to be used for skipgomodtidy ?

false. We want it to run by default.

[leaanthony]

Nice job!

[sonarqubecloud]

Quality Gate failed

Failed conditions
1 Security Hotspot
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE