Skip to content

chore: add comment explaining why order-properties is disabled#28

Merged
VdustR merged 1 commit intomainfrom
chore/add-oxfmt-comment
Feb 4, 2026
Merged

chore: add comment explaining why order-properties is disabled#28
VdustR merged 1 commit intomainfrom
chore/add-oxfmt-comment

Conversation

@VdustR
Copy link
Collaborator

@VdustR VdustR commented Feb 4, 2026

Summary

  • Add comment explaining that package-json/order-properties is disabled because sorting is handled by oxfmt

Test plan

  • Lint passes

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@gemini-code-assist
Copy link

Summary of Changes

Hello @VdustR, 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 enhances the clarity and maintainability of the ESLint configuration by documenting the rationale behind disabling a specific rule. It ensures that future developers understand that package.json property ordering is managed by an external tool, oxfmt, preventing confusion or accidental re-enabling of the redundant ESLint rule.

Highlights

  • Configuration Clarity: A comment has been added to the ESLint configuration to explain why the package-json/order-properties rule is disabled.
  • Formatting Delegation: The comment clarifies that property sorting for package.json files is handled by oxfmt, making the ESLint rule redundant.

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

Changelog
  • packages/eslint-config/src/configs/packageJson.ts
    • Added a line comment // sorted by oxfmt above the "package-json/order-properties": "off" rule to explain its disabled status.
Activity
  • The pull request was generated using Claude Code.
  • The linting checks have passed, confirming no new linting issues were introduced.
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.

@VdustR VdustR merged commit 341693e into main Feb 4, 2026
4 checks passed
Copy link

@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 adds a comment to explain why the package-json/order-properties ESLint rule is disabled. This is a good change for maintainability. I have one small suggestion to make the comment even clearer.

...omit(recommended, ["name", "plugins"]),
rules: renameRules({
...recommended.rules,
// sorted by oxfmt

Choose a reason for hiding this comment

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

medium

For improved clarity and long-term maintainability, consider making this comment a bit more descriptive. Explicitly stating that the rule is disabled and the reason why will help other developers quickly grasp the context without ambiguity.

Suggested change
// sorted by oxfmt
// Disabled because sorting is handled by oxfmt

@VdustR VdustR deleted the chore/add-oxfmt-comment branch February 4, 2026 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant