Skip to content

Commit e62fd98

Browse files
committed
docs(linter): correct comment on what EnablePlugins does (#15668)
`EnablePlugins` also allows *disabling* plugins. Correct the doc comment to reflect that. I believe this will correct section header in docs on website (https://oxc.rs/docs/guide/usage/linter/cli.html#enable-plugins), because that file appears to be auto-generated from this comment. Note: There are no links on website that reference `#enable-plugins` anchor, so it shouldn't break any links when this anchor changes to `#enable-disable-plugins`.
1 parent a25d31e commit e62fd98

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

apps/oxlint/src/command/lint.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ pub struct OutputOptions {
240240
pub format: OutputFormat,
241241
}
242242

243-
/// Enable Plugins
243+
/// Enable/Disable Plugins
244244
#[expect(clippy::struct_field_names)]
245245
#[derive(Debug, Default, Clone, Bpaf)]
246246
pub struct EnablePlugins {

tasks/website/src/linter/snapshots/cli.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Arguments:
5151

5252

5353

54-
## Enable Plugins
54+
## Enable/Disable Plugins
5555
- **` --disable-unicorn-plugin`** —
5656
Disable unicorn plugin, which is turned on by default
5757
- **` --disable-oxc-plugin`** —

tasks/website/src/linter/snapshots/cli_terminal.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Allowing / Denying Multiple Lints
3131
-W, --warn=NAME Deny the rule or category (emit a warning)
3232
-D, --deny=NAME Deny the rule or category (emit an error)
3333

34-
Enable Plugins
34+
Enable/Disable Plugins
3535
--disable-unicorn-plugin Disable unicorn plugin, which is turned on by default
3636
--disable-oxc-plugin Disable oxc unique rules, which is turned on by default
3737
--disable-typescript-plugin Disable TypeScript plugin, which is turned on by default

0 commit comments

Comments
 (0)