docs(linter): Improve rule docs for 27 unicorn rules

[connorshea]

Ok I lied, it's 26 unicorn rules and 1 vue rule. Sorry.

No AI here :)

This PR generally improves the documentation for all of these rules to provide more examples, improved explanations for the rules' purposes, and so on.

It also adds MDN links where relevant via new diagnostic notes.

(note: if this gets merged before the release but after the website PR is generated, make sure to regenerate the website PR 🙂)

[Copilot]

Pull request overview

This PR updates user-facing rule documentation and diagnostics for a set of linter rules (primarily unicorn, plus vue/max-props), adding clearer explanations, expanded examples, and MDN links surfaced as diagnostic notes. It also refreshes snapshot outputs to match the updated diagnostic text.

Changes:

• Improved rule docs (“What it does” / “Why is this bad?” / examples) across multiple unicorn rules and vue/max-props.
• Updated several diagnostics/help texts for clarity and consistency, and added MDN links via with_note(...) where relevant.
• Regenerated/updated snapshot files to reflect new diagnostic output.

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
crates/oxc_linter/src/snapshots/vue_max_props.snap	Snapshot updated for revised vue/max-props diagnostic/help text.
crates/oxc_linter/src/snapshots/unicorn_prefer_keyboard_event_key.snap	Snapshot updated to include new MDN note: output.
crates/oxc_linter/src/snapshots/unicorn_prefer_global_this.snap	Snapshot updated to include new MDN note: output.
crates/oxc_linter/src/snapshots/unicorn_prefer_event_target.snap	Snapshot updated for punctuation + new MDN note: output.
crates/oxc_linter/src/snapshots/unicorn_prefer_at.snap	Snapshot updated for punctuation + new MDN note: output.
crates/oxc_linter/src/snapshots/unicorn_no_static_only_class.snap	Snapshot updated for revised diagnostic message formatting.
crates/oxc_linter/src/snapshots/unicorn_no_document_cookie.snap	Snapshot updated for punctuation + new MDN note: output.
crates/oxc_linter/src/snapshots/unicorn_consistent_assert.snap	Snapshot updated for punctuation/backtick formatting in diagnostics.
crates/oxc_linter/src/rules/vue/max_props.rs	Improves max-props docs and refines diagnostic/help wording.
crates/oxc_linter/src/rules/unicorn/prefer_negative_index.rs	Expands rule docs and tweaks test formatting.
crates/oxc_linter/src/rules/unicorn/prefer_keyboard_event_key.rs	Adds MDN note to diagnostics and improves rule docs/examples.
crates/oxc_linter/src/rules/unicorn/prefer_global_this.rs	Adds MDN note to diagnostics and refines rule docs formatting.
crates/oxc_linter/src/rules/unicorn/prefer_event_target.rs	Adds MDN note and adjusts diagnostic punctuation.
crates/oxc_linter/src/rules/unicorn/prefer_class_fields.rs	Expands rule examples to better illustrate preferred patterns.
crates/oxc_linter/src/rules/unicorn/prefer_at.rs	Adds MDN note and improves rule docs wording/links.
crates/oxc_linter/src/rules/unicorn/numeric_separators_style.rs	Improves “Why is this bad?” explanation with clearer examples.
crates/oxc_linter/src/rules/unicorn/no_useless_undefined.rs	Expands docs, adds warning callout, and fixes doc comment spacing.
crates/oxc_linter/src/rules/unicorn/no_useless_switch_case.rs	Clarifies rule intent and improves examples/readability.
crates/oxc_linter/src/rules/unicorn/no_useless_promise_resolve_reject.rs	Reflows and clarifies long-form explanation text.
crates/oxc_linter/src/rules/unicorn/no_useless_collection_argument.rs	Clarifies wording and formatting in docs/examples.
crates/oxc_linter/src/rules/unicorn/no_unreadable_array_destructuring.rs	Adds clearer rationale and more illustrative examples.
crates/oxc_linter/src/rules/unicorn/no_unnecessary_slice_end.rs	Clarifies description/rationale and improves wording.
crates/oxc_linter/src/rules/unicorn/no_thenable.rs	Improves wording and formatting of examples and rationale.
crates/oxc_linter/src/rules/unicorn/no_static_only_class.rs	Improves diagnostic text and rule documentation/examples.
crates/oxc_linter/src/rules/unicorn/no_single_promise_in_promise_methods.rs	Improves punctuation/formatting and example readability.
crates/oxc_linter/src/rules/unicorn/no_process_exit.rs	Expands rationale and reformats examples.
crates/oxc_linter/src/rules/unicorn/no_magic_array_flat_depth.rs	Improves documentation wording and adds MDN link in prose.
crates/oxc_linter/src/rules/unicorn/no_invalid_fetch_options.rs	Re-formats examples for readability/consistency.
crates/oxc_linter/src/rules/unicorn/no_instanceof_array.rs	Clarifies cross-realm rationale wording.
crates/oxc_linter/src/rules/unicorn/no_hex_escape.rs	Improves formatting and expands “Why is this bad?” rationale.
crates/oxc_linter/src/rules/unicorn/no_document_cookie.rs	Updates diagnostic/help punctuation, adds MDN note, and refines docs.
crates/oxc_linter/src/rules/unicorn/no_console_spaces.rs	Reflows rationale text for readability.
crates/oxc_linter/src/rules/unicorn/no_accessor_recursion.rs	Expands docs and improves examples/formatting.
crates/oxc_linter/src/rules/unicorn/explicit_length_check.rs	Adds rationale and expands “correct” examples.
crates/oxc_linter/src/rules/unicorn/consistent_assert.rs	Improves diagnostic punctuation/formatting and expands rationale.

[codspeed-hq]

Merging this PR will not alter performance

✅ 4 untouched benchmarks
⏩ 52 skipped benchmarks¹

---

_{Comparing docs-improvements (9de967c) with main (733d6dc)}

Footnotes

1. 52 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. ↩

[camc314]

💪

[camc314]

Will merge this after the release today

[camc314]

Merge activity

• Mar 2, 11:46 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Mar 2, 11:46 AM UTC: camc314 added this pull request to the Graphite merge queue.
• Mar 2, 11:57 AM UTC: Merged by the Graphite merge queue.