docs(linter): Cleanup docs for various rules for consistency.#18214
Merged
graphite-app[bot] merged 1 commit intomainfrom Jan 19, 2026
Merged
docs(linter): Cleanup docs for various rules for consistency.#18214graphite-app[bot] merged 1 commit intomainfrom
graphite-app[bot] merged 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
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
eslintor 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 Performance ReportMerging this PR will not alter performanceComparing Summary
Footnotes
|
Member
Author
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.
91523b1 to
4afa5c8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.