fix: allow overriding settings with default values

[azat-io]

Description

Remove meta.defaultOptions from all rules to prevent ESLint from auto-merging defaults into options. This allows users to explicitly set values that match defaults and override global settings.

Additional context

#653

---

What is the purpose of this pull request?

• Bug fix
• New Feature
• Documentation update
• Other

Before submitting the PR, please make sure you do the following

• Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
• Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves.
• Ideally, include relevant tests that fail without this PR but pass with it.
• Read contribution guidelines.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Chores
  • Standardized ESLint rule structure across multiple rules by reorganizing default option declarations
  • Updated base ESLint configuration to adjust specific rule handling
  • Refactored configuration merging logic to use streamlined object composition

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

This PR removes meta.defaultOptions from 22 ESLint rule definitions, rewrites the complete utility function to use flat object merging instead of recursive default-value stripping, and updates the ESLint configuration to disable the require-meta-default-options rule.

Changes

Cohort / File(s)	Change Summary
ESLint Configuration eslint.config.ts	Modified extends from single value to array, adding inline config to disable eslint-plugin/require-meta-default-options rule while keeping the recommended config
Rule Meta Cleanup rules/sort-array-includes.ts, rules/sort-classes.ts, rules/sort-decorators.ts, rules/sort-enums.ts, rules/sort-export-attributes.ts, rules/sort-exports.ts, rules/sort-heritage-clauses.ts, rules/sort-import-attributes.ts, rules/sort-imports.ts, rules/sort-interfaces.ts, rules/sort-intersection-types.ts, rules/sort-jsx-props.ts, rules/sort-maps.ts, rules/sort-modules.ts, rules/sort-named-exports.ts, rules/sort-named-imports.ts, rules/sort-objects.ts, rules/sort-sets.ts, rules/sort-switch-case.ts, rules/sort-union-types.ts, rules/sort-variable-declarations.ts	Removed defaultOptions property from meta object in each rule; top-level defaultOptions declaration preserved
Rule Restructuring rules/sort-object-types.ts	Relocated create handler from separate top-level block to inline field within exported rule object; removed defaultOptions from meta
Utility Simplification utils/complete.ts	Replaced recursive stripDefaultValues logic with flat object spread merge (...defaults, ...settings, ...options); removed helper functions stripDefaultValues, isDeepEqual, and isPlainObject

Possibly related issues

• Bug: cannot override settings back to a default configuration value #653: Directly addresses the bug where settings are being stripped in utils/complete.ts by replacing the recursive stripping logic with flat object merging.

Possibly related PRs

• fix(sort-objects-types): support variable declarations for elementMatchesPattern  #636: Modifies the same file (rules/sort-object-types.ts) with related rule restructuring and type changes.
• feat(sort-objects)!: drop deprecated ignorePattern  #632: Modifies the same ESLint rule files (sort-object-types.ts, sort-objects.ts, etc.) for object/type sorting configuration.
• test: improve test coverage #618: Touches the same utility file (utils/complete.ts), specifically the isDeepEqual function that is removed in this PR.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

The review involves 22 homogeneous rule file changes (simple property removals) that form a repetitive pattern, offset by a more complex utility rewrite (utils/complete.ts) that replaces recursive logic with flat merging and requires verification of the new behavior. The config change is straightforward.

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: allowing users to override settings with default values, which is the core objective of this PR.
Description check	✅ Passed	The PR description includes all key required sections: a clear description of what is being fixed, a reference to the related issue (#653), selection of bug fix category, and confirmation of checklist items.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1430b19 and 4bfd74e.

📒 Files selected for processing (24)

• eslint.config.ts
• rules/sort-array-includes.ts
• rules/sort-classes.ts
• rules/sort-decorators.ts
• rules/sort-enums.ts
• rules/sort-export-attributes.ts
• rules/sort-exports.ts
• rules/sort-heritage-clauses.ts
• rules/sort-import-attributes.ts
• rules/sort-imports.ts
• rules/sort-interfaces.ts
• rules/sort-intersection-types.ts
• rules/sort-jsx-props.ts
• rules/sort-maps.ts
• rules/sort-modules.ts
• rules/sort-named-exports.ts
• rules/sort-named-imports.ts
• rules/sort-object-types.ts
• rules/sort-objects.ts
• rules/sort-sets.ts
• rules/sort-switch-case.ts
• rules/sort-union-types.ts
• rules/sort-variable-declarations.ts
• utils/complete.ts

💤 Files with no reviewable changes (21)

• rules/sort-heritage-clauses.ts
• rules/sort-decorators.ts
• rules/sort-jsx-props.ts
• rules/sort-union-types.ts
• rules/sort-exports.ts
• rules/sort-objects.ts
• rules/sort-modules.ts
• rules/sort-enums.ts
• rules/sort-array-includes.ts
• rules/sort-classes.ts
• rules/sort-intersection-types.ts
• rules/sort-variable-declarations.ts
• rules/sort-export-attributes.ts
• rules/sort-named-imports.ts
• rules/sort-import-attributes.ts
• rules/sort-imports.ts
• rules/sort-switch-case.ts
• rules/sort-interfaces.ts
• rules/sort-maps.ts
• rules/sort-named-exports.ts
• rules/sort-sets.ts

🧰 Additional context used

🧬 Code graph analysis (1)

rules/sort-object-types.ts (2)

rules/sort-imports.ts (1)

• MessageId (76-82)

rules/sort-objects/types.ts (5)

• MessageId (21-26)
• MISSED_SPACING_ERROR_ID (31-31)
• EXTRA_SPACING_ERROR_ID (30-30)
• GROUP_ORDER_ERROR_ID (29-29)
• ORDER_ERROR_ID (28-28)

🔇 Additional comments (4)

eslint.config.ts (1)

7-14: LGTM - Disabling the rule aligns with the structural change.

Disabling eslint-plugin/require-meta-default-options is appropriate since the PR moves defaultOptions out of the meta object across all rules to prevent ESLint's auto-merge behavior.

rules/sort-object-types.ts (2)

131-144: LGTM - Structural reorganization.

The create handler logic remains unchanged; it's simply moved inline. This is consistent with relocating defaultOptions outside of meta.

---

161-161: Verify the actual API implementation of createEslintRule in the project.

The @typescript-eslint/utils RuleCreator officially supports defaultOptions as a top-level property. However, confirm that the project's createEslintRule function follows the same pattern and correctly applies default options through wrapper logic. Check the implementation of createEslintRule to ensure it wraps the create function and applies defaults as intended.

utils/complete.ts (1)

35-35: The shallow merge implementation is intentional for this utility's purpose.

The complete() function is designed specifically to merge three configuration levels (defaults → settings → options) at the top level only. While the shallow spread operator does completely replace nested objects rather than merging them, this is appropriate because:

1. Nested object merging happens separately: The codebase uses dedicated utilities like computeOverriddenOptionsByGroupIndex for handling nested property merging within objects like fallbackSort.

2. Function scope is limited: The docstring example shows this function handles only top-level keys. Nested object overrides occur through rule-specific logic (e.g., custom groups), not through this utility.

3. No breaking change: All existing tests pass, and there's no evidence of users relying on partial nested object overrides at the rule-options level. The PR's goal—allowing settings to override defaults—is achieved correctly at the top level.

The implementation aligns with the PR objective and the existing architecture.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1430b19) to head (4bfd74e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #654   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          143       143           
  Lines         3554      3521   -33     
  Branches      1106      1088   -18     
=========================================
- Hits          3554      3521   -33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[hugop95]

@azat-io Thanks !