mock icon indicating copy to clipboard operation
mock copied to clipboard

Use `_name` instead `argn` in case of conflict

Open klaidliadon opened this issue 8 months ago • 2 comments

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Improved the logic for generating argument names in mock generation, ensuring unique names and preventing collisions with package names.

klaidliadon avatar Mar 21 '25 10:03 klaidliadon

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Mar 21 '25 10:03 CLAassistant

Walkthrough

The update modifies the getArgNames method in mockgen/mockgen.go to change how argument names are generated. The logic now separates checks for empty names and names that conflict with package names, assigning default names using fmt.Sprintf("arg%d", i) for empty names and prefixing an underscore (_) for conflicting names. This change applies to both regular and variadic parameters. The overall method structure remains unchanged, and no modifications to exported or public entities have been made.

Changes

File(s) Change Summary
mockgen/mockgen.go Updated getArgNames logic to separate checks for empty names and package name conflicts, adjusting how argument names are generated for both regular and variadic parameters.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Caller
    participant Gen as getArgNames
    Client->>+Gen: Request argument name generation
    Gen->>Gen: Check if argument name is empty or conflicts
    alt Name is empty or conflicts
        Gen-->>Gen: Assign default name "arg%d" or prefix with "_"
    else Name is valid
        Gen-->>Gen: Retain original name
    end
    Gen-->>-Client: Return generated argument name

Poem

In the garden of code, I hop with delight,
Changing names with a _ magic in the night.
Goodbye "arg0", hello fresh new flair,
No package conflict shall worry a hare.
With glee, I code — a bunny's joy fair! 🐰


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75cb29b3cc5708e4301d62cc080dc6d0a78dd094 and 9e38abcf5ac35db1baf37ce16f99f81e24a2c5b7.

📒 Files selected for processing (1)
  • mockgen/mockgen.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • mockgen/mockgen.go

🪧 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.
    • Generate unit testing code for this file.
    • 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 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 generate docstrings to generate docstrings 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.

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

coderabbitai[bot] avatar Mar 21 '25 10:03 coderabbitai[bot]