Skip to content

chore: close eslint object sorting #6101

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

Merged
merged 1 commit into from
May 3, 2025
Merged

chore: close eslint object sorting #6101

merged 1 commit into from
May 3, 2025

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented May 3, 2025

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • Chores
    • Updated multiple package dependencies to newer versions for improved stability and compatibility.
  • Style
    • Reordered CSS utility classes in the tabs UI component for improved consistency.
  • Refactor
    • Adjusted property order within component definitions for better readability.
  • Tests
    • Modified linting configurations, including disabling a rule for object property sorting and updating settings for Vue files.
  • Bug Fixes
    • Improved language, layout, and theme toggle components to handle undefined or missing values gracefully.

@anncwb anncwb requested review from vince292007, mynetfan, jinmao88 and a team as code owners May 3, 2025 07:46
Copy link
Contributor

coderabbitai bot commented May 3, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This set of changes includes updates to ESLint configuration files disabling the perfectionist/sort-objects rule globally and specifically for .vue files, addition of ESLint disable comments for Vue component files violating the one-component-per-file rule, and minor reordering of the inheritAttrs: false property within Vue component option objects across multiple files. Some commented ESLint directives were removed from Vue components. Several dependency versions were updated in the workspace configuration. Additionally, type signatures of some widget event handler functions were broadened to accept undefined and early return guards were added. No functional logic or exported entities were otherwise altered.

Changes

File(s) Change Summary
internal/lint-configs/eslint-config/src/configs/perfectionist.ts Disabled the perfectionist/sort-objects ESLint rule by changing enforcement from 'error' to 'off'.
internal/lint-configs/eslint-config/src/custom-config.ts Added a new ESLint config block for .vue files disabling perfectionist/sort-objects and applying import ignore patterns.
packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts, packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts Added ESLint disable comments for vue/one-component-per-file before component options; reordered inheritAttrs: false after name.
apps/web-antd/src/adapter/component/index.ts, apps/web-ele/src/adapter/component/index.ts, apps/web-naive/src/adapter/component/index.ts, playground/src/adapter/component/index.ts, packages/@core/ui-kit/form-ui/src/use-vben-form.ts Reordered inheritAttrs: false property to appear after name in Vue component option objects.
packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue, packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue Removed commented ESLint directive lines disabling perfectionist/sort-objects.
packages/effects/layouts/src/widgets/language-toggle.vue, packages/effects/layouts/src/widgets/layout-toggle.vue Changed handleUpdate function parameter type from string to `string
packages/effects/layouts/src/widgets/theme-toggle/theme-toggle.vue Changed handleChange function parameter type from boolean to `boolean
pnpm-workspace.yaml Updated versions for multiple dependencies in the catalog section; no other structural modifications.

Suggested reviewers

  • jinmao88
  • vince292007

Poem

🐇 Hopping through the code with care,
ESLint rules now light the air.
Properties shifted, guards in place,
Types expanded, keeping pace.
Versions bumped, the workspace gleams,
A rabbit’s touch in all the streams!
✨🌿


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f79904 and e4176bf.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (15)
  • apps/web-antd/src/adapter/component/index.ts (1 hunks)
  • apps/web-ele/src/adapter/component/index.ts (1 hunks)
  • apps/web-naive/src/adapter/component/index.ts (1 hunks)
  • internal/lint-configs/eslint-config/src/configs/perfectionist.ts (1 hunks)
  • internal/lint-configs/eslint-config/src/custom-config.ts (1 hunks)
  • packages/@core/ui-kit/form-ui/src/use-vben-form.ts (1 hunks)
  • packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (2 hunks)
  • packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (2 hunks)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue (0 hunks)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs/tabs.vue (1 hunks)
  • packages/effects/layouts/src/widgets/language-toggle.vue (1 hunks)
  • packages/effects/layouts/src/widgets/layout-toggle.vue (1 hunks)
  • packages/effects/layouts/src/widgets/theme-toggle/theme-toggle.vue (1 hunks)
  • playground/src/adapter/component/index.ts (1 hunks)
  • pnpm-workspace.yaml (8 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@anncwb anncwb force-pushed the fixture/eslint-conflict branch from 1f79904 to e4176bf Compare May 3, 2025 08:02
@anncwb anncwb merged commit 17a18fc into main May 3, 2025
13 checks passed
@anncwb anncwb deleted the fixture/eslint-conflict branch May 3, 2025 08:06
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