Fix docs/json/snippets generation from schemas

Signed-off-by: Nick Cameron <[email protected]>
KittyCAD · Feb 19, 2025 · 9ca6727 · 9ca6727
1 parent 3181bca
commit 9ca6727
Show file tree

Hide file tree

Showing 75 changed files with 43,437 additions and 20,859 deletions.
diff --git a/docs/kcl/std.json b/docs/kcl/std.json
diff --git a/src/components/ModelingSidebar/ModelingPanes/MemoryPane.test.tsx b/src/components/ModelingSidebar/ModelingPanes/MemoryPane.test.tsx
@@ -54,9 +54,27 @@ describe('processMemory', () => {
         },
       ],
       theSketch: [
-        { type: 'ToPoint', to: [-3.35, 0.17], from: [0, 0], tag: null },
-        { type: 'ToPoint', to: [0.98, 5.16], from: [-3.35, 0.17], tag: null },
-        { type: 'ToPoint', to: [2.15, 4.32], from: [0.98, 5.16], tag: null },
+        {
+          type: 'ToPoint',
+          to: [-3.35, 0.17],
+          from: [0, 0],
+          units: { type: 'Mm' },
+          tag: null,
+        },
+        {
+          type: 'ToPoint',
+          to: [0.98, 5.16],
+          from: [-3.35, 0.17],
+          units: { type: 'Mm' },
+          tag: null,
+        },
+        {
+          type: 'ToPoint',
+          to: [2.15, 4.32],
+          from: [0.98, 5.16],
+          units: { type: 'Mm' },
+          tag: null,
+        },
       ],
     })
   })

