Skip to content

chore: add ESLint import ordering rule#14433

Closed
ImBIOS wants to merge 1 commit intogoogle-gemini:mainfrom
ImBIOS:chore/eslint-import-ordering
Closed

chore: add ESLint import ordering rule#14433
ImBIOS wants to merge 1 commit intogoogle-gemini:mainfrom
ImBIOS:chore/eslint-import-ordering

Conversation

@ImBIOS
Copy link

@ImBIOS ImBIOS commented Dec 3, 2025

Description

Adds ESLint import/order rule to enforce consistent import organization across the codebase, preventing diff noise from different editors auto-sorting imports differently.

Changes

  • Added import/order ESLint rule with configured groups and alphabetical sorting
  • Disabled source.organizeImports in VS Code settings to prevent conflicts with ESLint
  • Import groups are now organized: builtin → external → internal → parent → sibling → index → type
  • Alphabetical sorting enabled within each group (case-insensitive)

Benefits

  • Prevents import reordering diff noise in PRs
  • Consistent import order across all contributors
  • Auto-fixable via npm run lint -- --fix
  • Editor integration shows violations in real-time

Note

This PR only adds the ESLint configuration. A follow-up PR may be needed to apply --fix across the codebase to resolve existing violations.

- Add import/order rule to enforce consistent import organization
- Disable source.organizeImports in VS Code settings to prevent conflicts
- Configure import groups: builtin → external → internal → parent → sibling
- Enable alphabetical sorting within each group

This prevents diff noise from inconsistent import ordering across different editors and contributors.
@ImBIOS ImBIOS requested a review from a team as a code owner December 3, 2025 03:38
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ImBIOS, 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 standardizes import statements throughout the project by integrating a new ESLint rule. The primary goal is to eliminate inconsistencies in import ordering, which often leads to unnecessary diff noise in pull requests and ensures a uniform code style for all contributors.

Highlights

  • New ESLint Rule: Introduced the import/order ESLint rule to enforce a consistent import organization across the codebase.
  • Import Grouping: Configured import groups to follow a specific order: builtin, external, internal, parent, sibling, index, and type imports.
  • Alphabetical Sorting: Enabled case-insensitive alphabetical sorting for imports within each defined group.
  • VS Code Integration: Disabled VS Code's source.organizeImports on save to prevent conflicts with the new ESLint import ordering rule.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 introduces an ESLint rule to enforce consistent import ordering, which is a great step towards improving code consistency and reducing diff noise. The changes are well-scoped, including a necessary adjustment to VS Code settings to prevent conflicts. My review includes one high-severity suggestion to enhance the import/order rule by adding pathGroups to correctly handle internal monorepo packages, ensuring they are grouped as intended.

Comment on lines +141 to +156
{
groups: [
'builtin', // Node.js built-in modules
'external', // External npm packages
'internal', // Internal modules (aliases, monorepo packages)
'parent', // Parent directory imports
'sibling', // Same directory imports
'index', // Index file imports
'type', // Type-only imports
],
'newlines-between': 'never',
alphabetize: {
order: 'asc',
caseInsensitive: true,
},
},
Copy link
Contributor

Choose a reason for hiding this comment

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

high

For this rule to correctly categorize internal monorepo packages (like @google/gemini-cli-core), you should define pathGroups. Without this, packages scoped under @google/ will be treated as external and won't be grouped with other internal modules as intended.

By adding a pathGroups configuration for @google/** and adjusting pathGroupsExcludedImportTypes, you can ensure that your monorepo's internal packages are correctly placed in the internal group.

        {
          groups: [
            'builtin',   // Node.js built-in modules
            'external',  // External npm packages
            'internal',  // Internal modules (aliases, monorepo packages)
            'parent',    // Parent directory imports
            'sibling',   // Same directory imports
            'index',     // Index file imports
            'type',      // Type-only imports
          ],
          pathGroups: [
            {
              pattern: '@google/**',
              group: 'internal',
            },
          ],
          pathGroupsExcludedImportTypes: ['builtin'],
          'newlines-between': 'never',
          alphabetize: {
            order: 'asc',
            caseInsensitive: true,
          },
        },

@gemini-cli gemini-cli bot added the status/need-issue Pull requests that need to have an associated issue. label Jan 7, 2026
@bdmorgan
Copy link
Collaborator

Hi @ImBIOS, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@gemini-cli
Copy link
Contributor

gemini-cli bot commented Jan 24, 2026

Hi there! Thank you for your contribution to Gemini CLI.

To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md.

This pull request is being closed because it is not currently linked to an issue. You can easily reopen this PR once you have linked it to an issue.

How to link an issue:
Add a keyword followed by the issue number (e.g., Fixes #123) in the description of your pull request. For more details, see the GitHub Documentation.

Thank you for your understanding and for being a part of our community!

@gemini-cli gemini-cli bot closed this Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants