docs(linter): reformat doc comments by overlookmotel · Pull Request #15670 · oxc-project/oxc

overlookmotel · 2025-11-13T12:23:28Z

Really anal style nits for CLI options. Standardize formatting based on the following rules:

Capitalized first letter.
No full stops on end, unless comment contains multiple sentences (in which case, always full stop).
Quote filenames and technical names in backticks (e.g. .eslintignore, nursery).
Imperative style ("Disable" not "Disables").

These are the existing stylistic conventions, which comments mostly followed. This PR just corrects the few which didn't, to bring all the doc comments into line stylistically.

Main purpose is to clean up the docs on website: https://oxc.rs/docs/guide/usage/linter/cli.html

overlookmotel · 2025-11-13T12:23:43Z

docs(linter): oxlint-disable not eslint-disable #15672
docs(linter): reformat doc comments #15670 👈 (View in Graphite)
main

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

0-merge - adds this PR to the back of the merge queue
hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

_{An organization admin has enabled the Graphite Merge Queue in this repository.} _{Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.}

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copilot

Pull Request Overview

This PR standardizes documentation comment formatting across CLI option descriptions, ensuring consistency throughout the codebase. The changes apply established style conventions including capitalization, punctuation rules, backtick usage for technical terms, and imperative phrasing.

Applied consistent capitalization to first letters of descriptions
Corrected punctuation: removed periods from single sentences, retained periods for multi-sentence descriptions
Added backticks around filenames (.eslintignore, .gitignore) and category names (nursery)
Converted descriptions to imperative style ("Disable" instead of "Disables")

Reviewed Changes

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

Show a summary per file

File	Description
`apps/oxlint/src/command/mod.rs`	Updated `threads` option description to add period for multi-sentence comment
`apps/oxlint/src/command/lint.rs`	Standardized formatting for rule categories, fix options, and configuration options; applied capitalization, punctuation, backticks, and imperative style
`apps/oxlint/src/command/ignore.rs`	Added backticks around `.eslintignore` and `.gitignore` references; corrected punctuation and changed to imperative style
`apps/oxfmt/src/command.rs`	Updated `threads` option description to add period for multi-sentence comment
`tasks/website/src/linter/snapshots/cli_terminal.snap`	Auto-generated snapshot reflecting source code documentation changes
`tasks/website/src/linter/snapshots/cli.snap`	Auto-generated snapshot reflecting source code documentation changes

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

camc314 · 2025-11-13T13:49:50Z

Merge activity

Nov 13, 1:49 PM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
Nov 13, 1:49 PM UTC: camc314 added this pull request to the Graphite merge queue.
Nov 13, 1:55 PM UTC: Merged by the Graphite merge queue.

Really anal style nits for CLI options. Standardize formatting based on the following rules: * Capitalized first letter. * No full stops on end, unless comment contains multiple sentences (in which case, always full stop). * Quote filenames and technical names in backticks (e.g. `.eslintignore`, `nursery`). * Imperative style ("Disable" not "Disables"). These are the existing stylistic conventions, which comments mostly followed. This PR just corrects the few which didn't, to bring all the doc comments into line stylistically. Main purpose is to clean up the docs on website: https://oxc.rs/docs/guide/usage/linter/cli.html