diff --git a/src/lang/artifact.test.ts b/src/lang/artifact.test.ts
@@ -24,6 +24,7 @@ const mySketch001 = startSketchOn('XY')
         start: {
           to: [0, 0],
           from: [0, 0],
+          units: { type: 'Mm' },
           tag: null,
           __geoMeta: {
             id: expect.any(String),
@@ -35,6 +36,7 @@ const mySketch001 = startSketchOn('XY')
             type: 'ToPoint',
             tag: null,
             to: [-1.59, -1.54],
+            units: { type: 'Mm' },
             from: [0, 0],
             __geoMeta: {
               sourceRange: [expect.any(Number), expect.any(Number), 0],
@@ -45,6 +47,7 @@ const mySketch001 = startSketchOn('XY')
             type: 'ToPoint',
             to: [0.46, -5.82],
             from: [-1.59, -1.54],
+            units: { type: 'Mm' },
             tag: null,
             __geoMeta: {
               sourceRange: [expect.any(Number), expect.any(Number), 0],
@@ -111,6 +114,7 @@ const mySketch001 = startSketchOn('XY')
               type: 'ToPoint',
               from: [0, 0],
               to: [-1.59, -1.54],
+              units: { type: 'Mm' },
               tag: null,
               __geoMeta: {
                 id: expect.any(String),
@@ -121,6 +125,7 @@ const mySketch001 = startSketchOn('XY')
               type: 'ToPoint',
               from: [-1.59, -1.54],
               to: [0.46, -5.82],
+              units: { type: 'Mm' },
               tag: null,
               __geoMeta: {
                 id: expect.any(String),
@@ -229,6 +234,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [0, 0],
                 to: [-2.5, 0],
+                units: { type: 'Mm' },
                 tag: null,
                 __geoMeta: {
                   id: expect.any(String),
@@ -239,6 +245,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [-2.5, 0],
                 to: [0, 10],
+                units: { type: 'Mm' },
                 tag: {
                   end: expect.any(Number),
                   start: expect.any(Number),
@@ -254,6 +261,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [0, 10],
                 to: [2.5, 0],
+                units: { type: 'Mm' },
                 tag: null,
                 __geoMeta: {
                   id: expect.any(String),
@@ -335,6 +343,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [0, 0],
                 to: [-2.5, 0],
+                units: { type: 'Mm' },
                 tag: null,
                 __geoMeta: {
                   id: expect.any(String),
@@ -345,6 +354,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [-2.5, 0],
                 to: [0, 3],
+                units: { type: 'Mm' },
                 tag: {
                   end: expect.any(Number),
                   start: expect.any(Number),
@@ -360,6 +370,7 @@ const sk2 = startSketchOn('XY')
                 type: 'ToPoint',
                 from: [0, 3],
                 to: [2.5, 0],
+                units: { type: 'Mm' },
                 tag: null,
                 __geoMeta: {
                   id: expect.any(String),

diff --git a/src/lang/executor.test.ts b/src/lang/executor.test.ts
@@ -72,6 +72,7 @@ const newVar = myVar + 1`
         type: 'ToPoint',
         to: [0, 2],
         from: [0, 0],
+        units: { type: 'Mm' },
         __geoMeta: {
           sourceRange: [expect.any(Number), expect.any(Number), 0],
           id: expect.any(String),
@@ -87,6 +88,7 @@ const newVar = myVar + 1`
         type: 'ToPoint',
         to: [2, 3],
         from: [0, 2],
+        units: { type: 'Mm' },
         tag: null,
         __geoMeta: {
           sourceRange: [expect.any(Number), expect.any(Number), 0],
@@ -97,6 +99,7 @@ const newVar = myVar + 1`
         type: 'ToPoint',
         to: [5, -1],
         from: [2, 3],
+        units: { type: 'Mm' },
         __geoMeta: {
           sourceRange: [expect.any(Number), expect.any(Number), 0],
           id: expect.any(String),
@@ -165,6 +168,7 @@ const newVar = myVar + 1`
         start: {
           to: [0, 0],
           from: [0, 0],
+          units: { type: 'Mm' },
           tag: null,
           __geoMeta: {
             id: expect.any(String),
@@ -188,6 +192,7 @@ const newVar = myVar + 1`
             type: 'ToPoint',
             to: [1, 1],
             from: [0, 0],
+            units: { type: 'Mm' },
             tag: null,
             __geoMeta: {
               sourceRange: [expect.any(Number), expect.any(Number), 0],
@@ -198,6 +203,7 @@ const newVar = myVar + 1`
             type: 'ToPoint',
             to: [0, 1],
             from: [1, 1],
+            units: { type: 'Mm' },
             __geoMeta: {
               sourceRange: [expect.any(Number), expect.any(Number), 0],
               id: expect.any(String),
@@ -213,6 +219,7 @@ const newVar = myVar + 1`
             type: 'ToPoint',
             to: [1, 1],
             from: [0, 1],
+            units: { type: 'Mm' },
             tag: null,
             __geoMeta: {
               sourceRange: [expect.any(Number), expect.any(Number), 0],

diff --git a/src/lang/std/sketchConstraints.test.ts b/src/lang/std/sketchConstraints.test.ts
@@ -386,6 +386,7 @@ part001 = startSketchOn('XY')
       type: 'ToPoint',
       to: [5.62, 1.79],
       from: [3.48, 0.44],
+      units: { type: 'Mm' },
       tag: null,
     })
   })
@@ -401,6 +402,7 @@ part001 = startSketchOn('XY')
     expect(segment).toEqual({
       to: [0, 0.04],
       from: [0, 0.04],
+      units: { type: 'Mm' },
       tag: null,
       type: 'Base',
     })

diff --git a/src/wasm-lib/derive-docs/src/lib.rs b/src/wasm-lib/derive-docs/src/lib.rs
@@ -328,7 +328,7 @@ fn do_stdlib_inner(
         let label_required = !(i == 0 && metadata.unlabeled_first);
         if ty_string != "ExecState" && ty_string != "Args" {
             let schema = quote! {
-               generator.root_schema_for::<#ty_ident>()
+                #docs_crate::cleanup_number_tuples_root(generator.root_schema_for::<#ty_ident>())
             };
             arg_types.push(quote! {
                 #docs_crate::StdLibFnArg {
@@ -393,7 +393,7 @@ fn do_stdlib_inner(
     let return_type = if !ret_ty_string.is_empty() || ret_ty_string != "()" {
         let ret_ty_string = rust_type_to_openapi_type(&ret_ty_string);
         quote! {
-            let schema = generator.root_schema_for::<#return_type_inner>();
+            let schema = #docs_crate::cleanup_number_tuples_root(generator.root_schema_for::<#return_type_inner>());
             Some(#docs_crate::StdLibFnArg {
                 name: "".to_string(),
                 type_: #ret_ty_string.to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/args_with_lifetime.gen b/src/wasm-lib/derive-docs/tests/args_with_lifetime.gen
@@ -111,7 +111,7 @@ impl crate::docs::StdLibFn for SomeFn {
         vec![crate::docs::StdLibFnArg {
             name: "data".to_string(),
             type_: "Foo".to_string(),
-            schema: generator.root_schema_for::<Foo>(),
+            schema: crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<Foo>()),
             required: true,
             label_required: true,
             description: String::new().to_string(),
@@ -123,7 +123,7 @@ impl crate::docs::StdLibFn for SomeFn {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<i32>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<i32>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "i32".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/args_with_refs.gen b/src/wasm-lib/derive-docs/tests/args_with_refs.gen
@@ -111,7 +111,7 @@ impl crate::docs::StdLibFn for SomeFn {
         vec![crate::docs::StdLibFnArg {
             name: "data".to_string(),
             type_: "string".to_string(),
-            schema: generator.root_schema_for::<str>(),
+            schema: crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<str>()),
             required: true,
             label_required: true,
             description: String::new().to_string(),
@@ -123,7 +123,7 @@ impl crate::docs::StdLibFn for SomeFn {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<i32>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<i32>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "i32".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/array.gen b/src/wasm-lib/derive-docs/tests/array.gen
@@ -172,7 +172,9 @@ impl crate::docs::StdLibFn for Show {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "[number]".to_string(),
-            schema: generator.root_schema_for::<[f64; 2usize]>(),
+            schema: crate::docs::cleanup_number_tuples_root(
+                generator.root_schema_for::<[f64; 2usize]>(),
+            ),
             required: true,
             label_required: true,
             description: String::new().to_string(),
@@ -184,7 +186,7 @@ impl crate::docs::StdLibFn for Show {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<f64>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "number".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/box.gen b/src/wasm-lib/derive-docs/tests/box.gen
@@ -112,7 +112,7 @@ impl crate::docs::StdLibFn for Show {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "number".to_string(),
-            schema: generator.root_schema_for::<f64>(),
+            schema: crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>()),
             required: true,
             label_required: true,
             description: String::new().to_string(),
@@ -124,7 +124,7 @@ impl crate::docs::StdLibFn for Show {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<f64>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "number".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/doc_comment_with_code.gen b/src/wasm-lib/derive-docs/tests/doc_comment_with_code.gen
@@ -173,7 +173,9 @@ impl crate::docs::StdLibFn for MyFunc {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "kittycad::types::InputFormat".to_string(),
-            schema: generator.root_schema_for::<Option<kittycad::types::InputFormat>>(),
+            schema: crate::docs::cleanup_number_tuples_root(
+                generator.root_schema_for::<Option<kittycad::types::InputFormat>>(),
+            ),
             required: false,
             label_required: true,
             description: String::new().to_string(),
@@ -185,7 +187,8 @@ impl crate::docs::StdLibFn for MyFunc {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<Vec<Sketch>>();
+        let schema =
+            crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<Vec<Sketch>>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "[Sketch]".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/lineTo.gen b/src/wasm-lib/derive-docs/tests/lineTo.gen
@@ -174,7 +174,9 @@ impl crate::docs::StdLibFn for LineTo {
             crate::docs::StdLibFnArg {
                 name: "data".to_string(),
                 type_: "LineToData".to_string(),
-                schema: generator.root_schema_for::<LineToData>(),
+                schema: crate::docs::cleanup_number_tuples_root(
+                    generator.root_schema_for::<LineToData>(),
+                ),
                 required: true,
                 label_required: true,
                 description: String::new().to_string(),
@@ -183,7 +185,9 @@ impl crate::docs::StdLibFn for LineTo {
             crate::docs::StdLibFnArg {
                 name: "sketch".to_string(),
                 type_: "Sketch".to_string(),
-                schema: generator.root_schema_for::<Sketch>(),
+                schema: crate::docs::cleanup_number_tuples_root(
+                    generator.root_schema_for::<Sketch>(),
+                ),
                 required: true,
                 label_required: true,
                 description: "the sketch you're adding the line to".to_string(),
@@ -196,7 +200,7 @@ impl crate::docs::StdLibFn for LineTo {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<Sketch>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<Sketch>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "Sketch".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/min.gen b/src/wasm-lib/derive-docs/tests/min.gen
@@ -172,7 +172,9 @@ impl crate::docs::StdLibFn for Min {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "[number]".to_string(),
-            schema: generator.root_schema_for::<Vec<f64>>(),
+            schema: crate::docs::cleanup_number_tuples_root(
+                generator.root_schema_for::<Vec<f64>>(),
+            ),
             required: true,
             label_required: true,
             description: String::new().to_string(),
@@ -184,7 +186,7 @@ impl crate::docs::StdLibFn for Min {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<f64>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "number".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/option.gen b/src/wasm-lib/derive-docs/tests/option.gen
@@ -112,7 +112,9 @@ impl crate::docs::StdLibFn for Show {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "number".to_string(),
-            schema: generator.root_schema_for::<Option<f64>>(),
+            schema: crate::docs::cleanup_number_tuples_root(
+                generator.root_schema_for::<Option<f64>>(),
+            ),
             required: false,
             label_required: true,
             description: String::new().to_string(),
@@ -124,7 +126,7 @@ impl crate::docs::StdLibFn for Show {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<f64>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "number".to_string(),

diff --git a/src/wasm-lib/derive-docs/tests/option_input_format.gen b/src/wasm-lib/derive-docs/tests/option_input_format.gen
@@ -112,7 +112,9 @@ impl crate::docs::StdLibFn for Import {
         vec![crate::docs::StdLibFnArg {
             name: "args".to_string(),
             type_: "kittycad::types::InputFormat".to_string(),
-            schema: generator.root_schema_for::<Option<kittycad::types::InputFormat>>(),
+            schema: crate::docs::cleanup_number_tuples_root(
+                generator.root_schema_for::<Option<kittycad::types::InputFormat>>(),
+            ),
             required: false,
             label_required: true,
             description: String::new().to_string(),
@@ -124,7 +126,7 @@ impl crate::docs::StdLibFn for Import {
         let mut settings = schemars::gen::SchemaSettings::openapi3();
         settings.inline_subschemas = inline_subschemas;
         let mut generator = schemars::gen::SchemaGenerator::new(settings);
-        let schema = generator.root_schema_for::<f64>();
+        let schema = crate::docs::cleanup_number_tuples_root(generator.root_schema_for::<f64>());
         Some(crate::docs::StdLibFnArg {
             name: "".to_string(),
             type_: "number".to_string(),