Skip to content

Commit 16fcba6

Browse files
committed
docs(linter): remove "experimental" from description of stable features (#15669)
I don't believe these features are experimental any more: * `--config` CLI flag * `import` plugin * `jsdoc` plugin Remove the word "experimental" from doc comments related to these features. Also, improve grammar in description of `import` plugin. I believe this will also update docs on website (https://oxc.rs/docs/guide/usage/linter/cli.html#enable-plugins).
1 parent e62fd98 commit 16fcba6

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

apps/oxlint/src/command/lint.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ impl LintCommand {
105105
/// Basic Configuration
106106
#[derive(Debug, Clone, Bpaf)]
107107
pub struct BasicOptions {
108-
/// Oxlint configuration file (experimental)
108+
/// Oxlint configuration file
109109
/// * only `.json` extension is supported
110110
/// * you can use comments in configuration files.
111111
/// * tries to be compatible with ESLint v8's format
@@ -268,16 +268,16 @@ pub struct EnablePlugins {
268268
)]
269269
pub typescript_plugin: OverrideToggle,
270270

271-
/// Enable the experimental import plugin and detect ESM problems.
272-
/// It is recommended to use along side with the `--tsconfig` option.
271+
/// Enable import plugin and detect ESM problems.
272+
/// It is recommended to use alongside the `--tsconfig` option.
273273
#[bpaf(flag(OverrideToggle::Enable, OverrideToggle::NotSet), hide_usage)]
274274
pub import_plugin: OverrideToggle,
275275

276276
/// Enable react plugin, which is turned off by default
277277
#[bpaf(flag(OverrideToggle::Enable, OverrideToggle::NotSet), hide_usage)]
278278
pub react_plugin: OverrideToggle,
279279

280-
/// Enable the experimental jsdoc plugin and detect JSDoc problems
280+
/// Enable jsdoc plugin and detect JSDoc problems
281281
#[bpaf(flag(OverrideToggle::Enable, OverrideToggle::NotSet), hide_usage)]
282282
pub jsdoc_plugin: OverrideToggle,
283283

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ search: false
1212

1313
## Basic Configuration
1414
- **`-c`**, **`--config`**=_`<./.oxlintrc.json>`_ &mdash;
15-
Oxlint configuration file (experimental)
15+
Oxlint configuration file
1616
* only `.json` extension is supported
1717
* you can use comments in configuration files.
1818
* tries to be compatible with ESLint v8's format
@@ -59,11 +59,11 @@ Arguments:
5959
- **` --disable-typescript-plugin`** &mdash;
6060
Disable TypeScript plugin, which is turned on by default
6161
- **` --import-plugin`** &mdash;
62-
Enable the experimental import plugin and detect ESM problems. It is recommended to use along side with the `--tsconfig` option.
62+
Enable import plugin and detect ESM problems. It is recommended to use alongside the `--tsconfig` option.
6363
- **` --react-plugin`** &mdash;
6464
Enable react plugin, which is turned off by default
6565
- **` --jsdoc-plugin`** &mdash;
66-
Enable the experimental jsdoc plugin and detect JSDoc problems
66+
Enable jsdoc plugin and detect JSDoc problems
6767
- **` --jest-plugin`** &mdash;
6868
Enable the Jest plugin and detect test problems
6969
- **` --vitest-plugin`** &mdash;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ expression: snapshot
55
Usage: [-c=<./.oxlintrc.json>] [PATH]...
66

77
Basic Configuration
8-
-c, --config=<./.oxlintrc.json> Oxlint configuration file (experimental)
8+
-c, --config=<./.oxlintrc.json> Oxlint configuration file
99
* only `.json` extension is supported
1010
* you can use comments in configuration files.
1111
* tries to be compatible with ESLint v8's format
@@ -35,10 +35,10 @@ 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
38-
--import-plugin Enable the experimental import plugin and detect ESM problems. It is
39-
recommended to use along side with the `--tsconfig` option.
38+
--import-plugin Enable import plugin and detect ESM problems. It is recommended to use
39+
alongside the `--tsconfig` option.
4040
--react-plugin Enable react plugin, which is turned off by default
41-
--jsdoc-plugin Enable the experimental jsdoc plugin and detect JSDoc problems
41+
--jsdoc-plugin Enable jsdoc plugin and detect JSDoc problems
4242
--jest-plugin Enable the Jest plugin and detect test problems
4343
--vitest-plugin Enable the Vitest plugin and detect test problems
4444
--jsx-a11y-plugin Enable the JSX-a11y plugin and detect accessibility problems

0 commit comments

Comments
 (0)