# Oxlint ### 🚀 Features - c199e38 linter: Implement config for all tsgolint rules supporting options (#15659) (camchenry) - 7598b3e linter: Allow configuring tsgolint rules (#15286) (camchenry) - e77f2ce vscode: Support `oxlint --lsp` (#15680) (Sysix) - e01c551 oxlint: Add `--lsp` flag to run the language server (#15611) (Sysix) - ac5c2ab lsp/fmt: Support ignore files & patterns (#15647) (Sysix) - e50a9bf linter: Add unicorn/prefer-response-static-json rule (#15692) (Mikhail Baev) - f5d9abb oxlint: Add enabled? column to --rules cli output (#15213) (Wren) - 6b5205c linter/plugins: Implement deprecated `SourceCode#getJSDocComment` method (#15653) (overlookmotel) - 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens methods (#15645) (overlookmotel) - 4c62ffa language_server: Add `run_server` helper for CLI tools (#15609) (Sysix) - 0d52a5e linter/plugins: Implement `Context#parserOptions` getter (#15632) (overlookmotel) - 287a538 linter/plugins: Implement `Context#get*` deprecated methods (#15606) (overlookmotel) - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - e763919 linter: Add test to enforce schema documentation for rules with configuration options (#15234) (Connor Shea) - 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr` option (#15507) (Li Wei) ### 🐛 Bug Fixes - 1decd57 linter/no-empty-named-blocks: Only search within node for comma token (#15751) (camc314) - 17c3d6d linter: Improve docs, diagnostic message, and implementation of typescript/consistent-indexed-object-style rule. (#15750) (connorshea) - 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for token (#15735) (camc314) - 042befd linter/require-await: Skip comments when searching for token (#15734) (camc314) - 7a78220 linter/no-async-await: Skip comments when searching for token (#15733) (camc314) - 23b9ad1 linter/consistent-type-specifier-style: Skip comments when searching for token (#15732) (camc314) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) - 516d14e linter/no-namespace: Skip comments when searching for token (#15716) (camc314) - b5aaace linter/prefer-namespace-keyword: Skip comments when searching for token (#15715) (camc314) - 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (#14203) (Sysix) - 9f991a4 linter: Reverse extends overrides priority (#14939) (Peter Wagenet) - 7c4a916 linter: Restores `oxlint --rules -f=json` functionality. (#15689) (Wren) - 24d00f4 linter/plugins: Add types for suggested fixes (#15636) (overlookmotel) - 257360f linter/plugins: Fill in TS type def for `RuleMeta` (#15629) (overlookmotel) - 81e179c linter: Allow file extensions without a dot in react/jsx-filename-extension rule (#15574) (Connor Shea) - 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs (#15581) (connorshea) - bb5f8ca oxlint: Fix type annotation for big-endian (#15561) (Sysix) ### ⚡ Performance - e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat mode (#15693) (overlookmotel) - 7528db4 language_server: Pass file content as a referenced `String` (#15568) (Sysix) - 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines` (#15641) (overlookmotel) - ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (#15516) (Sysix) ### 📚 Documentation - 3ab750a linter: Clarify react-in-jsx-scope rule docs. (#15749) (connorshea) - a5feebc linter: `oxlint-disable` not `eslint-disable` (#15672) (overlookmotel) - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) - 16fcba6 linter: Remove "experimental" from description of stable features (#15669) (overlookmotel) - e62fd98 linter: Correct comment on what `EnablePlugins` does (#15668) (overlookmotel) - a25d31e linter: Fix grammar (#15666) (overlookmotel) - f5f452f linter: Add missing `perf` category (#15667) (overlookmotel) - 2c58952 linter: Add config docs for no-restricted-globals rule. (#15662) (connorshea) - a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema` (#15642) (overlookmotel) - 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in ESLint-compat `Context` shim (#15605) (overlookmotel) - fd58aea linter: Fix a typo in the docs for react/no-is-mounted. (#15575) (Connor Shea) # Oxfmt ### 🚀 Features - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (#15612) (leaysgur) - 99823ad oxfmt: Print nothing for default(write) mode (#15583) (leaysgur) - 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>` groups (#15578) (leaysgur) ### 🐛 Bug Fixes - bf20cf5 formatter: `CRLF` issue in the member chain (#15764) (Dunqing) - 5d688a0 formatter: Measuring multiline text in `fits_text` is incorrect (#15762) (Dunqing) - e306958 formatter: Regression case for test call (#15760) (Dunqing) - c42d983 formatter: Re-fix all cases that fail after `AstNode::Argument` was removed (#15676) (Dunqing) ### ⚡ Performance - d99a83f oxfmt: Use simdutf8 based read_to_string (#15614) (leaysgur) - 128e186 formatter/sort_imports: Precompute import metadata (#15580) (leaysgur) - cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for `next_elements` (#15579) (leaysgur) ### 📚 Documentation - 3d15805 linter: Reformat doc comments (#15670) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

# Oxlint ### 🚀 Features - c199e38 linter: Implement config for all tsgolint rules supporting options (oxc-project#15659) (camchenry) - 7598b3e linter: Allow configuring tsgolint rules (oxc-project#15286) (camchenry) - e77f2ce vscode: Support `oxlint --lsp` (oxc-project#15680) (Sysix) - e01c551 oxlint: Add `--lsp` flag to run the language server (oxc-project#15611) (Sysix) - ac5c2ab lsp/fmt: Support ignore files & patterns (oxc-project#15647) (Sysix) - e50a9bf linter: Add unicorn/prefer-response-static-json rule (oxc-project#15692) (Mikhail Baev) - f5d9abb oxlint: Add enabled? column to --rules cli output (oxc-project#15213) (Wren) - 6b5205c linter/plugins: Implement deprecated `SourceCode#getJSDocComment` method (oxc-project#15653) (overlookmotel) - 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens methods (oxc-project#15645) (overlookmotel) - 4c62ffa language_server: Add `run_server` helper for CLI tools (oxc-project#15609) (Sysix) - 0d52a5e linter/plugins: Implement `Context#parserOptions` getter (oxc-project#15632) (overlookmotel) - 287a538 linter/plugins: Implement `Context#get*` deprecated methods (oxc-project#15606) (overlookmotel) - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (oxc-project#15612) (leaysgur) - e763919 linter: Add test to enforce schema documentation for rules with configuration options (oxc-project#15234) (Connor Shea) - 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr` option (oxc-project#15507) (Li Wei) ### 🐛 Bug Fixes - 1decd57 linter/no-empty-named-blocks: Only search within node for comma token (oxc-project#15751) (camc314) - 17c3d6d linter: Improve docs, diagnostic message, and implementation of typescript/consistent-indexed-object-style rule. (oxc-project#15750) (connorshea) - 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for token (oxc-project#15735) (camc314) - 042befd linter/require-await: Skip comments when searching for token (oxc-project#15734) (camc314) - 7a78220 linter/no-async-await: Skip comments when searching for token (oxc-project#15733) (camc314) - 23b9ad1 linter/consistent-type-specifier-style: Skip comments when searching for token (oxc-project#15732) (camc314) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (oxc-project#15710) (camc314) - 516d14e linter/no-namespace: Skip comments when searching for token (oxc-project#15716) (camc314) - b5aaace linter/prefer-namespace-keyword: Skip comments when searching for token (oxc-project#15715) (camc314) - 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (oxc-project#14203) (Sysix) - 9f991a4 linter: Reverse extends overrides priority (oxc-project#14939) (Peter Wagenet) - 7c4a916 linter: Restores `oxlint --rules -f=json` functionality. (oxc-project#15689) (Wren) - 24d00f4 linter/plugins: Add types for suggested fixes (oxc-project#15636) (overlookmotel) - 257360f linter/plugins: Fill in TS type def for `RuleMeta` (oxc-project#15629) (overlookmotel) - 81e179c linter: Allow file extensions without a dot in react/jsx-filename-extension rule (oxc-project#15574) (Connor Shea) - 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs (oxc-project#15581) (connorshea) - bb5f8ca oxlint: Fix type annotation for big-endian (oxc-project#15561) (Sysix) ### ⚡ Performance - e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat mode (oxc-project#15693) (overlookmotel) - 7528db4 language_server: Pass file content as a referenced `String` (oxc-project#15568) (Sysix) - 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines` (oxc-project#15641) (overlookmotel) - ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (oxc-project#15516) (Sysix) ### 📚 Documentation - 3ab750a linter: Clarify react-in-jsx-scope rule docs. (oxc-project#15749) (connorshea) - a5feebc linter: `oxlint-disable` not `eslint-disable` (oxc-project#15672) (overlookmotel) - 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel) - 16fcba6 linter: Remove "experimental" from description of stable features (oxc-project#15669) (overlookmotel) - e62fd98 linter: Correct comment on what `EnablePlugins` does (oxc-project#15668) (overlookmotel) - a25d31e linter: Fix grammar (oxc-project#15666) (overlookmotel) - f5f452f linter: Add missing `perf` category (oxc-project#15667) (overlookmotel) - 2c58952 linter: Add config docs for no-restricted-globals rule. (oxc-project#15662) (connorshea) - a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema` (oxc-project#15642) (overlookmotel) - 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in ESLint-compat `Context` shim (oxc-project#15605) (overlookmotel) - fd58aea linter: Fix a typo in the docs for react/no-is-mounted. (oxc-project#15575) (Connor Shea) # Oxfmt ### 🚀 Features - 84de1ca oxlint,oxfmt: Allow comments and also commas for vscode-json-ls (oxc-project#15612) (leaysgur) - 99823ad oxfmt: Print nothing for default(write) mode (oxc-project#15583) (leaysgur) - 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>` groups (oxc-project#15578) (leaysgur) ### 🐛 Bug Fixes - bf20cf5 formatter: `CRLF` issue in the member chain (oxc-project#15764) (Dunqing) - 5d688a0 formatter: Measuring multiline text in `fits_text` is incorrect (oxc-project#15762) (Dunqing) - e306958 formatter: Regression case for test call (oxc-project#15760) (Dunqing) - c42d983 formatter: Re-fix all cases that fail after `AstNode::Argument` was removed (oxc-project#15676) (Dunqing) ### ⚡ Performance - d99a83f oxfmt: Use simdutf8 based read_to_string (oxc-project#15614) (leaysgur) - 128e186 formatter/sort_imports: Precompute import metadata (oxc-project#15580) (leaysgur) - cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for `next_elements` (oxc-project#15579) (leaysgur) ### 📚 Documentation - 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>

github-actions bot added A-linter Area - Linter A-cli Area - CLI A-formatter Area - Formatter labels Nov 13, 2025

github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Nov 13, 2025

overlookmotel marked this pull request as ready for review November 13, 2025 12:28

overlookmotel requested a review from camc314 as a code owner November 13, 2025 12:28

Copilot AI review requested due to automatic review settings November 13, 2025 12:28

overlookmotel assigned camc314 Nov 13, 2025

Copilot started reviewing on behalf of overlookmotel November 13, 2025 12:29 View session

Copilot finished reviewing on behalf of overlookmotel November 13, 2025 12:30

Copilot AI reviewed Nov 13, 2025

View reviewed changes

overlookmotel mentioned this pull request Nov 13, 2025

docs(linter): oxlint-disable not eslint-disable #15672

Merged

camc314 approved these changes Nov 13, 2025

View reviewed changes

camc314 added the 0-merge Merge with Graphite Merge Queue label Nov 13, 2025

graphite-app bot force-pushed the 11-13-docs_linter_reformat_doc_comments branch from 791b7ef to 3d15805 Compare November 13, 2025 13:50

graphite-app bot merged commit 3d15805 into main Nov 13, 2025
18 checks passed

graphite-app bot deleted the 11-13-docs_linter_reformat_doc_comments branch November 13, 2025 13:55

graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 13, 2025

Boshen mentioned this pull request Nov 17, 2025

release(apps): oxlint v1.29.0 && oxfmt v0.14.0 #15772

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

docs(linter): reformat doc comments#15670

docs(linter): reformat doc comments#15670
graphite-app[bot] merged 1 commit intomainfrom
11-13-docs_linter_reformat_doc_comments

overlookmotel commented Nov 13, 2025 •

edited

Loading

Uh oh!

overlookmotel commented Nov 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

camc314 commented Nov 13, 2025 •

edited by graphite-app bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Comments

Conversation

overlookmotel commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

overlookmotel commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

camc314 commented Nov 13, 2025 • edited by graphite-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

overlookmotel commented Nov 13, 2025 •

edited

Loading

overlookmotel commented Nov 13, 2025 •

edited

Loading

camc314 commented Nov 13, 2025 •

edited by graphite-app bot

Loading