Move axes to std constants; move helix, revolve, and mirror2d to be declared in KCL (#6105)

Move axes to std constants; move helix, revolve, and mirror2d to be declated in KCL

Signed-off-by: Nick Cameron <nrc@ncameron.org>

rust/kcl-lib/src/docs/gen_std_tests.rs

@@ -24,8 +24,9 @@ use crate::{
 const TYPES_DIR: &str = "../../docs/kcl/types";
 const LANG_TOPICS: [&str; 5] = ["Types", "Modules", "Settings", "Known Issues", "Constants"];
 // These types are declared in std.
-const DECLARED_TYPES: [&str; 11] = [
-    "number", "string", "tag", "bool", "Sketch", "Solid", "Plane", "Helix", "Face", "Point2d", "Point3d",
+const DECLARED_TYPES: [&str; 14] = [
+    "number", "string", "tag", "bool", "Sketch", "Solid", "Plane", "Helix", "Face", "Edge", "Point2d", "Point3d",
+    "Axis2d", "Axis3d",
 ];
 
 fn init_handlebars() -> Result<handlebars::Handlebars<'static>> {

rust/kcl-lib/src/docs/kcl_doc.rs

@@ -508,6 +508,7 @@ pub struct ArgData {
     pub ty: Option<String>,
     /// If the argument is required.
     pub kind: ArgKind,
+    pub override_in_snippet: Option<bool>,
     /// Additional information that could be used instead of the type's description.
     /// This is helpful if the type is really basic, like "number" -- that won't tell the user much about
     /// how this argument is meant to be used.
@@ -528,6 +529,7 @@ impl ArgData {
             name: arg.identifier.name.clone(),
             ty: arg.type_.as_ref().map(|t| t.to_string()),
             docs: None,
+            override_in_snippet: None,
             kind: if arg.labeled {
                 ArgKind::Labelled(arg.optional())
             } else {
@@ -535,26 +537,51 @@ impl ArgData {
             },
         };
 
+        for attr in &arg.identifier.outer_attrs {
+            if let Annotation {
+                name: None,
+                properties: Some(props),
+                ..
+            } = &attr.inner
+            {
+                for p in props {
+                    if p.key.name == "include_in_snippet" {
+                        if let Some(b) = p.value.literal_bool() {
+                            result.override_in_snippet = Some(b);
+                        } else {
+                            panic!(
+                                "Invalid value for `include_in_snippet`, expected bool literal, found {:?}",
+                                p.value
+                            );
+                        }
+                    }
+                }
+            }
+        }
+
         result.with_comments(&arg.identifier.pre_comments);
         result
     }
 
     pub fn get_autocomplete_snippet(&self, index: usize) -> Option<(usize, String)> {
+        match self.override_in_snippet {
+            Some(false) => return None,
+            None if !self.kind.required() => return None,
+            _ => {}
+        }
+
         let label = if self.kind == ArgKind::Special {
             String::new()
         } else {
             format!("{} = ", self.name)
         };
         match self.ty.as_deref() {
-            Some(s) if ["Sketch", "Solid", "Plane | Face", "Sketch | Plane | Face"].contains(&s) => {
-                Some((index, format!("{label}${{{}:{}}}", index, "%")))
-            }
-            Some("number") if self.kind.required() => Some((index, format!(r#"{label}${{{}:3.14}}"#, index))),
-            Some("Point2d") if self.kind.required() => Some((
+            Some(s) if s.starts_with("number") => Some((index, format!(r#"{label}${{{}:3.14}}"#, index))),
+            Some("Point2d") => Some((
                 index + 1,
                 format!(r#"{label}[${{{}:3.14}}, ${{{}:3.14}}]"#, index, index + 1),
             )),
-            Some("Point3d") if self.kind.required() => Some((
+            Some("Point3d") => Some((
                 index + 2,
                 format!(
                     r#"{label}[${{{}:3.14}}, ${{{}:3.14}}, ${{{}:3.14}}]"#,
@@ -563,8 +590,10 @@ impl ArgData {
                     index + 2
                 ),
             )),
-            Some("string") if self.kind.required() => Some((index, format!(r#"{label}${{{}:"string"}}"#, index))),
-            Some("bool") if self.kind.required() => Some((index, format!(r#"{label}${{{}:false}}"#, index))),
+            Some("Axis2d | Edge") | Some("Axis3d | Edge") => Some((index, format!(r#"{label}${{{}:X}}"#, index))),
+
+            Some("string") => Some((index, format!(r#"{label}${{{}:"string"}}"#, index))),
+            Some("bool") => Some((index, format!(r#"{label}${{{}:false}}"#, index))),
             _ => None,
         }
     }

rust/kcl-lib/src/docs/mod.rs

@@ -937,9 +937,12 @@ mod tests {
 
     #[test]
     fn get_autocomplete_snippet_revolve() {
-        let revolve_fn: Box<dyn StdLibFn> = Box::new(crate::std::revolve::Revolve);
-        let snippet = revolve_fn.to_autocomplete_snippet().unwrap();
-        assert_eq!(snippet, r#"revolve(${0:%}, axis = ${1:"X"})${}"#);
+        let data = kcl_doc::walk_prelude();
+        let DocData::Fn(revolve_fn) = data.into_iter().find(|d| d.name() == "revolve").unwrap() else {
+            panic!();
+        };
+        let snippet = revolve_fn.to_autocomplete_snippet();
+        assert_eq!(snippet, r#"revolve(axis = ${0:X})${}"#);
     }
 
     #[test]
@@ -952,7 +955,7 @@ mod tests {
         let snippet = circle_fn.to_autocomplete_snippet();
         assert_eq!(
             snippet,
-            r#"circle(${0:%}, center = [${1:3.14}, ${2:3.14}], radius = ${3:3.14})${}"#
+            r#"circle(center = [${0:3.14}, ${1:3.14}], radius = ${2:3.14})${}"#
         );
     }
 
@@ -1026,11 +1029,14 @@ mod tests {
     #[test]
     #[allow(clippy::literal_string_with_formatting_args)]
     fn get_autocomplete_snippet_helix() {
-        let helix_fn: Box<dyn StdLibFn> = Box::new(crate::std::helix::Helix);
-        let snippet = helix_fn.to_autocomplete_snippet().unwrap();
+        let data = kcl_doc::walk_prelude();
+        let DocData::Fn(helix_fn) = data.into_iter().find(|d| d.name() == "helix").unwrap() else {
+            panic!();
+        };
+        let snippet = helix_fn.to_autocomplete_snippet();
         assert_eq!(
             snippet,
-            r#"helix(revolutions = ${0:3.14}, angleStart = ${1:3.14}, radius = ${2:3.14}, axis = ${3:"X"}, length = ${4:3.14})${}"#
+            r#"helix(revolutions = ${0:3.14}, angleStart = ${1:3.14}, radius = ${2:3.14}, axis = ${3:X}, length = ${4:3.14})${}"#
         );
     }