Skip to content

docs(orgnizeImports): revamp user-facing docs#9987

Merged
Conaclos merged 4 commits intomainfrom
conaclos/organizeImports-main-docs-revamp
Apr 14, 2026
Merged

docs(orgnizeImports): revamp user-facing docs#9987
Conaclos merged 4 commits intomainfrom
conaclos/organizeImports-main-docs-revamp

Conversation

@Conaclos
Copy link
Copy Markdown
Member

@Conaclos Conaclos commented Apr 14, 2026

Summary

This PR performs the same change as #9887 (comment) tailored for the main branch.

The only difference is the removal of all references to the sortBareImports option that was merged on next and not on main.

Test Plan

CI shall pass :)

Docs

This is the purpose of this PR.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 14, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: daab4ad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added A-Linter Area: linter L-JavaScript Language: JavaScript and super languages labels Apr 14, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 14, 2026 •
edited
Loading

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: 1ba14fc8-7cbc-4a6b-a7d5-1a85ffff9226

📥 Commits

Reviewing files that changed from the base of the PR and between 9809881 and daab4ad.

⛔ Files ignored due to path filters (4)
  • crates/biome_cli/tests/snapshots/main_cases_reporter_sarif/reports_diagnostics_sarif_check_command.snap is excluded by !**/*.snap and included by **
  • crates/biome_cli/tests/snapshots/main_cases_reporter_sarif/reports_diagnostics_sarif_ci_command.snap is excluded by !**/*.snap and included by **
  • packages/@biomejs/backend-jsonrpc/src/workspace.ts is excluded by !**/backend-jsonrpc/src/workspace.ts and included by **
  • packages/@biomejs/biome/configuration_schema.json is excluded by !**/configuration_schema.json and included by **
📒 Files selected for processing (1)
  • crates/biome_js_analyze/src/assist/source/organize_imports.rs
✅ Files skipped from review due to trivial changes (1)
  • crates/biome_js_analyze/src/assist/source/organize_imports.rs

Walkthrough

This PR updates the inline documentation for the organizeImports source rule in the Biome JavaScript analyser. The docstring is rewritten to a shorter, organised overview with refreshed examples, clarified wording for source and identifier ordering, new groups and identifierOrder subsections, and removed deep internal walkthroughs. No Rust logic, signatures, or public APIs were changed—only the documentation text within declare_source_rule! was modified.

Possibly related PRs

Suggested reviewers

  • ematipico
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: revamping user-facing documentation for organizeImports. It's concise, clear, and directly relates to the changeset.
Description check ✅ Passed The description clearly relates to the changeset, explaining that it updates user-facing documentation for organizeImports by removing sortBareImports references specific to the main branch.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch conaclos/organizeImports-main-docs-revamp

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

coderabbitai[bot]
coderabbitai Bot reviewed Apr 14, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@crates/biome_js_analyze/src/assist/source/organize_imports.rs`:
- Around line 171-173: Fix the two typos in the type-only matcher documentation
in organize_imports.rs: change "an type-only matcher" to "a type-only matcher"
and remove the stray closing bracket after the sentence describing `"type":
false` so the line ends without `]`; update the comment block that references
the `"type": true` and `"type": false` examples accordingly.
- Around line 398-399: Update the documentation links in the organize_imports.rs
comment so they point to the stable biomejs.dev domain instead of
next.biomejs.dev: replace the two URLs referencing
"https://next.biomejs.dev/linter/rules/use-import-type/" and
"https://next.biomejs.dev/linter/rules/use-import-type/#style" with their stable
equivalents on "https://biomejs.dev/..." in the comment that mentions
`useImportType` and its `style` (the doc comment block in organize_imports.rs).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6317579c-fc0e-4cc7-a241-3116f7037863

📥 Commits

Reviewing files that changed from the base of the PR and between baaacfc and 9809881.

📒 Files selected for processing (1)
  • crates/biome_js_analyze/src/assist/source/organize_imports.rs

Comment thread crates/biome_js_analyze/src/assist/source/organize_imports.rs Outdated
Comment thread crates/biome_js_analyze/src/assist/source/organize_imports.rs Outdated
@github-actions github-actions Bot added the A-CLI Area: CLI label Apr 14, 2026
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 14, 2026 •
edited
Loading

Merging this PR will not alter performance

✅ 58 untouched benchmarks
⏩ 196 skipped benchmarks1

Comparing conaclos/organizeImports-main-docs-revamp (daab4ad) with main (baaacfc)

Open in CodSpeed

Footnotes

  1. 196 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@Conaclos Conaclos merged commit 79c09f2 into main Apr 14, 2026
30 checks passed
@Conaclos Conaclos deleted the conaclos/organizeImports-main-docs-revamp branch April 14, 2026 22:04
This was referenced Apr 20, 2026
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

A-CLI Area: CLI A-Linter Area: linter L-JavaScript Language: JavaScript and super languages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Conaclos