Add RunContext support for script outputs

CHANGELOG.md

@@ -25,6 +25,7 @@
 * Added rich Source diffs in patch visualizer ([#748])
 * Fix PatchTree performance issues ([#755])
 * Don't override the initial enabled state for source diffing ([#760])
+* A `$scriptType` field has been added to the project.json schema, allowing for scripts to be differentiated as lasses or through RunContext ([#765]).
 
 [#761]: https://github.com/rojo-rbx/rojo/pull/761
 [#745]: https://github.com/rojo-rbx/rojo/pull/745
@@ -50,6 +51,7 @@
 [#748]: https://github.com/rojo-rbx/rojo/pull/748
 [#755]: https://github.com/rojo-rbx/rojo/pull/755
 [#760]: https://github.com/rojo-rbx/rojo/pull/760
+[#765]: https://github.com/rojo-rbx/rojo/pull/765
 
 ## [7.3.0] - April 22, 2023
 * Added `$attributes` to project format. ([#574])

rojo-test/build-test-snapshots/end_to_end__tests__build__script_meta_disabled.snap

@@ -11,6 +11,7 @@ expression: contents
       <Properties>
         <string name="Name">hello</string>
         <bool name="Disabled">true</bool>
+        <token name="RunContext">0</token>
         <string name="Source">-- This script should be marked 'Disabled'</string>
       </Properties>
     </Item>

rojo-test/build-test-snapshots/end_to_end__tests__build__server_in_folder.snap

@@ -10,6 +10,7 @@ expression: contents
     <Item class="Script" referent="1">
       <Properties>
         <string name="Name">serverScript</string>
+        <token name="RunContext">0</token>
         <string name="Source">-- This is a Lua server script</string>
       </Properties>
     </Item>

rojo-test/build-test-snapshots/end_to_end__tests__build__server_init.snap

@@ -6,6 +6,7 @@ expression: contents
   <Item class="Script" referent="0">
     <Properties>
       <string name="Name">server_init</string>
+      <token name="RunContext">0</token>
       <string name="Source">return "From folder/init.server.lua"</string>
     </Properties>
   </Item>

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_all-2.snap

@@ -24,6 +24,8 @@ instances:
     Name: bar
     Parent: id-2
     Properties:
+      RunContext:
+        Enum: 0
       Source:
         String: "-- Hello, from bar!"
   id-4:

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_all.snap

@@ -24,6 +24,8 @@ instances:
     Name: bar
     Parent: id-2
     Properties:
+      RunContext:
+        Enum: 0
       Source:
         String: "-- Hello, from bar!"
   id-4:

src/project.rs

@@ -8,7 +8,7 @@ use std::{
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
-use crate::{glob::Glob, resolution::UnresolvedValue};
+use crate::{glob::Glob, resolution::UnresolvedValue, snapshot_middleware::ScriptContextType};
 
 static PROJECT_FILENAME: &str = "default.project.json";
 
@@ -73,6 +73,12 @@ pub struct Project {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub serve_address: Option<IpAddr>,
 
+    /// The mode to use when mapping scripts into Roblox.
+    /// Can be either `Class` or `RunContext` and determines whether script
+    /// behavior is set using the `RunContext` property or the script's `ClassName`.
+    #[serde(default)]
+    pub script_type: ScriptContextType,
+
     /// A list of globs, relative to the folder the project file is in, that
     /// match files that should be excluded if Rojo encounters them.
     #[serde(default, skip_serializing_if = "Vec::is_empty")]

src/serve_session.rs

@@ -123,7 +123,7 @@ impl ServeSession {
 
         let root_id = tree.get_root_id();
 
-        let instance_context = InstanceContext::default();
+        let instance_context = InstanceContext::from(root_project.script_type);
 
         log::trace!("Generating snapshot of instances from VFS");
         let snapshot = snapshot_from_vfs(&instance_context, &vfs, start_path)?;

src/snapshot/metadata.rs

@@ -6,7 +6,9 @@ use std::{
 
 use serde::{Deserialize, Serialize};
 
-use crate::{glob::Glob, path_serializer, project::ProjectNode};
+use crate::{
+    glob::Glob, path_serializer, project::ProjectNode, snapshot_middleware::ScriptContextType,
+};
 
 /// Rojo-specific metadata that can be associated with an instance or a snapshot
 /// of an instance.
@@ -55,15 +57,6 @@ pub struct InstanceMetadata {
 }
 
 impl InstanceMetadata {
-    pub fn new() -> Self {
-        Self {
-            ignore_unknown_instances: false,
-            instigating_source: None,
-            relevant_paths: Vec::new(),
-            context: InstanceContext::default(),
-        }
-    }
-
     pub fn ignore_unknown_instances(self, ignore_unknown_instances: bool) -> Self {
         Self {
             ignore_unknown_instances,
@@ -93,16 +86,33 @@ impl InstanceMetadata {
     }
 }
 
+impl From<&InstanceContext> for InstanceMetadata {
+    fn from(context: &InstanceContext) -> Self {
+        Self {
+            ignore_unknown_instances: false,
+            instigating_source: None,
+            relevant_paths: Vec::new(),
+            context: context.to_owned(),
+        }
+    }
+}
+
 impl Default for InstanceMetadata {
     fn default() -> Self {
-        Self::new()
+        Self {
+            ignore_unknown_instances: false,
+            instigating_source: None,
+            relevant_paths: Vec::new(),
+            context: InstanceContext::from(ScriptContextType::Class),
+        }
     }
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 pub struct InstanceContext {
     #[serde(skip_serializing_if = "Vec::is_empty")]
     pub path_ignore_rules: Arc<Vec<PathIgnoreRule>>,
+    pub script_type: ScriptContextType,
 }
 
 impl InstanceContext {
@@ -125,10 +135,20 @@ impl InstanceContext {
     }
 }
 
+impl From<ScriptContextType> for InstanceContext {
+    fn from(script_type: ScriptContextType) -> Self {
+        Self {
+            path_ignore_rules: Arc::new(Vec::new()),
+            script_type,
+        }
+    }
+}
+
 impl Default for InstanceContext {
     fn default() -> Self {
-        InstanceContext {
+        Self {
             path_ignore_rules: Arc::new(Vec::new()),
+            script_type: ScriptContextType::Class,
         }
     }
 }

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__add_property.snap

@@ -12,6 +12,7 @@ properties:
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
-  context: {}
+  context:
+    script_type: Class
 children: []
 

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__remove_property_after_patch.snap

@@ -9,5 +9,6 @@ properties: {}
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
-  context: {}
+  context:
+    script_type: Class
 children: []

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__remove_property_initial.snap

@@ -12,6 +12,7 @@ properties:
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
-  context: {}
+  context:
+    script_type: Class
 children: []
 

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__set_name_and_class_name.snap

@@ -9,5 +9,6 @@ properties: {}
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
-  context: {}
+  context:
+    script_type: Class
 children: []

src/snapshot/tests/snapshots/librojo__snapshot__tests__compute__add_child.snap

@@ -10,7 +10,8 @@ added_instances:
       metadata:
         ignore_unknown_instances: false
         relevant_paths: []
-        context: {}
+        context:
+          script_type: Class
       name: New
       class_name: Folder
       properties: {}

src/snapshot_middleware/csv.rs

@@ -37,7 +37,7 @@ pub fn snapshot_csv(
             "Contents".to_owned() => table_contents.into(),
         })
         .metadata(
-            InstanceMetadata::new()
+            InstanceMetadata::default()
                 .instigating_source(path)
                 .relevant_paths(vec![path.to_path_buf(), meta_path.clone()]),
         );

src/snapshot_middleware/dir.rs

@@ -95,7 +95,7 @@ pub fn snapshot_dir_no_meta(
         .class_name("Folder")
         .children(snapshot_children)
         .metadata(
-            InstanceMetadata::new()
+            InstanceMetadata::default()
                 .instigating_source(path)
                 .relevant_paths(relevant_paths)
                 .context(context),

src/snapshot_middleware/json.rs

@@ -35,7 +35,7 @@ pub fn snapshot_json(
         .class_name("ModuleScript")
         .properties(properties)
         .metadata(
-            InstanceMetadata::new()
+            InstanceMetadata::default()
                 .instigating_source(path)
                 .relevant_paths(vec![path.to_path_buf(), meta_path.clone()])
                 .context(context),