Skip to content

chore: add underscore for global const #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sashamelentyev
Copy link
Contributor

@sashamelentyev sashamelentyev commented Apr 27, 2025

Summary by CodeRabbit

  • Refactor
    • Updated internal constant names to use a private naming convention. No changes to functionality or user-facing behavior.

Signed-off-by: Sasha Melentyev <sasha@m8.ru>
Copy link

coderabbitai bot commented Apr 27, 2025

Walkthrough

This update involves renaming several internal constants across multiple files by prefixing their names with an underscore, signaling their intended private/internal use. The changes are limited to constant declarations and their references within the same files. No functional logic, exported interfaces, or control flow have been modified as part of this update.

Changes

File(s) Change Summary
mockgen/deprecated.go Renamed constants deprecatedFlagProgOnly and deprecatedFlagExecOnly to _deprecatedFlagProgOnly and _deprecatedFlagExecOnly; updated all references accordingly.
mockgen/mockgen.go Renamed constant gomockImportPath to _gomockImportPath and updated its usage in the Generate method.
mockgen/model/model.go Renamed constant pkgPath to _pkgPath and updated all references, especially in gob.RegisterName calls within init().

Poem

In the warren of code, some names took a leap,
With underscores now, their secrets to keep.
Constants once public, now hidden from view,
Hopping to privacy, as rabbits will do.
A tidy-up burrow, neat and discreet—
These changes are subtle, but oh, so complete!
🐇✨


📜 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 6568d88 and af43e35.

📒 Files selected for processing (3)
  • mockgen/deprecated.go (2 hunks)
  • mockgen/mockgen.go (2 hunks)
  • mockgen/model/model.go (3 hunks)
🔇 Additional comments (7)
mockgen/deprecated.go (2)

10-11: Private constant naming for deprecated flags.
The flag identifiers have been renamed to _deprecatedFlagProgOnly and _deprecatedFlagExecOnly, correctly marking them as internal constants without altering their string values.


26-29: Switch cases updated to use underscore-prefixed constants.
In notifyAboutDeprecatedFlags, the case labels now refer to the renamed constants, ensuring warnings for prog_only and exec_only are still emitted as before.

mockgen/model/model.go (3)

26-27: Renamed pkgPath to private _pkgPath.
The constant is now _pkgPath, making it unexported while keeping the import path unchanged. This aligns with the PR’s private-constant convention.


152-157: Updated gob.RegisterName calls to use _pkgPath.
All registrations for ArrayType, ChanType, FuncType, MapType, and NamedType now use the new _pkgPath constant. Functionality remains identical.


166-166: Registered PredeclaredType with the new private constant.
The final gob.RegisterName call has also been updated to _pkgPath, preserving consistency across registrations.

mockgen/mockgen.go (2)

347-347: Applied _gomockImportPath in the imports set.
The import map now uses _gomockImportPath to include the gomock package. Behavior of generated imports is unchanged.


46-46:

✅ Verification successful

Privatized gomockImportPath constant.
The import path constant has been renamed to _gomockImportPath, marking it as internal. Please verify that no references to the old gomockImportPath remain.

Run this script from the repo root to confirm zero occurrences of the old name:


🏁 Script executed:

#!/bin/bash
# Verify no leftover references to the old constant
rg -n "gomockImportPath" --glob "*.go"

Length of output: 165


Verification complete: _gomockImportPath privatization
Confirmed that there are no remaining references to gomockImportPath; only _gomockImportPath is present.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

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.

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.

1 participant