docs: node protocol rule reference #8328

Netail · 2025-12-01T09:35:57Z

Summary

eslint-plugin-import also has a nodejs protocol enforce rule

Test Plan

Docs

changeset-bot · 2025-12-01T09:36:02Z

🦋 Changeset detected

Latest commit: 7d18b0a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages

Name	Type
@biomejs/biome	Patch
@biomejs/cli-win32-x64	Patch
@biomejs/cli-win32-arm64	Patch
@biomejs/cli-darwin-x64	Patch
@biomejs/cli-darwin-arm64	Patch
@biomejs/cli-linux-x64	Patch
@biomejs/cli-linux-arm64	Patch
@biomejs/cli-linux-x64-musl	Patch
@biomejs/cli-linux-arm64-musl	Patch
@biomejs/wasm-web	Patch
@biomejs/wasm-bundler	Patch
@biomejs/wasm-nodejs	Patch
@biomejs/backend-jsonrpc	Patch

Not sure what this means? Click here to learn what changesets are.

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

coderabbitai · 2025-12-01T09:38:35Z

Walkthrough

The UseNodejsImportProtocol lint rule's sources field was expanded to include an additional ESLint source. It now lists both EslintUnicorn("prefer-node-protocol") and EslintImport("enforce-node-protocol-usage"), updating the rule metadata to recognise both the Unicorn and Import ESLint plugins as sources.

Possibly related PRs

docs: rules.rs cleanup #8044 — Refactors the RuleSource variants and updates lint rule source selectors across rules, which aligns with adding an EslintImport source here.

Suggested reviewers

dyc3
ematipico

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title mentions 'docs' and 'node protocol rule reference', but the actual changes add an ESLint source to the lint rule itself, not documentation.	Update the title to reflect the actual change, such as 'Add eslint-import source to UseNodejsImportProtocol rule' or similar.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description mentions eslint-plugin-import having a Node.js protocol enforcement rule, which relates to the actual code changes adding that rule source.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch Netail-patch-1

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

siketyan

Looks changeset is missing 👀

codspeed-hq · 2025-12-01T09:56:27Z

CodSpeed Performance Report

Merging #8328 will not alter performance

_{Comparing Netail-patch-1 (7d18b0a) with main (8de2774)¹}

Summary

✅ 58 untouched
⏩ 95 skipped²

No successful run was found on main (1da899b) during the generation of this report, so 8de2774 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. ↩

coderabbitai

Actionable comments posted: 1

📜 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 2b34473 and 7d18b0a.

⛔ Files ignored due to path filters (1)

crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs is excluded by !**/migrate/eslint_any_rule_to_biome.rs and included by **

📒 Files selected for processing (1)

.changeset/small-shoes-know.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

.changeset/**/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

.changeset/**/*.md: Create changesets for user-facing changes using just new-changeset; use headers with #### or ##### only; keep descriptions concise (1-3 sentences) and focus on user-facing changes
Use past tense when describing what was done ('Added new feature'), present tense when describing Biome behavior ('Biome now supports'); end sentences with a full stop
For new lint rules, show an example of an invalid case in an inline code snippet or code block; for rule changes, demonstrate what is now invalid or valid; for formatter changes, use a diff code block

Files:

.changeset/small-shoes-know.md

🧠 Learnings (9)

📓 Common learnings

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 : For rules ported from other ecosystems like ESLint or Clippy, add a `sources` field with `RuleSource` metadata using `.same()` for identical behavior or `.inspired()` for different behavior

📚 Learning: 2025-11-28T09:08:10.077Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-11-28T09:08:10.077Z
Learning: Applies to .changeset/**/*.md : Create changesets for user-facing changes using `just new-changeset`; use headers with `####` or `#####` only; keep descriptions concise (1-3 sentences) and focus on user-facing changes

Applied to files:

.changeset/small-shoes-know.md

📚 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: Commit rule changes with message format: `feat(biome_<crate>): <ruleName>` to follow Biome's conventional commit style

Applied to files:

.changeset/small-shoes-know.md

📚 Learning: 2025-11-28T09:08:10.077Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-11-28T09:08:10.077Z
Learning: Applies to .changeset/**/*.md : Use past tense when describing what was done ('Added new feature'), present tense when describing Biome behavior ('Biome now supports'); end sentences with a full stop

Applied to files:

.changeset/small-shoes-know.md

📚 Learning: 2025-08-05T14:43:29.581Z

Learnt from: dyc3
Repo: biomejs/biome PR: 7081
File: packages/@biomejs/biome/configuration_schema.json:7765-7781
Timestamp: 2025-08-05T14:43:29.581Z
Learning: The file `packages/biomejs/biome/configuration_schema.json` is auto-generated and should not be manually edited or reviewed for schema issues; any changes should be made at the code generation source.

Applied to files:

.changeset/small-shoes-know.md

📚 Learning: 2025-11-28T09:08:10.077Z

