Store record field documentation in typed AST

Author: GearsDatapacks

compiler-core/generated/schema_capnp.rs

@@ -94,6 +94,7 @@ struct TypeValueConstructor {
 struct TypeValueConstructorParameter {
   type @0 :Type;
   label @1 :Text;
+  documentation @2 :Text;
 }
 
 struct TypeConstructor {
@@ -124,6 +125,7 @@ struct RecordAccessor {
   type @0 :Type;
   index @1 :UInt16;
   label @2 :Text;
+  documentation @3 :Text;
 }
 
 # UInt16 cannot be used as a generic parameter to Option,

compiler-core/schema.capnp

@@ -1099,6 +1099,7 @@ impl<'a, A> ModuleAnalyzer<'a, A> {
                 label,
                 ast,
                 location,
+                doc,
                 ..
             } in constructor.arguments.iter()
             {
@@ -1114,6 +1115,7 @@ impl<'a, A> ModuleAnalyzer<'a, A> {
                 fields.push(TypeValueConstructorField {
                     type_: t.clone(),
                     label: label.as_ref().map(|(_location, label)| label.clone()),
+                    documentation: doc.as_ref().map(|(_, documentation)| documentation.clone()),
                 });
 
                 // Register the type for this parameter
@@ -1933,6 +1935,7 @@ fn custom_type_accessors(constructors: &[TypeValueConstructor]) -> Result<Access
                 index: index as u64,
                 label: label.clone(),
                 type_: type_.clone(),
+                documentation: None,
             },
         );
     }
@@ -1954,6 +1957,7 @@ fn custom_type_accessors(constructors: &[TypeValueConstructor]) -> Result<Access
                     index: index as u64,
                     label: label.clone(),
                     type_: parameter.type_.clone(),
+                    documentation: parameter.documentation.clone(),
                 },
             );
         }

compiler-core/src/analyse.rs

@@ -129,6 +129,7 @@ fn compile_expression(src: &str) -> TypedStatement {
                 index: 0,
                 label: "name".into(),
                 type_: type_::string(),
+                documentation: None,
             },
         ),
         (
@@ -137,6 +138,7 @@ fn compile_expression(src: &str) -> TypedStatement {
                 index: 1,
                 label: "age".into(),
                 type_: type_::int(),
+                documentation: None,
             },
         ),
     ];

compiler-core/src/ast/tests.rs

@@ -102,6 +102,7 @@ pub enum TypedExpr {
         label: EcoString,
         index: u64,
         record: Box<Self>,
+        documentation: Option<EcoString>,
     },
 
     ModuleSelect {

compiler-core/src/ast/typed.rs

@@ -231,8 +231,18 @@ pub trait Visit<'ast> {
         label: &'ast EcoString,
         index: &'ast u64,
         record: &'ast TypedExpr,
+        documentation: &'ast Option<EcoString>,
     ) {
-        visit_typed_expr_record_access(self, location, field_start, type_, label, index, record);
+        visit_typed_expr_record_access(
+            self,
+            location,
+            field_start,
+            type_,
+            label,
+            index,
+            record,
+            documentation,
+        );
     }
 
     #[allow(clippy::too_many_arguments)]
@@ -813,7 +823,16 @@ where
             label,
             index,
             record,
-        } => v.visit_typed_expr_record_access(location, field_start, type_, label, index, record),
+            documentation,
+        } => v.visit_typed_expr_record_access(
+            location,
+            field_start,
+            type_,
+            label,
+            index,
+            record,
+            documentation,
+        ),
         TypedExpr::ModuleSelect {
             location,
             field_start,
@@ -1054,6 +1073,7 @@ pub fn visit_typed_expr_record_access<'a, V>(
     _label: &'a EcoString,
     _index: &'a u64,
     record: &'a TypedExpr,
+    _documentation: &'a Option<EcoString>,
 ) where
     V: Visit<'a> + ?Sized,
 {