chore(linter): Add just task for oxlint config schema generation (#15539)

This was being duplicated in multiple places, so I moved
`generate_json_schema` into Oxlintrc to avoid needing to keep those two
places in sync.

`just linter-schema-json` generates the configuration_schema.json so you
don't have to run the tests to regenerate it, which was a very confusing
behavior to figure out as a contributor.

However, this does mean this is now part of the public interface of the
create, so maybe it shouldn't be like this?

Author: connorshea

crates/oxc_linter/src/config/oxlintrc.rs

@@ -4,7 +4,7 @@ use std::{
 };
 
 use rustc_hash::{FxHashMap, FxHashSet};
-use schemars::JsonSchema;
+use schemars::{JsonSchema, schema_for};
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
 use oxc_diagnostics::OxcDiagnostic;
@@ -198,6 +198,18 @@ impl Oxlintrc {
         })
     }
 
+    /// Generates the JSON schema for Oxlintrc configuration files.
+    ///
+    /// # Panics
+    /// Panics if the schema generation fails.
+    pub fn generate_schema_json() -> String {
+        let mut schema = schema_for!(Oxlintrc);
+        // setting `allowComments` to true to allow comments in JSON schema files
+        // https://github.com/microsoft/vscode-json-languageservice/blob/356d5dd980d49c6ac09ec8446614a6f94016dcea/src/jsonLanguageTypes.ts#L127-L131
+        schema.schema.extensions.insert("allowComments".to_string(), serde_json::Value::Bool(true));
+        serde_json::to_string_pretty(&schema).unwrap()
+    }
+
     /// Merges two [Oxlintrc] files together
     /// [Self] takes priority over `other`
     #[must_use]

crates/oxc_linter/src/lib.rs

@@ -579,16 +579,12 @@ mod test {
 
     use project_root::get_project_root;
 
-    use super::Oxlintrc;
+    use crate::Oxlintrc;
 
     #[test]
     fn test_schema_json() {
         let path = get_project_root().unwrap().join("npm/oxlint/configuration_schema.json");
-        let mut schema = schemars::schema_for!(Oxlintrc);
-        // setting `allowComments` to true to allow comments in JSON schema files
-        // https://github.com/microsoft/vscode-json-languageservice/blob/356d5dd980d49c6ac09ec8446614a6f94016dcea/src/jsonLanguageTypes.ts#L127-L131
-        schema.schema.extensions.insert("allowComments".to_string(), serde_json::Value::Bool(true));
-        let json = serde_json::to_string_pretty(&schema).unwrap();
+        let json = Oxlintrc::generate_schema_json();
         let existing_json = fs::read_to_string(&path).unwrap_or_default();
         if existing_json.trim() != json.trim() {
             std::fs::write(&path, &json).unwrap();

justfile

@@ -248,6 +248,10 @@ website path:
   cargo run -p website -- linter-cli > {{path}}/src/docs/guide/usage/linter/generated-cli.md
   cargo run -p website -- linter-schema-markdown > {{path}}/src/docs/guide/usage/linter/generated-config.md
 
+# Generate linter schema json for `npm/oxlint/configuration_schema.json`
+linter-schema-json:
+  cargo run -p website -- linter-schema-json > npm/oxlint/configuration_schema.json
+
 # Automatically DRY up Cargo.toml manifests in a workspace
 autoinherit:
   cargo binstall cargo-autoinherit

npm/oxlint/configuration_schema.json

@@ -620,4 +620,4 @@
       }
     }
   }
-}
+}

tasks/website/src/linter/json_schema.rs

@@ -8,12 +8,7 @@ use schemars::{
 use serde::Serialize;
 
 pub fn print_schema_json() {
-    println!("{}", generate_schema_json());
-}
-
-fn generate_schema_json() -> String {
-    let schema = schema_for!(Oxlintrc);
-    serde_json::to_string_pretty(&schema).unwrap()
+    println!("{}", Oxlintrc::generate_schema_json());
 }
 
 #[test]