feat(linter): impl Serialize for OxlintConfig (#5594)

Re-creation of #5331

crates/oxc_linter/src/config/env.rs

@@ -2,7 +2,7 @@ use std::{borrow::Borrow, hash::Hash};
 
 use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 /// Predefine global variables.
 ///
@@ -10,7 +10,7 @@ use serde::Deserialize;
 /// list of
 /// environments](https://eslint.org/docs/v8.x/use/configure/language-options#specifying-environments)
 /// for what environments are available and what each one provides.
-#[derive(Debug, Clone, Deserialize, JsonSchema)]
+#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]
 pub struct OxlintEnv(FxHashMap<String, bool>);
 
 impl OxlintEnv {

crates/oxc_linter/src/config/globals.rs

@@ -2,7 +2,7 @@ use std::{borrow, fmt, hash};
 
 use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
-use serde::{de::Visitor, Deserialize};
+use serde::{de::Visitor, Deserialize, Serialize};
 
 /// Add or remove global variables.
 ///
@@ -29,7 +29,7 @@ use serde::{de::Visitor, Deserialize};
 /// You may also use `"readable"` or `false` to represent `"readonly"`, and
 /// `"writeable"` or `true` to represent `"writable"`.
 // <https://eslint.org/docs/v8.x/use/configure/language-options#using-configuration-files-1>
-#[derive(Debug, Default, Deserialize, JsonSchema)]
+#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
 pub struct OxlintGlobals(FxHashMap<String, GlobalValue>);
 impl OxlintGlobals {
     pub fn is_enabled<Q>(&self, name: &Q) -> bool
@@ -41,7 +41,7 @@ impl OxlintGlobals {
     }
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, JsonSchema)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, JsonSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum GlobalValue {
     Readonly,

crates/oxc_linter/src/config/mod.rs

@@ -8,7 +8,7 @@ use std::path::Path;
 use oxc_diagnostics::OxcDiagnostic;
 use rustc_hash::FxHashSet;
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 pub use self::{
     env::OxlintEnv,
@@ -53,7 +53,7 @@ use crate::{
 ///   }
 ///  }
 /// ```
-#[derive(Debug, Default, Deserialize, JsonSchema)]
+#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
 #[serde(default)]
 pub struct OxlintConfig {
     /// See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).

crates/oxc_linter/src/config/rules.rs

@@ -5,7 +5,8 @@ use rustc_hash::FxHashMap;
 use schemars::{gen::SchemaGenerator, schema::Schema, JsonSchema};
 use serde::{
     de::{self, Deserializer, Visitor},
-    Deserialize,
+    ser::SerializeMap,
+    Deserialize, Serialize,
 };
 
 use crate::{
@@ -58,6 +59,32 @@ impl JsonSchema for OxlintRules {
     }
 }
 
+impl Serialize for OxlintRules {
+    fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        let mut rules = s.serialize_map(Some(self.len()))?;
+
+        for rule in &self.0 {
+            let key = rule.full_name();
+            match rule.config.as_ref() {
+                // e.g. unicorn/some-rule: ["warn", { foo: "bar" }]
+                Some(config) if !config.is_null() => {
+                    let value = (rule.severity.as_str(), config);
+                    rules.serialize_entry(&key, &value)?;
+                }
+                // e.g. unicorn/some-rule: "warn"
+                _ => {
+                    rules.serialize_entry(&key, rule.severity.as_str())?;
+                }
+            }
+        }
+
+        rules.end()
+    }
+}
+
 // Manually implement Deserialize because the type is a bit complex...
 // - Handle single value form and array form
 // - SeverityConf into AllowWarnDeny
@@ -174,6 +201,18 @@ fn failed_to_parse_rule_value(value: &str, err: &str) -> OxcDiagnostic {
     OxcDiagnostic::error(format!("Failed to rule value {value:?} with error {err:?}"))
 }
 
+impl ESLintRule {
+    /// Returns `<plugin_name>/<rule_name>` for non-eslint rules. For eslint rules, returns
+    /// `<rule_name>`. This is effectively the inverse operation for [`parse_rule_key`].
+    fn full_name(&self) -> Cow<'_, str> {
+        if self.plugin_name == "eslint" {
+            Cow::Borrowed(self.rule_name.as_str())
+        } else {
+            Cow::Owned(format!("{}/{}", self.plugin_name, self.rule_name))
+        }
+    }
+}
+
 #[cfg(test)]
 mod test {
     use serde::Deserialize;

crates/oxc_linter/src/config/settings/jsdoc.rs

@@ -2,12 +2,12 @@ use std::borrow::Cow;
 
 use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 use crate::utils::default_true;
 
 // <https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/settings.md>
-#[derive(Debug, Deserialize, JsonSchema)]
+#[derive(Debug, Deserialize, Serialize, JsonSchema)]
 pub struct JSDocPluginSettings {
     /// For all rules but NOT apply to `check-access` and `empty-tags` rule
     #[serde(default, rename = "ignorePrivate")]
@@ -180,7 +180,7 @@ impl JSDocPluginSettings {
     }
 }
 
-#[derive(Clone, Debug, Deserialize, JsonSchema)]
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
 #[serde(untagged)]
 enum TagNamePreference {
     TagNameOnly(String),

crates/oxc_linter/src/config/settings/jsx_a11y.rs

@@ -1,10 +1,10 @@
 use oxc_span::CompactStr;
 use rustc_hash::FxHashMap;
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 // <https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#configurations>
-#[derive(Debug, Deserialize, Default, JsonSchema)]
+#[derive(Debug, Deserialize, Default, Serialize, JsonSchema)]
 pub struct JSXA11yPluginSettings {
     #[serde(rename = "polymorphicPropName")]
     pub polymorphic_prop_name: Option<CompactStr>,

crates/oxc_linter/src/config/settings/mod.rs

@@ -4,7 +4,7 @@ mod next;
 mod react;
 
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 use self::{
     jsdoc::JSDocPluginSettings, jsx_a11y::JSXA11yPluginSettings, next::NextPluginSettings,
@@ -12,7 +12,7 @@ use self::{
 };
 
 /// Shared settings for plugins
-#[derive(Debug, Deserialize, Default, JsonSchema)]
+#[derive(Debug, Deserialize, Serialize, Default, JsonSchema)]
 pub struct OxlintSettings {
     #[serde(default)]
     #[serde(rename = "jsx-a11y")]

crates/oxc_linter/src/config/settings/next.rs

@@ -1,9 +1,9 @@
 use std::borrow::Cow;
 
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize, Serializer};
 
-#[derive(Debug, Deserialize, Default, JsonSchema)]
+#[derive(Debug, Deserialize, Default, Serialize, JsonSchema)]
 pub struct NextPluginSettings {
     #[serde(default)]
     #[serde(rename = "rootDir")]
@@ -27,8 +27,21 @@ enum OneOrMany<T> {
     One(T),
     Many(Vec<T>),
 }
+
 impl<T> Default for OneOrMany<T> {
     fn default() -> Self {
         OneOrMany::Many(Vec::new())
     }
 }
+
+impl<T: Serialize> Serialize for OneOrMany<T> {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        match self {
+            Self::One(val) => val.serialize(serializer),
+            Self::Many(vec) => vec.serialize(serializer),
+        }
+    }
+}

crates/oxc_linter/src/config/settings/react.rs

@@ -2,10 +2,10 @@ use std::borrow::Cow;
 
 use oxc_span::CompactStr;
 use schemars::JsonSchema;
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 // <https://github.com/jsx-eslint/eslint-plugin-react#configuration-legacy-eslintrc->
-#[derive(Debug, Deserialize, Default, JsonSchema)]
+#[derive(Debug, Deserialize, Default, Serialize, JsonSchema)]
 pub struct ReactPluginSettings {
     #[serde(default)]
     #[serde(rename = "formComponents")]
@@ -30,7 +30,7 @@ impl ReactPluginSettings {
 
 // Deserialize helper types
 
-#[derive(Clone, Debug, Deserialize, JsonSchema)]
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
 #[serde(untagged)]
 enum CustomComponent {
     NameOnly(CompactStr),

crates/oxc_linter/src/options/allow_warn_deny.rs

@@ -19,6 +19,14 @@ impl AllowWarnDeny {
     pub fn is_allow(self) -> bool {
         self == Self::Allow
     }
+
+    pub fn as_str(self) -> &'static str {
+        match self {
+            Self::Allow => "allow",
+            Self::Warn => "warn",
+            Self::Deny => "deny",
+        }
+    }
 }
 
 impl TryFrom<&str> for AllowWarnDeny {

crates/oxc_linter/src/snapshots/schema_json.snap

@@ -10,6 +10,9 @@ expression: json
   "properties": {
     "env": {
       "description": "Environments enable and disable collections of global variables.",
+      "default": {
+        "builtin": true
+      },
       "allOf": [
         {
           "$ref": "#/definitions/OxlintEnv"
@@ -18,6 +21,7 @@ expression: json
     },
     "globals": {
       "description": "Enabled or disabled specific global variables.",
+      "default": {},
       "allOf": [
         {
           "$ref": "#/definitions/OxlintGlobals"
@@ -26,6 +30,7 @@ expression: json
     },
     "rules": {
       "description": "See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).",
+      "default": {},
       "allOf": [
         {
           "$ref": "#/definitions/OxlintRules"
@@ -33,8 +38,35 @@ expression: json
       ]
     },
     "settings": {
+      "default": {
+        "jsx-a11y": {
+          "polymorphicPropName": null,
+          "components": {}
+        },
+        "next": {
+          "rootDir": []
+        },
+        "react": {
+          "formComponents": [],
+          "linkComponents": []
+        },
+        "jsdoc": {
+          "ignorePrivate": false,
+          "ignoreInternal": false,
+          "ignoreReplacesDocs": true,
+          "overrideReplacesDocs": true,
+          "augmentsExtendsReplacesDocs": false,
+          "implementsReplacesDocs": false,
+          "exemptDestructuredRootsFromChecks": false,
+          "tagNamePreference": {}
+        }
+      },
+      "allOf": [
+        {
           "$ref": "#/definitions/OxlintSettings"
         }
+      ]
+    }
   },
   "definitions": {
     "AllowWarnDeny": {
@@ -164,6 +196,7 @@ expression: json
           "type": "boolean"
         },
         "tagNamePreference": {
+          "default": {},
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/TagNamePreference"
@@ -193,8 +226,13 @@ expression: json
       "type": "object",
       "properties": {
         "rootDir": {
+          "default": [],
+          "allOf": [
+            {
               "$ref": "#/definitions/OneOrMany_for_String"
             }
+          ]
+        }
       }
     },
     "OneOrMany_for_String": {
@@ -232,29 +270,68 @@ expression: json
       "type": "object",
       "properties": {
         "jsdoc": {
+          "default": {
+            "ignorePrivate": false,
+            "ignoreInternal": false,
+            "ignoreReplacesDocs": true,
+            "overrideReplacesDocs": true,
+            "augmentsExtendsReplacesDocs": false,
+            "implementsReplacesDocs": false,
+            "exemptDestructuredRootsFromChecks": false,
+            "tagNamePreference": {}
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/JSDocPluginSettings"
+            }
+          ]
         },
         "jsx-a11y": {
+          "default": {
+            "polymorphicPropName": null,
+            "components": {}
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/JSXA11yPluginSettings"
+            }
+          ]
         },
         "next": {
+          "default": {
+            "rootDir": []
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/NextPluginSettings"
+            }
+          ]
         },
         "react": {
+          "default": {
+            "formComponents": [],
+            "linkComponents": []
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/ReactPluginSettings"
             }
+          ]
+        }
       }
     },
     "ReactPluginSettings": {
       "type": "object",
       "properties": {
         "formComponents": {
+          "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
           }
         },
         "linkComponents": {
+          "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"

npm/oxlint/configuration_schema.json

@@ -6,6 +6,9 @@
   "properties": {
     "env": {
       "description": "Environments enable and disable collections of global variables.",
+      "default": {
+        "builtin": true
+      },
       "allOf": [
         {
           "$ref": "#/definitions/OxlintEnv"
@@ -14,6 +17,7 @@
     },
     "globals": {
       "description": "Enabled or disabled specific global variables.",
+      "default": {},
       "allOf": [
         {
           "$ref": "#/definitions/OxlintGlobals"
@@ -22,6 +26,7 @@
     },
     "rules": {
       "description": "See [Oxlint Rules](https://oxc.rs/docs/guide/usage/linter/rules.html).",
+      "default": {},
       "allOf": [
         {
           "$ref": "#/definitions/OxlintRules"
@@ -29,8 +34,35 @@
       ]
     },
     "settings": {
+      "default": {
+        "jsx-a11y": {
+          "polymorphicPropName": null,
+          "components": {}
+        },
+        "next": {
+          "rootDir": []
+        },
+        "react": {
+          "formComponents": [],
+          "linkComponents": []
+        },
+        "jsdoc": {
+          "ignorePrivate": false,
+          "ignoreInternal": false,
+          "ignoreReplacesDocs": true,
+          "overrideReplacesDocs": true,
+          "augmentsExtendsReplacesDocs": false,
+          "implementsReplacesDocs": false,
+          "exemptDestructuredRootsFromChecks": false,
+          "tagNamePreference": {}
+        }
+      },
+      "allOf": [
+        {
           "$ref": "#/definitions/OxlintSettings"
         }
+      ]
+    }
   },
   "definitions": {
     "AllowWarnDeny": {
@@ -160,6 +192,7 @@
           "type": "boolean"
         },
         "tagNamePreference": {
+          "default": {},
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/TagNamePreference"
@@ -189,8 +222,13 @@
       "type": "object",
       "properties": {
         "rootDir": {
+          "default": [],
+          "allOf": [
+            {
               "$ref": "#/definitions/OneOrMany_for_String"
             }
+          ]
+        }
       }
     },
     "OneOrMany_for_String": {
@@ -228,29 +266,68 @@
       "type": "object",
       "properties": {
         "jsdoc": {
+          "default": {
+            "ignorePrivate": false,
+            "ignoreInternal": false,
+            "ignoreReplacesDocs": true,
+            "overrideReplacesDocs": true,
+            "augmentsExtendsReplacesDocs": false,
+            "implementsReplacesDocs": false,
+            "exemptDestructuredRootsFromChecks": false,
+            "tagNamePreference": {}
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/JSDocPluginSettings"
+            }
+          ]
         },
         "jsx-a11y": {
+          "default": {
+            "polymorphicPropName": null,
+            "components": {}
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/JSXA11yPluginSettings"
+            }
+          ]
         },
         "next": {
+          "default": {
+            "rootDir": []
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/NextPluginSettings"
+            }
+          ]
         },
         "react": {
+          "default": {
+            "formComponents": [],
+            "linkComponents": []
+          },
+          "allOf": [
+            {
               "$ref": "#/definitions/ReactPluginSettings"
             }
+          ]
+        }
       }
     },
     "ReactPluginSettings": {
       "type": "object",
       "properties": {
         "formComponents": {
+          "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"
           }
         },
         "linkComponents": {
+          "default": [],
           "type": "array",
           "items": {
             "$ref": "#/definitions/CustomComponent"