Skip to content

Commit f339f10

Browse files
committed
docs(linter/plugins): promote JS plugins to alpha status (#20281)
Update "JS plugins are experimental" to "JS plugins are in alpha" in doc comments. This will translate over to website on next release.
1 parent be93374 commit f339f10

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

apps/oxlint/src-js/package/config.generated.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ export interface Oxlintrc {
208208
* Read more about JS plugins in
209209
* [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
210210
*
211-
* Note: JS plugins are experimental and not subject to semver.
211+
* Note: JS plugins are in alpha and not subject to semver.
212212
*
213213
* Examples:
214214
*
@@ -424,7 +424,7 @@ export interface OxlintOverride {
424424
* Read more about JS plugins in
425425
* [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
426426
*
427-
* Note: JS plugins are experimental and not subject to semver.
427+
* Note: JS plugins are in alpha and not subject to semver.
428428
*/
429429
jsPlugins?: null | ExternalPluginEntry[];
430430
/**

crates/oxc_linter/src/config/overrides.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ pub struct OxlintOverride {
101101
/// Read more about JS plugins in
102102
/// [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
103103
///
104-
/// Note: JS plugins are experimental and not subject to semver.
104+
/// Note: JS plugins are in alpha and not subject to semver.
105105
#[serde(rename = "jsPlugins", default, skip_serializing_if = "Option::is_none")]
106106
#[schemars(schema_with = "external_plugins_schema")]
107107
pub external_plugins: Option<FxHashSet<ExternalPluginEntry>>,

crates/oxc_linter/src/config/oxlintrc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ pub struct Oxlintrc {
178178
/// Read more about JS plugins in
179179
/// [the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
180180
///
181-
/// Note: JS plugins are experimental and not subject to semver.
181+
/// Note: JS plugins are in alpha and not subject to semver.
182182
///
183183
/// Examples:
184184
///

npm/oxlint/configuration_schema.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
"markdownDescription": "Globs to ignore during linting. These are resolved from the configuration file path."
5858
},
5959
"jsPlugins": {
60-
"description": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```",
60+
"description": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```",
6161
"anyOf": [
6262
{
6363
"type": "null"
@@ -70,7 +70,7 @@
7070
"uniqueItems": true
7171
}
7272
],
73-
"markdownDescription": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```"
73+
"markdownDescription": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```"
7474
},
7575
"options": {
7676
"description": "Oxlint config options.",
@@ -554,7 +554,7 @@
554554
"markdownDescription": "Enabled or disabled specific global variables."
555555
},
556556
"jsPlugins": {
557-
"description": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.",
557+
"description": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.",
558558
"anyOf": [
559559
{
560560
"type": "null"
@@ -567,7 +567,7 @@
567567
"uniqueItems": true
568568
}
569569
],
570-
"markdownDescription": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver."
570+
"markdownDescription": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver."
571571
},
572572
"plugins": {
573573
"description": "Optionally change what plugins are enabled for this override. When\nomitted, the base config's plugins are used.",

tasks/website_linter/src/snapshots/schema_json.snap

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ expression: json
6161
"markdownDescription": "Globs to ignore during linting. These are resolved from the configuration file path."
6262
},
6363
"jsPlugins": {
64-
"description": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```",
64+
"description": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```",
6565
"anyOf": [
6666
{
6767
"type": "null"
@@ -74,7 +74,7 @@ expression: json
7474
"uniqueItems": true
7575
}
7676
],
77-
"markdownDescription": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```"
77+
"markdownDescription": "JS plugins, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.\n\nExamples:\n\nBasic usage with a local plugin path.\n\n```json\n{\n\"jsPlugins\": [\"./custom-plugin.js\"],\n\"rules\": {\n\"custom/rule-name\": \"warn\"\n}\n}\n```\n\nUsing a built-in Rust plugin alongside a JS plugin with the same name\nby giving the JS plugin an alias.\n\n```json\n{\n\"plugins\": [\"import\"],\n\"jsPlugins\": [\n{ \"name\": \"import-js\", \"specifier\": \"eslint-plugin-import\" }\n],\n\"rules\": {\n\"import/no-cycle\": \"error\",\n\"import-js/no-unresolved\": \"warn\"\n}\n}\n```"
7878
},
7979
"options": {
8080
"description": "Oxlint config options.",
@@ -558,7 +558,7 @@ expression: json
558558
"markdownDescription": "Enabled or disabled specific global variables."
559559
},
560560
"jsPlugins": {
561-
"description": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver.",
561+
"description": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver.",
562562
"anyOf": [
563563
{
564564
"type": "null"
@@ -571,7 +571,7 @@ expression: json
571571
"uniqueItems": true
572572
}
573573
],
574-
"markdownDescription": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are experimental and not subject to semver."
574+
"markdownDescription": "JS plugins for this override, allows usage of ESLint plugins with Oxlint.\n\nRead more about JS plugins in\n[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).\n\nNote: JS plugins are in alpha and not subject to semver."
575575
},
576576
"plugins": {
577577
"description": "Optionally change what plugins are enabled for this override. When\nomitted, the base config's plugins are used.",

tasks/website_linter/src/snapshots/schema_markdown.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ JS plugins, allows usage of ESLint plugins with Oxlint.
250250
Read more about JS plugins in
251251
[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
252252

253-
Note: JS plugins are experimental and not subject to semver.
253+
Note: JS plugins are in alpha and not subject to semver.
254254

255255
Examples:
256256

@@ -438,7 +438,7 @@ JS plugins for this override, allows usage of ESLint plugins with Oxlint.
438438
Read more about JS plugins in
439439
[the docs](https://oxc.rs/docs/guide/usage/linter/js-plugins.html).
440440

441-
Note: JS plugins are experimental and not subject to semver.
441+
Note: JS plugins are in alpha and not subject to semver.
442442

443443

444444
##### overrides[n].jsPlugins[n]

0 commit comments

Comments
 (0)