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

Add recursive lint #2204

Merged
merged 2 commits into from
Mar 4, 2024
Merged

Add recursive lint #2204

merged 2 commits into from
Mar 4, 2024

Conversation

trajan0x
Copy link
Contributor

@trajan0x trajan0x commented Mar 4, 2024

Description

Lint recursively

Summary by CodeRabbit

  • Chores
    • Updated the Go linter to the latest version for improved code quality checks.
    • Added a new linting target to ensure Go modules are tidy and well-maintained.
    • Improved the linting script to enhance code quality and maintenance.

Copy link
Contributor

coderabbitai bot commented Mar 4, 2024

Walkthrough

The recent updates aim to enhance the linting process for Go code in the repository. A new version of golangci-lint is implemented, and a lint-go target is added to the Makefile for comprehensive linting across all Go modules. A Bash script, lint.sh, is introduced to automate identifying Go modules and running go mod tidy for each, ensuring a cleaner and more maintainable codebase.

Changes

Files Change Summary
.github/workflows/go.yml Updated golangci-lint to v1.56.2
make/repo.Makefile Added lint-go target for running make lint
make/scripts/lint.sh New script to find go.mod files and run go mod tidy

"In the realm of code, where logic is king,
A rabbit hopped in, making linting its thing.
🐰 With a flick and a hop, it cleaned up the place,
Ensuring each line had its own space.
'Let's tidy up, make our code gleam,
For clean code is every developer's dream!'
With a cheer and a leap, it went on its way,
Leaving behind code that's brighter than day."

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-tests for this file.
  • 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added M-ci Module: CI size/xs labels Mar 4, 2024
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between c9d7497 and 98c136e.
Files selected for processing (3)
  • .github/workflows/go.yml (1 hunks)
  • make/repo.Makefile (1 hunks)
  • make/scripts/lint.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/go.yml
Additional comments: 1
make/repo.Makefile (1)
  • 33-35: The lint-go target correctly invokes the lint.sh script for recursive linting. Ensure that this target is integrated properly with other related targets in the Makefile, such as setup or pre-linting steps, to maintain the correct order of operations.

Consider verifying the execution path of lint.sh from the repository root and whether any dependencies or order should be enforced between lint-go and other Makefile targets to ensure a smooth and error-free linting process.

make/scripts/lint.sh Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 98c136e and fd27082.
Files selected for processing (1)
  • make/scripts/lint.sh (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • make/scripts/lint.sh

@trajan0x trajan0x merged commit 09c7390 into master Mar 4, 2024
26 checks passed
@trajan0x trajan0x deleted the fix/recursive-lint branch March 4, 2024 16:54
trajan0x added a commit that referenced this pull request Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
M-ci Module: CI size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant