Skip to content

docs(linter): Cleanup docs for various rules for consistency.#18214

Merged
graphite-app[bot] merged 1 commit intomainfrom
directive-docs
Jan 19, 2026
Merged

docs(linter): Cleanup docs for various rules for consistency.#18214
graphite-app[bot] merged 1 commit intomainfrom
directive-docs

Conversation

@connorshea
Copy link
Member

Remove implied eslint directive comments, which are not supported, by removing the mention of eslint at the start of the comment. And then misc fixes alongside those.

Copilot AI review requested due to automatic review settings January 19, 2026 06:56
@connorshea connorshea requested a review from camc314 as a code owner January 19, 2026 06:56
@github-actions github-actions bot added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation labels Jan 19, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR cleans up documentation comments across various linter rules by removing unsupported ESLint directive comment prefixes and standardizing formatting for consistency.

Changes:

  • Removed eslint or plugin name prefixes from configuration comment examples (e.g., /*eslint rule: "error"*//* rule: "error" */)
  • Standardized spacing and quote usage in configuration examples
  • Improved documentation structure and clarity in specific rules

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
crates/oxc_linter/src/rules/promise/always_return.rs Removed "eslint" prefix from configuration comment
crates/oxc_linter/src/rules/jest/consistent_test_it.rs Removed "eslint" prefix and standardized spacing in three configuration comments
crates/oxc_linter/src/rules/import/no_anonymous_default_export.rs Removed "eslint" prefix and standardized formatting (quotes, spacing) in eight configuration comments
crates/oxc_linter/src/rules/import/no_absolute_path.rs Removed "eslint" prefix and standardized formatting in configuration comment
crates/oxc_linter/src/rules/eslint/no_unused_vars/mod.rs Removed ESLint directive comments and replaced with clearer Oxlint-specific guidance
crates/oxc_linter/src/rules/eslint/no_script_url.rs Removed ESLint directive comments and added colon to "Examples of incorrect code for this rule"
crates/oxc_linter/src/rules/eslint/no_proto.rs Removed ESLint directive comments
crates/oxc_linter/src/rules/eslint/new_cap.rs Removed "eslint" prefix and standardized formatting in 24 configuration comments
crates/oxc_linter/src/rules/eslint/init_declarations.rs Removed "eslint" prefix, improved documentation structure, and wrapped option names in backticks for clarity
crates/oxc_linter/src/rules/eslint/id_length.rs Removed "eslint" prefix in two configuration comments
crates/oxc_linter/src/rules/eslint/eqeqeq.rs Removed "eslint" prefix and standardized spacing in eight configuration comments

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codspeed-hq
Copy link

codspeed-hq bot commented Jan 19, 2026

CodSpeed Performance Report

Merging this PR will not alter performance

Comparing directive-docs (91523b1) with main (0c85326)

Summary

✅ 4 untouched benchmarks
⏩ 41 skipped benchmarks1

Footnotes

  1. 41 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.

@connorshea connorshea added the 0-merge Merge with Graphite Merge Queue label Jan 19, 2026
Copy link
Member Author

connorshea commented Jan 19, 2026

Merge activity

Remove implied eslint directive comments, which are not supported, by removing the mention of eslint at the start of the comment. And then misc fixes alongside those.
@graphite-app graphite-app bot merged commit 4afa5c8 into main Jan 19, 2026
21 checks passed
@graphite-app graphite-app bot deleted the directive-docs branch January 19, 2026 07:39
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants