-
Notifications
You must be signed in to change notification settings - Fork 77
chore(lint): enable gci formatter for import grouping #529
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
Conversation
Configure gci formatter in golangci-lint to enforce consistent import ordering with two groups: stdlib imports first, then all other imports. Signed-off-by: Dorin Geman <dorin.geman@docker.com>
Summary of ChangesHello @doringeman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request integrates the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've left some high level feedback:
- With both
goimportsandgcienabled as formatters in.golangci.yml, consider disablinggoimportsto avoid potential conflicts or double-formatting of imports and letgcibe the single source of truth for import ordering. - If you want to distinguish internal imports from third‑party ones, you might want to extend the
gci.sectionsconfiguration to include a local section (e.g. matchinggithub.com/docker/model-runner/...) rather than grouping all non‑stdlib imports together.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- With both `goimports` and `gci` enabled as formatters in `.golangci.yml`, consider disabling `goimports` to avoid potential conflicts or double-formatting of imports and let `gci` be the single source of truth for import ordering.
- If you want to distinguish internal imports from third‑party ones, you might want to extend the `gci.sections` configuration to include a local section (e.g. matching `github.com/docker/model-runner/...`) rather than grouping all non‑stdlib imports together.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request enables the gci formatter to enforce a consistent import order. The changes in the Go files correctly apply the new formatting. However, there is a configuration error in .golangci.yml where the settings for gci are misplaced. I've added a comment with a suggestion to fix it. Once that's addressed, this is a great improvement for code consistency.
| settings: | ||
| gci: | ||
| sections: | ||
| - standard # stdlib | ||
| - default # everything else |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The settings block for gci is incorrectly placed. According to the golangci-lint documentation, formatter settings should be under a top-level formatters-settings block, not nested within formatters.
Please remove this block and add the settings under formatters-settings like this:
formatters-settings:
gci:
sections:
- standard # stdlib
- default # everything elseThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not true, see https://golangci-lint.run/docs/configuration/file/#formatters-configuration.
Configure gci formatter in golangci-lint to enforce consistent import ordering with two groups: stdlib imports first, then all other imports.