Learnt from: CR
Repo: biomejs/biome PR: 0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-11-28T09:08:10.077Z
Learning: Applies to .changeset/**/*.md : For new lint rules, show an example of an invalid case in an inline code snippet or code block; for rule changes, demonstrate what is now invalid or valid; for formatter changes, use a `diff` code block

Applied to files:

.changeset/small-shoes-know.md

📚 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: Biome linter is designed to work across languages, so rule naming should be generic if potentially implementable for multiple languages, or specific if meant for one language only

Applied to files:

.changeset/small-shoes-know.md

📚 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 : For rules ported from other ecosystems like ESLint or Clippy, add a `sources` field with `RuleSource` metadata using `.same()` for identical behavior or `.inspired()` for different behavior

Applied to files:

.changeset/small-shoes-know.md

📚 Learning: 2025-10-25T07:02:26.457Z

Learnt from: ematipico
Repo: biomejs/biome PR: 7856
File: .changeset/yellow-crews-guess.md:1-5
Timestamp: 2025-10-25T07:02:26.457Z
Learning: The Biome documentation website uses kebab-case URL slugs for rule pages (e.g., `/linter/rules/no-continue/`), not camelCase.

Applied to files:

.changeset/small-shoes-know.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

GitHub Check: Bench (biome_js_analyze)
GitHub Check: Bench (biome_js_parser)
GitHub Check: Bench (biome_js_formatter)
GitHub Check: Documentation
GitHub Check: End-to-end tests
GitHub Check: Lint project (depot-windows-2022)
GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
GitHub Check: Test (depot-windows-2022-16)
GitHub Check: Test (depot-ubuntu-24.04-arm-16)
GitHub Check: Check Dependencies
GitHub Check: autofix
GitHub Check: Test Node.js API

coderabbitai · 2025-12-01T10:27:36Z

.changeset/small-shoes-know.md

+"@biomejs/biome": patch
+---
+
+Corrected rule source reference. `biome migrate eslint` should do a bit better detecting rules in your eslint configurations.


⚠️ Potential issue | 🟠 Major

Clarify the user-facing impact; avoid technical jargon.

The description is too vague and technical for users reading the changelog. "Rule source reference" and "should do a bit better" don't clearly communicate what changed or why it matters. Based on the AI summary, this relates to the migration tool correctly detecting eslint-plugin-import's rule.

Reword the description to be more user-centric and precise:

-Corrected rule source reference. `biome migrate eslint` should do a bit better detecting rules in your eslint configurations. +The `biome migrate eslint` command now correctly detects the `enforce-node-protocol-usage` rule from eslint-plugin-import.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

Corrected rule source reference. `biome migrate eslint` should do a bit better detecting rules in your eslint configurations.

---

"@biomejs/biome": patch

---

The `biome migrate eslint` command now correctly detects the `enforce-node-protocol-usage` rule from eslint-plugin-import.

🤖 Prompt for AI Agents

.changeset/small-shoes-know.md around line 5: the changelog entry is vague and uses technical terms; rewrite it to be user-facing and specific about the impact (e.g., the migration tool now correctly recognizes rules from eslint-plugin-import when running `biome migrate eslint`), remove phrases like "rule source reference" and "should do a bit better," and provide a concise sentence that explains what changed and why it matters to users (for example: that migrations will now preserve or map import-related ESLint rules correctly).

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

docs: node protocol rule reference

2b34473

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

[autofix.ci] apply automated fixes

6b16e89

github-actions bot added the A-CLI Area: CLI label Dec 1, 2025

siketyan approved these changes Dec 1, 2025

View reviewed changes

siketyan reviewed Dec 1, 2025

View reviewed changes

changeset

7d18b0a

coderabbitai bot reviewed Dec 1, 2025

View reviewed changes

Netail merged commit 9cf2332 into main Dec 1, 2025
18 checks passed

Netail deleted the Netail-patch-1 branch December 1, 2025 10:38

github-actions bot mentioned this pull request Dec 1, 2025

ci: release #8286

Merged

coderabbitai bot mentioned this pull request Dec 12, 2025

feat(lint): update docs & diagnostic for lint/nursery/noProto #8414

Merged

This was referenced Dec 15, 2025

ci: release #8467

Merged

ci: release #8469

Merged

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

docs: node protocol rule reference (biomejs#8328)

8df88b2

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: node protocol rule reference #8328

docs: node protocol rule reference #8328

Netail commented Dec 1, 2025

Uh oh!

changeset-bot bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

siketyan left a comment

Uh oh!

codspeed-hq bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Dec 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

docs: node protocol rule reference #8328

docs: node protocol rule reference #8328

Conversation

Netail commented Dec 1, 2025

Summary

Test Plan

Docs

Uh oh!

changeset-bot bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Possibly related PRs

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

siketyan left a comment

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #8328 will not alter performance

Summary

Footnotes

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Dec 1, 2025 •

edited

Loading

coderabbitai bot commented Dec 1, 2025 •

edited

Loading

codspeed-hq bot commented Dec 1, 2025 •

edited

Loading