Skip to content

Commit 5f3b95c

Browse files
committed
Update the documentation for the plugins field.
Previously it had no hover info in VS Code.
1 parent 9bf7cd6 commit 5f3b95c

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

crates/oxc_linter/src/config/oxlintrc.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ use super::{
6363
#[serde(default)]
6464
#[non_exhaustive]
6565
pub struct Oxlintrc {
66+
/// Enabled built-in plugins for Oxlint.
67+
/// You can view the list of available plugins on
68+
/// [the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).
69+
///
70+
/// NOTE: Setting the `plugins` field will overwrite the base set of plugins.
71+
/// The `plugins` array should reflect all of the plugins you want to use.
6672
pub plugins: Option<LintPlugins>,
6773
/// JS plugins.
6874
///

crates/oxc_linter/src/snapshots/schema_json.snap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ expression: json
7171
]
7272
},
7373
"plugins": {
74+
"description": "Enabled built-in plugins for Oxlint.\nYou can view the list of available plugins on\n[the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).\n\nNOTE: Setting the `plugins` field will overwrite the base set of plugins.\nThe `plugins` array should reflect all of the plugins you want to use.",
7475
"default": null,
7576
"anyOf": [
7677
{

npm/oxlint/configuration_schema.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
]
6868
},
6969
"plugins": {
70+
"description": "Enabled built-in plugins for Oxlint.\nYou can view the list of available plugins on\n[the website](https://oxc.rs/docs/guide/usage/linter/plugins.html#supported-plugins).\n\nNOTE: Setting the `plugins` field will overwrite the base set of plugins.\nThe `plugins` array should reflect all of the plugins you want to use.",
7071
"default": null,
7172
"anyOf": [
7273
{

0 commit comments

Comments
 (0)