Skip to content
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

chore: Address linter issues #20486

Merged
merged 4 commits into from
May 31, 2024
Merged

chore: Address linter issues #20486

merged 4 commits into from
May 31, 2024

Conversation

alpe
Copy link
Contributor

@alpe alpe commented May 30, 2024

Description

Fixes to the linter issues only.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Chores
    • Updated linting tool version in Makefile to improve code quality checks.

@alpe alpe requested a review from a team as a code owner May 30, 2024 09:33
Copy link
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

Walkthrough

The recent changes primarily focus on enhancing code quality and maintainability. This includes updating Format methods in various structs to handle return values more effectively, upgrading the linting tool version in the Makefile, and introducing a new contextKey type for better context management. Additionally, comments related to memory aliasing in for loops were removed to streamline the code.

Changes

Files Change Summary
types/address.go Updated Format methods to discard return values of s.Write and fmt.Sprintf calls.
x/gov/types/v1/proposal.go Handled the output of Write method by assigning return values to _.
x/gov/types/v1/vote.go Updated Format method in VoteOption struct to handle formatting based on the verb provided.
x/gov/types/v1beta1/proposal.go Added error handling with _ = before s.Write calls in Format method.
x/gov/types/v1beta1/vote.go Updated Format method for VoteOption type to discard return values of s.Write and fmt.Sprintf.
x/group/keeper/keeper.go Removed comments related to memory aliasing in for loops.
Makefile Updated golangci_version from v1.56.2 to v1.59.0.
core/context/context.go Introduced contextKey type and updated ExecModeKey and CometInfoKey to use this new type.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding preliminary approval since this change consists in pleasing the linter gods!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ac49374 and 9a5e4c9.

Files ignored due to path filters (2)
  • runtime/v2/go.mod is excluded by !**/*.mod
  • runtime/v2/go.sum is excluded by !**/*.sum
Files selected for processing (6)
  • types/address.go (3 hunks)
  • x/gov/types/v1/proposal.go (1 hunks)
  • x/gov/types/v1/vote.go (1 hunks)
  • x/gov/types/v1beta1/proposal.go (1 hunks)
  • x/gov/types/v1beta1/vote.go (1 hunks)
  • x/group/keeper/keeper.go (3 hunks)
Files skipped from review due to trivial changes (5)
  • types/address.go
  • x/gov/types/v1/proposal.go
  • x/gov/types/v1/vote.go
  • x/gov/types/v1beta1/proposal.go
  • x/group/keeper/keeper.go
Additional context used
Path-based instructions (1)
x/gov/types/v1beta1/vote.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)
x/gov/types/v1beta1/vote.go (1)

116-116: Changes align with the PR's objective to address linter issues by properly handling the return values.

Also applies to: 118-118

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9a5e4c9 and ff7854f.

Files selected for processing (1)
  • Makefile (1 hunks)
Files skipped from review due to trivial changes (1)
  • Makefile

alpe added 2 commits May 31, 2024 08:57
* main:
  feat(server/v2): introduce cometbft v2 (#20483)
  refactor(x/upgrade): migrate to appmodule.VersionMap (#20485)
  docs: code guidelines changes (#20482)
  feat(cosmovisor): load cosmovisor configuration from toml file (#19995)
  perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034)
  fix: Bump CometBFT versions (#20481)
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ff7854f and 1b161b4.

Files ignored due to path filters (3)
  • server/v2/cometbft/client/grpc/cmtservice/query.pb.go is excluded by !**/*.pb.go
  • server/v2/cometbft/client/grpc/cmtservice/query.pb.gw.go is excluded by !**/*.pb.gw.go
  • server/v2/cometbft/client/grpc/cmtservice/types.pb.go is excluded by !**/*.pb.go
Files selected for processing (1)
  • core/context/context.go (1 hunks)
Additional context used
Path-based instructions (1)
core/context/context.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (2)
core/context/context.go (2)

3-3: Introduce a new type contextKey for context keys.

This change enhances type safety by ensuring that context keys are distinct from other uint8 values, aligning with best practices for type safety in Go.


6-7: Update constants to use the new contextKey type.

This is a good practice as it prevents accidental misuse of these constants as regular integers and ensures that they are used strictly as context keys.

@alpe alpe added this pull request to the merge queue May 31, 2024
Merged via the queue into main with commit a685796 May 31, 2024
67 of 68 checks passed
@alpe alpe deleted the alex/main_lint branch May 31, 2024 08:55
alpe added a commit that referenced this pull request May 31, 2024
* main: (120 commits)
  chore: update protoc-gen-swagger to protoc-gen-openapiv2 (#20448)
  ci: Add GitHub Action for go mod tidy and mocks (#20501)
  chore: Address linter issues (#20486)
  fix: wrap errors in auto CLI service registration (#20493)
  chore: fix comment (#20498)
  chore: fix the note box syntax error (#20499)
  feat(server/v2): introduce cometbft v2 (#20483)
  refactor(x/upgrade): migrate to appmodule.VersionMap (#20485)
  docs: code guidelines changes (#20482)
  feat(cosmovisor): load cosmovisor configuration from toml file (#19995)
  perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034)
  fix: Bump CometBFT versions (#20481)
  refactor(core): remove redundant ExecMode (#20322)
  feat(store/v2): pruning manager (#20430)
  chore: force reload sonar cloud  (#20480)
  refactor(x/accounts): reuse calculated sum in `func safeAdd` (#20458)
  refactor: remove `defer` in loop (#20223)
  ci: remove livness test (#20474)
  build(deps): Bump bufbuild/buf-setup-action from 1.32.1 to 1.32.2 (#20477)
  chore: migrate a few diagrams to mermaid (#20473)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants