docs: fix typos for assist/actions/organize-imports #8490

sergioness · 2025-12-17T11:02:06Z

Summary

Fixes a few typo's in documentation for assist/actions/organizeImports action.

Test Plan

Auto-generated documentation that links to the website.

Docs

This is the fix to the documentation of the existing action.

changeset-bot · 2025-12-17T11:02:10Z

⚠️ No Changeset found

Latest commit: 54a4ffa

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

coderabbitai · 2025-12-17T11:04:15Z

Walkthrough

This pull request contains exclusively non-functional documentation comment refinements within the organise imports assistance module. The changes address grammatical inconsistencies and improve clarity in existing explanatory comments—adjusting phrasing such as "blank lines" versus "blank line," "To group them together," and "in case"—without modifying any logic, control flow, error handling, or observable behaviour. No public API declarations were altered.

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: fixing typos in documentation for the organize-imports assist action.
Description check	✅ Passed	The description is directly related to the changeset, explaining that it fixes typos in documentation for the organizeImports action with a clear test plan.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 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 67546bc and 54a4ffa.

📒 Files selected for processing (1)

crates/biome_js_analyze/src/assist/source/organize_imports.rs (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

crates/**/*.rs

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update inline rustdoc documentation for rules, assists, and their options when adding new features or changing existing features in Rust crates

Files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

🧠 Learnings (13)

📚 Learning: 2025-12-12T10:11:05.549Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-12-12T10:11:05.549Z
Learning: Applies to crates/**/*.rs : Update inline rustdoc documentation for rules, assists, and their options when adding new features or changing existing features in Rust crates

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Document rules with a one-line brief description in the first paragraph of the doc comment, followed by detailed paragraphs, `## Examples` section with `### Invalid` and `### Valid` subsections, and optional `## Options` section

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Use language tags in documentation code blocks (js, ts, tsx, json, css) and order properties consistently as: language, then `expect_diagnostic`, then options modifiers, then `ignore`, then `file=path`

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Use the `useConsistent` prefix for rules that ensure consistency across the codebase (e.g., `useConsistentArrayType`)

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Avoid using `unwrap()` or `expect()` on `Result` and `Option` types; instead use helper functions like `map`, `filter`, `and_then` to maintain code clarity and avoid panics

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Check if a variable is global before banning it to avoid false positives when the variable is redeclared in local scope; use the semantic model to verify global scope

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Use the `noUndeclared` prefix for rules that report undefined entities (e.g., `noUndeclaredVariables`)

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Use the `noUnused` prefix for rules that report unused entities (e.g., `noUnusedVariables`)

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-24T18:05:20.371Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-11-24T18:05:20.371Z
Learning: Applies to crates/biome_formatter/**/biome_*_formatter/src/context.rs : Define `<Language>FormatContext` struct in a `context.rs` file containing `comments` and `source_map` fields, implementing `FormatContext` and `CstFormatContext` traits

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-27T23:04:02.022Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-11-27T23:04:02.022Z
Learning: Applies to crates/biome_analyze/**/*analyze/src/lint/**/*.rs : Use the `useShorthand` prefix for rules that report syntax rewritable using equivalent compact syntax (e.g., `useShorthandAssign`)

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-24T18:05:42.356Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_js_type_info/CONTRIBUTING.md:0-0
Timestamp: 2025-11-24T18:05:42.356Z
Learning: Applies to crates/biome_js_type_info/**/scoped_resolver.rs : Implement full inference to resolve `TypeReference::Import` variants across the entire module graph

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-24T18:05:42.356Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_js_type_info/CONTRIBUTING.md:0-0
Timestamp: 2025-11-24T18:05:42.356Z
Learning: Applies to crates/biome_js_type_info/**/*.rs : Use `TypeReference` variants (`Qualifier`, `Resolved`, `Import`, `Unknown`) to represent different phases of type resolution

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

📚 Learning: 2025-11-21T01:10:53.059Z

Learnt from: dyc3
Repo: biomejs/biome PR: 8171
File: crates/biome_js_analyze/src/lint/nursery/no_leaked_render.rs:125-137
Timestamp: 2025-11-21T01:10:53.059Z
Learning: In the Biome codebase, each lint rule has its own options type declaration (e.g., `type Options = RuleNameOptions`) as part of the codegen process, even if the options struct is empty or unused. This is standard practice and should not be flagged as an issue.

Applied to files:

crates/biome_js_analyze/src/assist/source/organize_imports.rs

🔇 Additional comments (1)

crates/biome_js_analyze/src/assist/source/organize_imports.rs (1)

114-114: Documentation improvements look great.

All four changes polish the rustdoc for clarity and correctness—fixing grammar ("To group them together"), improving phrasing ("you may want" vs "you can want"), correcting spelling ("in case"), and refining word choice throughout the documentation. These non-functional updates make the guidance clearer for users without altering any logic or APIs.

Also applies to: 270-270, 607-607, 636-636

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

Conaclos · 2025-12-17T14:21:59Z

Thanks! :)

ematipico

Thank you!

codspeed-hq · 2025-12-17T14:39:05Z

CodSpeed Performance Report

Merging #8490 will not alter performance

_{Comparing sergioness:fix/typo-organise-imports (54a4ffa) with main (fd279f3)¹}

Summary

✅ 58 untouched
⏩ 95 skipped²

No successful run was found on main (67546bc) during the generation of this report, so fd279f3 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
95 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. ↩

docs: fix typos for assist/actions/organize-imports

54a4ffa

github-actions bot added A-Linter Area: linter L-JavaScript Language: JavaScript and super languages labels Dec 17, 2025

sergioness mentioned this pull request Dec 17, 2025

docs: fix typos in assist/actions/organize-imports rule biomejs/website#3678

Closed

Conaclos approved these changes Dec 17, 2025

View reviewed changes

ematipico approved these changes Dec 17, 2025

View reviewed changes

ematipico merged commit 86bd299 into biomejs:main Dec 17, 2025
16 checks passed

l0ngvh pushed a commit to l0ngvh/biome that referenced this pull request Dec 21, 2025

docs: fix typos for assist/actions/organize-imports (biomejs#8490)

53788e5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: fix typos for assist/actions/organize-imports #8490

docs: fix typos for assist/actions/organize-imports #8490

Uh oh!

sergioness commented Dec 17, 2025

Uh oh!

changeset-bot bot commented Dec 17, 2025

Uh oh!

coderabbitai bot commented Dec 17, 2025

Uh oh!

Conaclos commented Dec 17, 2025

Uh oh!

ematipico left a comment

Uh oh!

Uh oh!

codspeed-hq bot commented Dec 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

docs: fix typos for assist/actions/organize-imports #8490

docs: fix typos for assist/actions/organize-imports #8490

Uh oh!

Conversation

sergioness commented Dec 17, 2025

Summary

Test Plan

Docs

Uh oh!

changeset-bot bot commented Dec 17, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Dec 17, 2025

Walkthrough

Pre-merge checks and finishing touches

Uh oh!

Conaclos commented Dec 17, 2025

Uh oh!

ematipico left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codspeed-hq bot commented Dec 17, 2025

CodSpeed Performance Report

Merging #8490 will not alter performance

Summary

Footnotes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants