init.meta.json support

server/src/rbx_snapshot.rs

@@ -39,6 +39,7 @@ use crate::{
 const INIT_MODULE_NAME: &str = "init.lua";
 const INIT_SERVER_NAME: &str = "init.server.lua";
 const INIT_CLIENT_NAME: &str = "init.client.lua";
+const INIT_META_NAME: &str = "init.meta.json";
 
 pub struct SnapshotContext {
     pub plugin_context: Option<SnapshotPluginContext>,
@@ -105,6 +106,12 @@ pub enum SnapshotError {
         path: PathBuf,
     },
 
+    InitMetaError {
+        #[fail(cause)]
+        inner: serde_json::Error,
+        path: PathBuf,
+    },
+
     XmlModelDecodeError {
         #[fail(cause)]
         inner: rbx_xml::DecodeError,
@@ -152,6 +159,9 @@ impl fmt::Display for SnapshotError {
             SnapshotError::JsonModelDecodeError { inner, path } => {
                 write!(output, "Malformed .model.json model: {} in path {}", inner, path.display())
             },
+            SnapshotError::InitMetaError { inner, path } => {
+                write!(output, "Malformed init.meta.json: {} in path {}", inner, path.display())
+            },
             SnapshotError::XmlModelDecodeError { inner, path } => {
                 write!(output, "Malformed rbxmx model: {} in path {}", inner, path.display())
             },
@@ -299,6 +309,17 @@ fn snapshot_imfs_directory<'source>(
     let init_path = directory.path.join(INIT_MODULE_NAME);
     let init_server_path = directory.path.join(INIT_SERVER_NAME);
     let init_client_path = directory.path.join(INIT_CLIENT_NAME);
+    let init_meta_path = directory.path.join(INIT_META_NAME);
+
+    let meta: InitMetaJson = if let Some(ImfsItem::File(file)) = imfs.get(&init_meta_path) {
+        serde_json::from_slice(&file.contents)
+            .map_err(|inner| SnapshotError::InitMetaError {
+                inner,
+                path: file.path.to_path_buf(),
+            })?
+    } else {
+        InitMetaJson::default()
+    };
 
     let snapshot_name = instance_name
         .unwrap_or_else(|| {
@@ -315,13 +336,13 @@ fn snapshot_imfs_directory<'source>(
         snapshot_imfs_path(context, imfs, &init_client_path, Some(snapshot_name))?.unwrap()
     } else {
         RbxSnapshotInstance {
-            class_name: Cow::Borrowed("Folder"),
+            class_name: Cow::Owned(meta.class_name.unwrap_or_else(|| "Folder".to_owned())),
             name: snapshot_name,
-            properties: HashMap::new(),
+            properties: meta.properties,
             children: Vec::new(),
             metadata: MetadataPerInstance {
                 source_path: None,
-                ignore_unknown_instances: false,
+                ignore_unknown_instances: meta.ignore_unknown_children.unwrap_or(false),
                 project_definition: None,
             },
         }
@@ -351,6 +372,20 @@ fn snapshot_imfs_directory<'source>(
     Ok(Some(snapshot))
 }
 
+#[derive(Debug, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct InitMetaJson {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    class_name: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    ignore_unknown_children: Option<bool>,
+    #[serde(
+        default = "HashMap::new",
+        skip_serializing_if = "HashMap::is_empty",
+    )]
+    properties: HashMap<String, RbxValue>,
+}
+
 fn snapshot_imfs_file<'source>(
     context: &SnapshotContext,
     file: &'source ImfsFile,

server/tests/snapshot_snapshots.rs

@@ -35,6 +35,7 @@ generate_snapshot_tests!(
     empty,
     json_model,
     localization,
+    meta_files,
     multi_partition_game,
     nested_partitions,
     single_partition_game,

test-projects/meta_files/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "test-model",
+  "tree": {
+    "$path": "src"
+  }
+}

test-projects/meta_files/expected-snapshot.json

@@ -0,0 +1,37 @@
+{
+  "name": "test-model",
+  "class_name": "Tool",
+  "properties": {
+    "Enabled": {
+      "Type": "Bool",
+      "Value": true
+    }
+  },
+  "children": [
+    {
+      "name": "A",
+      "class_name": "Folder",
+      "properties": {},
+      "children": [],
+      "metadata": {
+        "ignore_unknown_instances": true,
+        "source_path": "src/A",
+        "project_definition": null
+      }
+    }
+  ],
+  "metadata": {
+    "ignore_unknown_instances": false,
+    "source_path": "src",
+    "project_definition": [
+      "test-model",
+      {
+        "class_name": null,
+        "children": {},
+        "properties": {},
+        "ignore_unknown_instances": null,
+        "path": "src"
+      }
+    ]
+  }
+}

test-projects/meta_files/src/A/init.meta.json

@@ -0,0 +1,3 @@
+{
+  "ignoreUnknownChildren": true
+}

test-projects/meta_files/src/init.meta.json

@@ -0,0 +1,9 @@
+{
+  "className": "Tool",
+  "properties": {
+    "Enabled": {
+      "Type": "Bool",
+      "Value": true
+    }
+  }
+}