Skip to content

docs: misc fixes#729

Merged
azat-io merged 10 commits into
azat-io:mainfrom
hugop95:test/unit-tests
Mar 26, 2026
Merged

docs: misc fixes#729
azat-io merged 10 commits into
azat-io:mainfrom
hugop95:test/unit-tests

Conversation

@hugop95
Copy link
Copy Markdown
Contributor

@hugop95 hugop95 commented Mar 26, 2026

Description

This PR is a collection of small documentation fixes.

Bonus: minor unit test fixes.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b1c40cb4-155c-48ee-83cb-97027737eb8a

📥 Commits

Reviewing files that changed from the base of the PR and between 4949b1d and b49f289.

📒 Files selected for processing (20)
  • docs/content/rules/sort-array-includes.mdx
  • docs/content/rules/sort-classes.mdx
  • docs/content/rules/sort-decorators.mdx
  • docs/content/rules/sort-enums.mdx
  • docs/content/rules/sort-exports.mdx
  • docs/content/rules/sort-heritage-clauses.mdx
  • docs/content/rules/sort-imports.mdx
  • docs/content/rules/sort-interfaces.mdx
  • docs/content/rules/sort-intersection-types.mdx
  • docs/content/rules/sort-jsx-props.mdx
  • docs/content/rules/sort-modules.mdx
  • docs/content/rules/sort-named-exports.mdx
  • docs/content/rules/sort-named-imports.mdx
  • docs/content/rules/sort-object-types.mdx
  • docs/content/rules/sort-objects.mdx
  • docs/content/rules/sort-sets.mdx
  • docs/content/rules/sort-union-types.mdx
  • test/utils/context-matching/passes-all-names-match-pattern-filter.test.ts
  • test/utils/context-matching/passes-ast-selector-filter.test.ts
  • test/utils/scoped-regex/partition-patterns-by-scope.test.ts

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Updated rule documentation across multiple files with clarified descriptions and improved examples.
    • Enhanced configuration examples with additional settings.
    • Standardized formatting and punctuation throughout documentation.
  • Tests

    • Added test coverage for utility filtering and pattern partitioning functions.

Walkthrough

The PR updates documentation for 16 ESLint rule files with apostrophe normalization (typographic to ASCII quotes), minor wording clarifications, and configuration example additions. Two new test files are added to verify utility functions passesAstSelectorFilter and partitionPatternsByScope.

Changes

Cohort / File(s) Summary
Apostrophe normalization
docs/content/rules/sort-decorators.mdx, docs/content/rules/sort-exports.mdx, docs/content/rules/sort-imports.mdx, docs/content/rules/sort-interfaces.mdx, docs/content/rules/sort-modules.mdx, docs/content/rules/sort-named-exports.mdx, docs/content/rules/sort-named-imports.mdx, docs/content/rules/sort-object-types.mdx
Normalized typographic apostrophes to ASCII straight quotes in option and group descriptions (e.g., don'tdon't).
Documentation clarifications
docs/content/rules/sort-array-includes.mdx, docs/content/rules/sort-classes.mdx, docs/content/rules/sort-heritage-clauses.mdx, docs/content/rules/sort-union-types.mdx, docs/content/rules/sort-objects.mdx
Updated rule descriptions for accuracy (e.g., "array elements" vs. "object type members", "heritage clauses" vs. "class decorators") and apostrophe normalization.
Configuration examples and structure
docs/content/rules/sort-intersection-types.mdx, docs/content/rules/sort-enums.mdx, docs/content/rules/sort-jsx-props.mdx, docs/content/rules/sort-sets.mdx
Added or updated configuration example snippets (e.g., partitionByComment: false), adjusted markdown heading levels, and refined customGroups descriptions with pattern examples.
Test utilities
test/utils/context-matching/passes-ast-selector-filter.test.ts, test/utils/scoped-regex/partition-patterns-by-scope.test.ts
Added new Vitest suites verifying passesAstSelectorFilter (handling undefined/empty selectors and matching logic) and partitionPatternsByScope (partitioning string and object patterns by scope type).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • azat-io
🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title "docs: misc fixes" is vague and generic, using the non-descriptive term "misc" that does not convey meaningful information about the specific changes made. Consider using a more specific title that captures the primary changes, such as "docs: fix apostrophes and update examples" or "docs: normalize punctuation and add test coverage."
Description check ❓ Inconclusive The description mentions fixes but lacks specific details about what was corrected and why, making it difficult for reviewers to understand the scope of changes. Expand the description to explain the main categories of fixes (e.g., apostrophe normalization, heading levels, example configurations) and reference any related issues.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

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

@hugop95 hugop95 marked this pull request as ready for review March 26, 2026 12:11
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 26, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #729   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          223       223           
  Lines         4364      4364           
  Branches      1353      1353           
=========================================
  Hits          4364      4364           

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

Copy link
Copy Markdown
Owner

@azat-io azat-io left a comment

Choose a reason for hiding this comment

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

Thank you!

@azat-io azat-io merged commit 0b8fbcd into azat-io:main Mar 26, 2026
13 checks passed
@hugop95 hugop95 deleted the test/unit-tests branch March 26, 2026 17:33
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.

2 participants