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

Development: Improve spotless check against wildcard imports #8495

Merged
merged 6 commits into from
May 1, 2024

Conversation

Strohgelaender
Copy link
Contributor

@Strohgelaender Strohgelaender commented Apr 28, 2024

Checklist

General

Motivation and Context

In #8492 I added a small custom spotless check to find and report star import. @julian-christl reported that the output of the check did not work as expected and was sometimes only showing the package of the class.

Description

I improved the check to cleary show the violating lines.

Steps for Testing

code review

Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Summary by CodeRabbit

  • Refactor
    • Improved handling of wildcard imports for better code quality and maintainability.
    • Replaced a custom rule with a new implementation in the spotless configuration.
    • Introduced error detection for wildcard imports.
    • Updated dependencies with new imports for enhanced functionality.

Copy link

coderabbitai bot commented Apr 28, 2024

Walkthrough

The update improves code quality by enhancing import management in the project's build configuration. It introduces a new FormatterStep in the spotless setup of build.gradle to detect and disallow wildcard imports, fostering a cleaner and more sustainable codebase.

Changes

File Change Summary
build.gradle Refactored spotless configuration to use a new FormatterStep that identifies and throws errors for wildcard imports. Added import statements for com.diffplug.spotless.FormatterFunc and com.diffplug.spotless.Formatter.NO_FILE_SENTINEL.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 48c5ba6 and 4c3e689.
Files selected for processing (1)
  • build.gradle (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • build.gradle

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.

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

@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: 1

build.gradle Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 28, 2024
Copy link
Member

@julian-christl julian-christl left a comment

Choose a reason for hiding this comment

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

thx lgtm

@Strohgelaender Strohgelaender added this to the 7.0.3 milestone Apr 30, 2024
@krusche krusche merged commit 15f2350 into develop May 1, 2024
35 of 39 checks passed
@krusche krusche deleted the chore/spotless-wildcard-check branch May 1, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants