Update memofs to 0.2.0

* Support long file paths on Windows (past 256 limit)

This issue can occur when using symlinks deep in rojo such that very long paths can occur, among other scenarios.

Note while the original fix comes from here:
	https://gal.hagever.com/posts/windows-long-paths-in-rust/

The manifest had to be modified from this source:
	https://stackoverflow.com/questions/59816045/windows-10-1903-longpathaware-not-working

* Move manifests, tidy code a little

Co-authored-by: Lucien Greathouse <me@lpghatguy.com>

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        rust_version: [stable, "1.43.1"]
+        rust_version: [stable, "1.46.0"]
 
     steps:
     - uses: actions/checkout@v1

CHANGELOG.md

@@ -2,6 +2,83 @@
 
 ## Unreleased Changes
 
+## [7.0.0-rc.1][7.0.0-rc.1] (August 23, 2021)
+In Rojo 6 and previous Rojo 7 alphas, an explicit Vector3 property would be written like this:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": {
+            "Type": "Vector3",
+            "Value": [1, 2, 3]
+        }
+    }
+}
+```
+
+For Rojo 7, this will need to be changed to:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": {
+            "Vector3": [1, 2, 3]
+        }
+    }
+}
+```
+
+The shorthand property format that most users use is not impacted. For reference, it looks like this:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": [1, 2, 3]
+    }
+}
+```
+
+* Major breaking change: changed property syntax for project files; shorthand syntax is unchanged.
+* Added the `fmt-project` subcommand for formatting Rojo project files.
+* Improved error output for many subcommands.
+* Updated to stable versions of rbx-dom libraries.
+* Updated async infrastructure, which should fix a handful of bugs. ([#459][#459])
+* Fixed syncing refs in the Roblox Studio plugin ([#462][#462], [#466][#466])
+* Added support for long paths on Windows. ([#464][#464])
+
+[#459]: https://github.com/rojo-rbx/rojo/pull/459
+[#462]: https://github.com/rojo-rbx/rojo/pull/462
+[#464]: https://github.com/rojo-rbx/rojo/pull/464
+[#466]: https://github.com/rojo-rbx/rojo/pull/466
+[7.0.0-rc.1]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-rc.1
+
+## [7.0.0-alpha.4][7.0.0-alpha.4] (May 5, 2021)
+* Added the `gameId` and `placeId` optional properties to project files.
+    * When connecting from the Rojo Roblox Studio plugin, Rojo will set the game and place ID of the current place to these values, if set.
+    * This is equivalent to running `game:SetUniverseId(...)` and `game:SetPlaceId(...)` from the command bar in Studio. 
+* Added "EXPERIMENTAL!" label to two-way sync toggle in Rojo's Roblox Studio plugin.
+* Fixed `Name` and `Parent` properties being allowed in Rojo projects. ([#413][pr-413])
+* Fixed "Open Scripts Externally" feature crashing Studio. ([#369][issue-369])
+* Empty `.model.json` files will no longer cause errors. ([#420][pr-420])
+* When specifying `$path` on a service, Rojo now keeps the correct class name. ([#331][issue-331])
+* Improved error messages for misconfigured projects.
+
+[issue-331]: https://github.com/rojo-rbx/rojo/issues/331
+[issue-369]: https://github.com/rojo-rbx/rojo/issues/369
+[pr-420]: https://github.com/rojo-rbx/rojo/pull/420
+[pr-413]: https://github.com/rojo-rbx/rojo/pull/413
+[7.0.0-alpha.4]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.4
+
+## [7.0.0-alpha.3][7.0.0-alpha.3] (February 19, 2021)
+* Updated dependencies, fixing `OptionalCoordinateFrame`-related issues.
+* Added `--address` flag to `rojo serve` to allow for external connections. ([#403][pr-403])
+
+[pr-403]: https://github.com/rojo-rbx/rojo/pull/403
+[7.0.0-alpha.3]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.3
+
 ## [7.0.0-alpha.2][7.0.0-alpha.2] (February 19, 2021)
 * Fixed incorrect protocol version between the client and server.
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "7.0.0-alpha.2"
+version = "7.0.0-rc.1"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "Enables professional-grade development tools for Roblox developers"
 license = "MPL-2.0"
@@ -9,6 +9,7 @@ documentation = "https://rojo.space/docs"
 repository = "https://github.com/rojo-rbx/rojo"
 readme = "README.md"
 edition = "2018"
+build = "build.rs"
 
 exclude = [
     "/test-projects/**",
@@ -45,7 +46,7 @@ name = "build"
 harness = false
 
 [dependencies]
-memofs = { version = "0.1.2", path = "memofs" }
+memofs = { version = "0.2.0", path = "memofs" }
 
 # These dependencies can be uncommented when working on rbx-dom simultaneously
 # rbx_binary = { path = "../rbx-dom/rbx_binary" }
@@ -54,48 +55,49 @@ memofs = { version = "0.1.2", path = "memofs" }
 # rbx_reflection_database = { path = "../rbx-dom/rbx_reflection_database" }
 # rbx_xml = { path = "../rbx-dom/rbx_xml" }
 
-rbx_binary = "0.6.0-alpha.1"
+rbx_binary = "0.6.1"
-rbx_dom_weak = "2.0.0-alpha.1"
+rbx_dom_weak = "2.1.0"
-rbx_reflection = "4.0.0-alpha.1"
+rbx_reflection = "4.1.0"
-rbx_reflection_database = "0.1.0"
+rbx_reflection_database = "0.2.1"
-rbx_xml = "0.12.0-alpha.1"
+rbx_xml = "0.12.1"
 
 anyhow = "1.0.27"
 backtrace = "0.3"
 bincode = "1.2.1"
-crossbeam-channel = "0.4.0"
+crossbeam-channel = "0.5.1"
 csv = "1.1.1"
-env_logger = "0.7.1"
+env_logger = "0.9.0"
 fs-err = "2.2.0"
-futures = "0.1.29"
+futures = "0.3.16"
 globset = "0.4.4"
-humantime = "1.3.0"
+humantime = "2.1.0"
-hyper = "0.12.35"
+hyper = { version = "0.14.11", features = ["server", "tcp", "http1"] }
 jod-thread = "0.1.0"
 lazy_static = "1.4.0"
 log = "0.4.8"
 maplit = "1.0.1"
 notify = "4.0.14"
-opener = "0.4.1"
+opener = "0.5.0"
 regex = "1.3.1"
 reqwest = "0.9.20"
 ritz = "0.1.0"
 rlua = "0.17.0"
-roblox_install = "0.2.2"
+roblox_install = "1.0.0"
 serde = { version = "1.0", features = ["derive", "rc"] }
 serde_json = "1.0"
 structopt = "0.3.5"
 termcolor = "1.0.5"
 thiserror = "1.0.11"
-tokio = "0.1.22"
+tokio = { version = "1.9.0", features = ["rt", "rt-multi-thread"] }
 uuid = { version = "0.8.1", features = ["v4", "serde"] }
 
 [target.'cfg(windows)'.dependencies]
-winreg = "0.6.2"
+winreg = "0.9.0"
 
 [build-dependencies]
-memofs = { version = "0.1.3", path = "memofs" }
+memofs = { version = "0.2.0", path = "memofs" }
 
+embed-resource = "1.6"
 anyhow = "1.0.27"
 bincode = "1.2.1"
 fs-err = "2.3.0"
@@ -107,8 +109,8 @@ rojo-insta-ext = { path = "rojo-insta-ext" }
 criterion = "0.3"
 insta = { version = "1.3.0", features = ["redactions"] }
 lazy_static = "1.2"
-paste = "0.1"
+paste = "1.0.5"
-pretty_assertions = "0.6.1"
+pretty_assertions = "0.7.2"
 serde_yaml = "0.8.9"
 tempfile = "3.0"
 walkdir = "2.1"

README.md

@@ -1,21 +1,13 @@
 <div align="center">
-    <a href="https://rojo.space">
+    <a href="https://rojo.space"><img src="assets/logo-512.png" alt="Rojo" height="217" /></a>
-        <img src="assets/logo-512.png" alt="Rojo" height="217" />
-    </a>
 </div>
 
 <div>&nbsp;</div>
 
 <div align="center">
-    <a href="https://github.com/rojo-rbx/rojo/actions">
+    <a href="https://github.com/rojo-rbx/rojo/actions"><img src="https://github.com/rojo-rbx/rojo/workflows/CI/badge.svg" alt="Actions status" /></a>
-        <img src="https://github.com/rojo-rbx/rojo/workflows/CI/badge.svg" alt="Actions status" />
+    <a href="https://crates.io/crates/rojo"><img src="https://img.shields.io/crates/v/rojo.svg?label=latest%20release" alt="Latest server version" /></a>
-    </a>
+    <a href="https://rojo.space/docs"><img src="https://img.shields.io/badge/docs-website-brightgreen.svg" alt="Rojo Documentation" /></a>
-    <a href="https://crates.io/crates/rojo">
-        <img src="https://img.shields.io/crates/v/rojo.svg?label=latest%20release" alt="Latest server version" />
-    </a>
-    <a href="https://rojo.space/docs">
-        <img src="https://img.shields.io/badge/docs-website-brightgreen.svg" alt="Rojo Documentation" />
-    </a>
 </div>
 
 <hr />
@@ -48,7 +40,7 @@ Check out our [contribution guide](CONTRIBUTING.md) for detailed instructions fo
 
 Pull requests are welcome!
 
-Rojo supports Rust 1.43.1 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
+Rojo supports Rust 1.46.0 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
 
 ## License
 Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.

build.rs

@@ -73,5 +73,9 @@ fn main() -> Result<(), anyhow::Error> {
 
     bincode::serialize_into(out_file, &snapshot)?;
 
+    println!("cargo:rerun-if-changed=build/windows/rojo-manifest.rc");
+    println!("cargo:rerun-if-changed=build/windows/rojo.manifest");
+    embed_resource::compile("build/windows/rojo-manifest.rc");
+
     Ok(())
 }

build/windows/rojo-manifest.rc

@@ -0,0 +1,2 @@
+#define RT_MANIFEST 24
+1 RT_MANIFEST "rojo.manifest"

build/windows/rojo.manifest

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='utf-8' standalone='yes'?>
+<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
+  <application xmlns="urn:schemas-microsoft-com:asm.v3">
+    <windowsSettings xmlns:ws2="http://schemas.microsoft.com/SMI/2016/WindowsSettings">
+      <ws2:longPathAware>true</ws2:longPathAware>
+    </windowsSettings>
+  </application>
+</assembly>

foreman.toml

@@ -1,3 +1,3 @@
 [tools]
-rojo = { source = "rojo-rbx/rojo", version = "6.0.0-rc.3" }
+rojo = { source = "rojo-rbx/rojo", version = "6.1.0" }
 run-in-roblox = { source = "rojo-rbx/run-in-roblox", version = "0.3.0" }

memofs/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased Changes
 
+## 0.2.0 (2021-08-23)
+* Updated to `crossbeam-channel` 0.5.1.
+
 ## 0.1.3 (2020-11-19)
 * Added `set_watch_enabled` to `Vfs` and `VfsLock` to allow turning off file watching.
 

memofs/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "memofs"
 description = "Virtual filesystem with configurable backends."
-version = "0.1.3"
+version = "0.2.0"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 edition = "2018"
 readme = "README.md"
@@ -11,7 +11,7 @@ homepage = "https://github.com/rojo-rbx/rojo/tree/master/memofs"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-crossbeam-channel = "0.4.0"
+crossbeam-channel = "0.5.1"
 fs-err = "2.3.0"
 notify = "4.0.15"
 serde = { version = "1.0", features = ["derive"] }

plugin/rbx_dom_lua/.luacheckrc

@@ -1,44 +0,0 @@
-stds.roblox = {
-	read_globals = {
-		game = {
-			other_fields = true,
-		},
-
-		-- Roblox globals
-		"script",
-
-		-- Extra functions
-		"tick", "warn",
-		"wait", "typeof",
-
-		-- Types
-		"CFrame",
-		"Color3",
-		"Enum",
-		"Instance",
-		"NumberRange",
-		"Rect",
-		"UDim", "UDim2",
-		"Vector2", "Vector3",
-		"Vector2int16", "Vector3int16",
-	}
-}
-
-stds.testez = {
-	read_globals = {
-		"describe",
-		"it", "itFOCUS", "itSKIP",
-		"FOCUS", "SKIP", "HACK_NO_XPCALL",
-		"expect",
-	}
-}
-
-ignore = {
-	"212", -- unused arguments
-}
-
-std = "lua51+roblox"
-
-files["**/*.spec.lua"] = {
-	std = "+testez",
-}

plugin/rbx_dom_lua/EncodedValue.lua

@@ -71,8 +71,8 @@ types = {
 
 	CFrame = {
 		fromPod = function(pod)
-			local pos = pod.Position
+			local pos = pod.position
-			local orient = pod.Orientation
+			local orient = pod.orientation
 
 			return CFrame.new(
 				pos[1], pos[2], pos[3],
@@ -89,8 +89,8 @@ types = {
 				r20, r21, r22 = roblox:GetComponents()
 
 			return {
-				Position = {x, y, z},
+				position = {x, y, z},
-				Orientation = {
+				orientation = {
 					{r00, r01, r02},
 					{r10, r11, r12},
 					{r20, r21, r22},
@@ -123,10 +123,10 @@ types = {
 		fromPod = function(pod)
 			local keypoints = {}
 
-			for index, keypoint in ipairs(pod.Keypoints) do
+			for index, keypoint in ipairs(pod.keypoints) do
 				keypoints[index] = ColorSequenceKeypoint.new(
-					keypoint.Time,
+					keypoint.time,
-					types.Color3.fromPod(keypoint.Color)
+					types.Color3.fromPod(keypoint.color)
 				)
 			end
 
@@ -138,13 +138,13 @@ types = {
 
 			for index, keypoint in ipairs(roblox.Keypoints) do
 				keypoints[index] = {
-					Time = keypoint.Time,
+					time = keypoint.Time,
-					Color = types.Color3.toPod(keypoint.Value),
+					color = types.Color3.toPod(keypoint.Value),
 				}
 			end
 
 			return {
-				Keypoints = keypoints,
+				keypoints = keypoints,
 			}
 		end,
 	},
@@ -223,11 +223,11 @@ types = {
 		fromPod = function(pod)
 			local keypoints = {}
 
-			for index, keypoint in ipairs(pod.Keypoints) do
+			for index, keypoint in ipairs(pod.keypoints) do
 				keypoints[index] = NumberSequenceKeypoint.new(
-					keypoint.Time,
+					keypoint.time,
-					keypoint.Value,
+					keypoint.value,
-					keypoint.Envelope
+					keypoint.envelope
 				)
 			end
 
@@ -239,14 +239,14 @@ types = {
 
 			for index, keypoint in ipairs(roblox.Keypoints) do
 				keypoints[index] = {
-					Time = keypoint.Time,
+					time = keypoint.Time,
-					Value = keypoint.Value,
+					value = keypoint.Value,
-					Envelope = keypoint.Envelope,
+					envelope = keypoint.Envelope,
 				}
 			end
 
 			return {
-				Keypoints = keypoints,
+				keypoints = keypoints,
 			}
 		end,
 	},
@@ -257,11 +257,11 @@ types = {
 				return nil
 			else
 				return PhysicalProperties.new(
-					pod.Density,
+					pod.density,
-					pod.Friction,
+					pod.friction,
-					pod.Elasticity,
+					pod.elasticity,
-					pod.FrictionWeight,
+					pod.frictionWeight,
-					pod.ElasticityWeight
+					pod.elasticityWeight
 				)
 			end
 		end,
@@ -271,11 +271,11 @@ types = {
 				return "Default"
 			else
 				return {
-					Density = roblox.Density,
+					density = roblox.Density,
-					Friction = roblox.Friction,
+					friction = roblox.Friction,
-					Elasticity = roblox.Elasticity,
+					elasticity = roblox.Elasticity,
-					FrictionWeight = roblox.FrictionWeight,
+					frictionWeight = roblox.FrictionWeight,
-					ElasticityWeight = roblox.ElasticityWeight,
+					elasticityWeight = roblox.ElasticityWeight,
 				}
 			end
 		end,
@@ -284,15 +284,15 @@ types = {
 	Ray = {
 		fromPod = function(pod)
 			return Ray.new(
-				types.Vector3.fromPod(pod.Origin),
+				types.Vector3.fromPod(pod.origin),
-				types.Vector3.fromPod(pod.Direction)
+				types.Vector3.fromPod(pod.direction)
 			)
 		end,
 
 		toPod = function(roblox)
 			return {
-				Origin = types.Vector3.toPod(roblox.Origin),
+				origin = types.Vector3.toPod(roblox.Origin),
-				Direction = types.Vector3.toPod(roblox.Direction),
+				direction = types.Vector3.toPod(roblox.Direction),
 			}
 		end,
 	},
@@ -431,12 +431,14 @@ types = {
 local EncodedValue = {}
 
 function EncodedValue.decode(encodedValue)
-	local typeImpl = types[encodedValue.Type]
+	local ty, value = next(encodedValue)
+
+	local typeImpl = types[ty]
 	if typeImpl == nil then
-		return false, "Couldn't decode value " .. tostring(encodedValue.Type)
+		return false, "Couldn't decode value " .. tostring(ty)
 	end
 
-	return true, typeImpl.fromPod(encodedValue.Value)
+	return true, typeImpl.fromPod(value)
 end
 
 function EncodedValue.encode(rbxValue, propertyType)
@@ -448,8 +450,7 @@ function EncodedValue.encode(rbxValue, propertyType)
 	end
 
 	return true, {
-		Type = propertyType,
+		[propertyType] = typeImpl.toPod(rbxValue),
-		Value = typeImpl.toPod(rbxValue),
 	}
 end
 

plugin/rbx_dom_lua/README.md

@@ -1,2 +0,0 @@
-# rbx_dom_lua
-Roblox Lua implementation of rbx-dom mechanisms, intended to work with rbx_dom_weak and friends.

plugin/rbx_dom_lua/allValues.json

@@ -1,8 +1,7 @@
 {
   "Axes": {
     "value": {
-      "Type": "Axes",
+      "Axes": [
-      "Value": [
         "X",
         "Y",
         "Z"
@@ -12,35 +11,31 @@
   },
   "BinaryString": {
     "value": {
-      "Type": "BinaryString",
+      "BinaryString": "SGVsbG8h"
-      "Value": "SGVsbG8h"
     },
     "ty": "BinaryString"
   },
   "Bool": {
     "value": {
-      "Type": "Bool",
+      "Bool": true
-      "Value": true
     },
     "ty": "Bool"
   },
   "BrickColor": {
     "value": {
-      "Type": "BrickColor",
+      "BrickColor": 1004
-      "Value": 1004
     },
     "ty": "BrickColor"
   },
   "CFrame": {
     "value": {
-      "Type": "CFrame",
+      "CFrame": {
-      "Value": {
+        "position": [
-        "Position": [
           1.0,
           2.0,
           3.0
         ],
-        "Orientation": [
+        "orientation": [
           [
             4.0,
             5.0,
@@ -63,8 +58,7 @@
   },
   "Color3": {
     "value": {
-      "Type": "Color3",
+      "Color3": [
-      "Value": [
         1.0,
         2.0,
         3.0
@@ -74,8 +68,7 @@
   },
   "Color3uint8": {
     "value": {
-      "Type": "Color3uint8",
+      "Color3uint8": [
-      "Value": [
         0,
         128,
         255
@@ -85,20 +78,19 @@
   },
   "ColorSequence": {
     "value": {
-      "Type": "ColorSequence",
+      "ColorSequence": {
-      "Value": {
+        "keypoints": [
-        "Keypoints": [
           {
-            "Time": 0.0,
+            "time": 0.0,
-            "Color": [
+            "color": [
               1.0,
               1.0,
               0.5
             ]
           },
           {
-            "Time": 1.0,
+            "time": 1.0,
-            "Color": [
+            "color": [
               0.0,
               0.0,
               0.0
@@ -111,22 +103,19 @@
   },
   "Content": {
     "value": {
-      "Type": "Content",
+      "Content": "rbxassetid://12345"
-      "Value": "rbxassetid://12345"
     },
     "ty": "Content"
   },
   "Enum": {
     "value": {
-      "Type": "Enum",
+      "Enum": 1234
-      "Value": 1234
     },
     "ty": "Enum"
   },
   "Faces": {
     "value": {
-      "Type": "Faces",
+      "Faces": [
-      "Value": [
         "Right",
         "Top",
         "Back",
@@ -139,36 +128,31 @@
   },
   "Float32": {
     "value": {
-      "Type": "Float32",
+      "Float32": 15.0
-      "Value": 15.0
     },
     "ty": "Float32"
   },
   "Float64": {
     "value": {
-      "Type": "Float64",
+      "Float64": 15123.0
-      "Value": 15123.0
     },
     "ty": "Float64"
   },
   "Int32": {
     "value": {
-      "Type": "Int32",
+      "Int32": 6014
-      "Value": 6014
     },
     "ty": "Int32"
   },
   "Int64": {
     "value": {
-      "Type": "Int64",
+      "Int64": 23491023
-      "Value": 23491023
     },
     "ty": "Int64"
   },
   "NumberRange": {
     "value": {
-      "Type": "NumberRange",
+      "NumberRange": [
-      "Value": [
         -36.0,
         94.0
       ]
@@ -177,18 +161,17 @@
   },
   "NumberSequence": {
     "value": {
-      "Type": "NumberSequence",
+      "NumberSequence": {
-      "Value": {
+        "keypoints": [
-        "Keypoints": [
           {
-            "Time": 0.0,
+            "time": 0.0,
-            "Value": 5.0,
+            "value": 5.0,
-            "Envelope": 2.0
+            "envelope": 2.0
           },
           {
-            "Time": 1.0,
+            "time": 1.0,
-            "Value": 22.0,
+            "value": 22.0,
-            "Envelope": 0.0
+            "envelope": 0.0
           }
         ]
       }
@@ -197,34 +180,31 @@
   },
   "PhysicalProperties-Custom": {
     "value": {
-      "Type": "PhysicalProperties",
+      "PhysicalProperties": {
-      "Value": {
+        "density": 0.5,
-        "Density": 0.5,
+        "friction": 1.0,
-        "Friction": 1.0,
+        "elasticity": 0.0,
-        "Elasticity": 0.0,
+        "frictionWeight": 50.0,
-        "FrictionWeight": 50.0,
+        "elasticityWeight": 25.0
-        "ElasticityWeight": 25.0
       }
     },
     "ty": "PhysicalProperties"
   },
   "PhysicalProperties-Default": {
     "value": {
-      "Type": "PhysicalProperties",
+      "PhysicalProperties": "Default"
-      "Value": "Default"
     },
     "ty": "PhysicalProperties"
   },
   "Ray": {
     "value": {
-      "Type": "Ray",
+      "Ray": {
-      "Value": {
+        "origin": [
-        "Origin": [
           1.0,
           2.0,
           3.0
         ],
-        "Direction": [
+        "direction": [
           4.0,
           5.0,
           6.0
@@ -235,8 +215,7 @@
   },
   "Rect": {
     "value": {
-      "Type": "Rect",
+      "Rect": [
-      "Value": [
         [
           0.0,
           5.0
@@ -251,8 +230,7 @@
   },
   "Region3int16": {
     "value": {
-      "Type": "Region3int16",
+      "Region3int16": [
-      "Value": [
         [
           -10,
           -5,
@@ -269,15 +247,13 @@
   },
   "String": {
     "value": {
-      "Type": "String",
+      "String": "Hello, world!"
-      "Value": "Hello, world!"
     },
     "ty": "String"
   },
   "UDim": {
     "value": {
-      "Type": "UDim",
+      "UDim": [
-      "Value": [
         1.0,
         32
       ]
@@ -286,8 +262,7 @@
   },
   "UDim2": {
     "value": {
-      "Type": "UDim2",
+      "UDim2": [
-      "Value": [
         [
           -1.0,
           100
@@ -302,8 +277,7 @@
   },
   "Vector2": {
     "value": {
-      "Type": "Vector2",
+      "Vector2": [
-      "Value": [
         -50.0,
         50.0
       ]
@@ -312,8 +286,7 @@
   },
   "Vector2int16": {
     "value": {
-      "Type": "Vector2int16",
+      "Vector2int16": [
-      "Value": [
         -300,
         300
       ]
@@ -322,8 +295,7 @@
   },
   "Vector3": {
     "value": {
-      "Type": "Vector3",
+      "Vector3": [
-      "Value": [
         -300.0,
         0.0,
         1500.0
@@ -333,8 +305,7 @@
   },
   "Vector3int16": {
     "value": {
-      "Type": "Vector3int16",
+      "Vector3int16": [
-      "Value": [
         60,
         37,
         -450

plugin/rbx_dom_lua/init.lua

@@ -22,7 +22,7 @@ local function findCanonicalPropertyDescriptor(className, propertyName)
 			local aliasData = propertyData.Kind.Alias
 			if aliasData ~= nil then
 				return PropertyDescriptor.fromRaw(
-					currentClass.properties[aliasData.AliasFor],
+					currentClass.Properties[aliasData.AliasFor],
 					currentClassName,
 					aliasData.AliasFor)
 			end
@@ -66,4 +66,4 @@ return {
 	findCanonicalPropertyDescriptor = findCanonicalPropertyDescriptor,
 	Error = Error,
 	EncodedValue = require(script.EncodedValue),
-}
+}

plugin/rbx_dom_lua/run-tests.lua

@@ -1 +0,0 @@
-require(game.ReplicatedStorage.TestEZ).TestBootstrap:run({game.ReplicatedStorage.RbxDom})

plugin/rbx_dom_lua/test

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-rojo build test-place.project.json -o TestPlace.rbxlx
-run-in-roblox --script run-tests.lua --place TestPlace.rbxlx

plugin/rbx_dom_lua/test-place.project.json

@@ -1,35 +0,0 @@
-{
-  "name": "rbx_dom_lua test place",
-  "tree": {
-    "$className": "DataModel",
-    "ReplicatedStorage": {
-      "$className": "ReplicatedStorage",
-
-      "RbxDom": {
-        "$path": "src"
-      },
-      "TestEZ": {
-        "$path": "modules/testez/lib"
-      }
-    },
-    "ServerScriptService": {
-      "$className": "ServerScriptService",
-
-      "Run Tests": {
-        "$path": "run-tests.lua"
-      }
-    },
-    "Players": {
-      "$className": "Players",
-      "$properties": {
-        "CharacterAutoLoads": false
-      }
-    },
-    "HttpService": {
-      "$className": "HttpService",
-      "$properties": {
-        "HttpEnabled": true
-      }
-    }
-  }
-}

plugin/src/App/StatusPages/Settings.lua

@@ -205,7 +205,7 @@ function SettingsPage:render()
 			TwoWaySync = e(Setting, {
 				id = "twoWaySync",
 				name = "Two-Way Sync",
-				description = "Editing files in Studio will sync them into the filesystem",
+				description = "EXPERIMENTAL! Editing files in Studio will sync them into the filesystem",
 				transparency = self.props.transparency,
 				layoutOrder = 2,
 			}),

plugin/src/Config.lua

@@ -5,7 +5,7 @@ local isDevBuild = script.Parent.Parent:FindFirstChild("ROJO_DEV_BUILD") ~= nil
 return strict("Config", {
 	isDevBuild = isDevBuild,
 	codename = "Epiphany",
-	version = {7, 0, 0, "-alpha.2"},
+	version = {7, 0, 0, "-rc.1"},
 	expectedServerVersionString = "7.0 or newer",
 	protocolVersion = 4,
 	defaultHost = "localhost",

plugin/src/Reconciler/applyPatch.spec.lua

@@ -146,8 +146,7 @@ return function()
 			id = "VALUE",
 			changedProperties = {
 				Value = {
-					Type = "String",
+					String = "WORLD",
-					Value = "WORLD",
 				},
 			},
 		})
@@ -176,8 +175,7 @@ return function()
 			changedClassName = "StringValue",
 			changedProperties = {
 				Value = {
-					Type = "String",
+					String = "I am Root",
-					Value = "I am Root",
 				},
 			},
 		})

plugin/src/Reconciler/decodeValue.lua

@@ -6,29 +6,31 @@
 local RbxDom = require(script.Parent.Parent.Parent.RbxDom)
 local Error = require(script.Parent.Error)
 
-local function decodeValue(virtualValue, instanceMap)
+local function decodeValue(encodedValue, instanceMap)
+	local ty, value = next(encodedValue)
+
 	-- Refs are represented as IDs in the same space that Rojo's protocol uses.
-	if virtualValue.Type == "Ref" then
+	if ty == "Ref" then
-		if virtualValue.Value == nil then
+		if value == "00000000000000000000000000000000" then
 			return true, nil
 		end
 
-		local instance = instanceMap.fromIds[virtualValue.Value]
+		local instance = instanceMap.fromIds[value]
 
 		if instance ~= nil then
 			return true, instance
 		else
 			return false, Error.new(Error.RefDidNotExist, {
-				virtualValue = virtualValue,
+				encodedValue = encodedValue,
 			})
 		end
 	end
 
-	local ok, decodedValue = RbxDom.EncodedValue.decode(virtualValue)
+	local ok, decodedValue = RbxDom.EncodedValue.decode(encodedValue)
 
 	if not ok then
 		return false, Error.new(Error.CannotDecodeValue, {
-			virtualValue = virtualValue,
+			encodedValue = encodedValue,
 			innerError = decodedValue,
 		})
 	end

plugin/src/Reconciler/diff.lua

@@ -75,7 +75,9 @@ local function diff(instanceMap, virtualInstances, rootId)
 						changedProperties[propertyName] = virtualValue
 					end
 				else
-					Log.warn("Failed to decode property of type {}", virtualValue.Type)
+					-- virtualValue can be empty in certain cases, and this may print out nil to the user.
+					local propertyType = next(virtualValue)
+					Log.warn("Failed to decode property of type {}", propertyType)
 				end
 			else
 				local err = existingValueOrErr

plugin/src/Reconciler/diff.spec.lua

@@ -80,8 +80,7 @@ return function()
 				Name = "Value",
 				Properties = {
 					Value = {
-						Type = "String",
+						String = "Hello, world!",
-						Value = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -107,8 +106,9 @@ return function()
 
 		local patchProperty = update.changedProperties["Value"]
 		expect(patchProperty).to.be.a("table")
-		expect(patchProperty.Type).to.equal("String")
+		local ty, value = next(patchProperty)
-		expect(patchProperty.Value).to.equal("Hello, world!")
+		expect(ty).to.equal("String")
+		expect(value).to.equal("Hello, world!")
 	end)
 
 	it("should generate an empty patch if no properties changed", function()
@@ -119,8 +119,7 @@ return function()
 				Name = "Value",
 				Properties = {
 					Value = {
-						Type = "String",
+						String = "Hello, world!",
-						Value = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -145,8 +144,7 @@ return function()
 				Name = "Folder",
 				Properties = {
 					FAKE_PROPERTY = {
-						Type = "String",
+						String = "Hello, world!",
-						Value = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -183,8 +181,7 @@ return function()
 					-- heat_xml is a serialization-only property that is not
 					-- exposed to Lua.
 					heat_xml = {
-						Type = "Float32",
+						Float32 = 5,
-						Value = 5,
 					},
 				},
 				Children = {},

plugin/src/Reconciler/reify.lua

@@ -70,7 +70,7 @@ function reifyInner(instanceMap, virtualInstances, id, parentInstance, unapplied
 	for propertyName, virtualValue in pairs(virtualInstance.Properties) do
 		-- Because refs may refer to instances that we haven't constructed yet,
 		-- we defer applying any ref properties until all instances are created.
-		if virtualValue.Type == "Ref" then
+		if next(virtualValue) == "Ref" then
 			table.insert(deferredRefs, {
 				id = id,
 				instance = instance,
@@ -136,23 +136,23 @@ function applyDeferredRefs(instanceMap, deferredRefs, unappliedPatch)
 	end
 
 	for _, entry in ipairs(deferredRefs) do
-		local virtualValue = entry.virtualValue
+		local _, refId = next(entry.virtualValue)
 
-		if virtualValue.Value == nil then
+		if refId == nil then
 			continue
 		end
 
-		local targetInstance = instanceMap.fromIds[virtualValue.Value]
+		local targetInstance = instanceMap.fromIds[refId]
 		if targetInstance == nil then
-			markFailed(entry.id, entry.propertyName, virtualValue)
+			markFailed(entry.id, entry.propertyName, entry.virtualValue)
 			continue
 		end
 
 		local ok = setProperty(entry.instance, entry.propertyName, targetInstance)
 		if not ok then
-			markFailed(entry.id, entry.propertyName, virtualValue)
+			markFailed(entry.id, entry.propertyName, entry.virtualValue)
 		end
 	end
 end
 
-return reify
+return reify

plugin/src/Reconciler/reify.spec.lua

@@ -54,8 +54,7 @@ return function()
 				Name = "Spaghetti",
 				Properties = {
 					Value = {
-						Type = "String",
+						String = "Hello, world!",
-						Value = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -191,8 +190,7 @@ return function()
 				Name = "Child",
 				Properties = {
 					Value = {
-						Type = "Ref",
+						Ref = "ROOT",
-						Value = "ROOT",
 					},
 				},
 				Children = {},
@@ -219,8 +217,7 @@ return function()
 				Name = "Root",
 				Properties = {
 					Value = {
-						Type = "Ref",
+						Ref = "EXISTING",
-						Value = "EXISTING",
 					},
 				},
 				Children = {},
@@ -258,8 +255,7 @@ return function()
 				Name = "Child A",
 				Properties = {
 					Value = {
-						Type = "Ref",
+						Ref = "Child B",
-						Value = "Child B",
 					},
 				},
 				Children = {},
@@ -298,8 +294,7 @@ return function()
 				Name = "Root",
 				Properties = {
 					Value = {
-						Type = "Ref",
+						Ref = "CHILD",
-						Value = "CHILD",
 					},
 				},
 				Children = {"CHILD"},

plugin/src/ServeSession.lua

@@ -1,4 +1,5 @@
 local StudioService = game:GetService("StudioService")
+local RunService = game:GetService("RunService")
 
 local Log = require(script.Parent.Parent.Log)
 local Fmt = require(script.Parent.Parent.Fmt)
@@ -111,6 +112,7 @@ function ServeSession:start()
 	self.__apiContext:connect()
 		:andThen(function(serverInfo)
 			self:__setStatus(Status.Connected, serverInfo.projectName)
+			self:__applyGameAndPlaceId(serverInfo)
 
 			local rootInstanceId = serverInfo.rootInstanceId
 
@@ -128,6 +130,16 @@ function ServeSession:stop()
 	self:__stopInternal()
 end
 
+function ServeSession:__applyGameAndPlaceId(serverInfo)
+	if serverInfo.gameId ~= nil then
+		game:SetUniverseId(serverInfo.gameId)
+	end
+
+	if serverInfo.placeId ~= nil then
+		game:SetPlaceId(serverInfo.placeId)
+	end
+end
+
 function ServeSession:__onActiveScriptChanged(activeScript)
 	if not self.__openScriptsExternally then
 		Log.trace("Not opening script {} because feature not enabled.", activeScript)
@@ -150,10 +162,18 @@ function ServeSession:__onActiveScriptChanged(activeScript)
 
 	Log.debug("Trying to open script {} externally...", activeScript)
 
-	-- Force-close the script inside Studio
+	-- Force-close the script inside Studio... with a small delay in the middle
-	local existingParent = activeScript.Parent
+	-- to prevent Studio from crashing.
-	activeScript.Parent = nil
+	spawn(function()
-	activeScript.Parent = existingParent
+		local existingParent = activeScript.Parent
+		activeScript.Parent = nil
+
+		for i = 1, 3 do
+			RunService.Heartbeat:Wait()
+		end
+
+		activeScript.Parent = existingParent
+	end)
 
 	-- Notify the Rojo server to open this script
 	self.__apiContext:open(scriptId)

plugin/src/Types.lua

@@ -5,10 +5,7 @@ local strict = require(script.Parent.strict)
 
 local RbxId = t.string
 
-local ApiValue = t.interface({
+local ApiValue = t.keys(t.string)
-	Type = t.string,
-	Value = t.optional(t.any),
-})
 
 local ApiInstanceMetadata = t.interface({
 	ignoreUnknownInstances = t.optional(t.boolean),
@@ -96,4 +93,4 @@ return strict("Types", {
 	VirtualInstance = ApiInstance,
 	VirtualMetadata = ApiInstanceMetadata,
 	VirtualValue = ApiValue,
-})
+})

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/build.rs
 expression: contents
+
 ---
 <roblox version="4">
   <Item class="DataModel" referent="0">
@@ -31,11 +32,7 @@ expression: contents
       <Item class="Part" referent="4">
         <Properties>
           <string name="Name">Color</string>
-          <Color3 name="Color3uint8">
+          <Color3uint8 name="Color3uint8">8404992</Color3uint8>
-            <R>0.5</R>
-            <G>0.25</G>
-            <B>0</B>
-          </Color3>
         </Properties>
       </Item>
       <Item class="NumberValue" referent="5">

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: add_folder
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -13,7 +14,7 @@ instances:
     Parent: "00000000000000000000000000000000"
     Properties:
       Source:
-        Type: String
+        String: "-- Edited contents"
-        Value: "-- Edited contents"
 messageCursor: 1
 sessionId: id-1
+

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -13,7 +14,7 @@ instances:
     Parent: "00000000000000000000000000000000"
     Properties:
       Source:
-        Type: String
+        String: "-- Original contents"
-        Value: "-- Original contents"
 messageCursor: 0
 sessionId: id-1
+

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: edit_init
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -12,7 +13,7 @@ messages:
         changedName: ~
         changedProperties:
           Source:
-            Type: String
+            String: "-- Edited contents"
-            Value: "-- Edited contents"
         id: id-2
 sessionId: id-1
+

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: empty
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -0,0 +1,28 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: empty_folder
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children: []
+    ClassName: Model
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: test
+    Parent: id-2
+    Properties: {}
+messageCursor: 1
+sessionId: id-1
+

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

@@ -0,0 +1,18 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
+---
+instances:
+  id-2:
+    Children: []
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: empty_folder
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+messageCursor: 0
+sessionId: id-1
+

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

@@ -0,0 +1,14 @@
+---
+source: tests/tests/serve.rs
+expression: redactions.redacted_yaml(info)
+
+---
+expectedPlaceIds: ~
+gameId: ~
+placeId: ~
+projectName: empty_folder
+protocolVersion: 4
+rootInstanceId: id-2
+serverVersion: "[server-version]"
+sessionId: id-1
+

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

@@ -0,0 +1,21 @@
+---
+source: tests/tests/serve.rs
+expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
+---
+messageCursor: 1
+messages:
+  - added:
+      id-3:
+        Children: []
+        ClassName: Model
+        Id: id-3
+        Metadata:
+          ignoreUnknownInstances: false
+        Name: test
+        Parent: id-2
+        Properties: {}
+    removed: []
+    updated: []
+sessionId: id-1
+

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-10:
@@ -13,8 +14,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #6"
-        Value: "File #6"
   id-11:
     Children: []
     ClassName: StringValue
@@ -25,8 +25,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #7"
-        Value: "File #7"
   id-12:
     Children: []
     ClassName: StringValue
@@ -37,8 +36,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #8"
-        Value: "File #8"
   id-13:
     Children: []
     ClassName: StringValue
@@ -49,8 +47,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #9"
-        Value: "File #9"
   id-2:
     Children:
       - id-3
@@ -90,8 +87,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #0"
-        Value: "File #0"
   id-5:
     Children: []
     ClassName: StringValue
@@ -102,8 +98,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #1"
-        Value: "File #1"
   id-6:
     Children: []
     ClassName: StringValue
@@ -114,8 +109,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #2"
-        Value: "File #2"
   id-7:
     Children: []
     ClassName: StringValue
@@ -126,8 +120,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #3"
-        Value: "File #3"
   id-8:
     Children: []
     ClassName: StringValue
@@ -138,8 +131,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #4"
-        Value: "File #4"
   id-9:
     Children: []
     ClassName: StringValue
@@ -150,7 +142,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
+        String: "File #5"
-        Value: "File #5"
 messageCursor: 1
 sessionId: id-1
+

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: move_folder_of_stuff
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -15,8 +16,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #6"
-            Value: "File #6"
       id-11:
         Children: []
         ClassName: StringValue
@@ -27,8 +27,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #7"
-            Value: "File #7"
       id-12:
         Children: []
         ClassName: StringValue
@@ -39,8 +38,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #8"
-            Value: "File #8"
       id-13:
         Children: []
         ClassName: StringValue
@@ -51,8 +49,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #9"
-            Value: "File #9"
       id-3:
         Children:
           - id-4
@@ -82,8 +79,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #0"
-            Value: "File #0"
       id-5:
         Children: []
         ClassName: StringValue
@@ -94,8 +90,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #1"
-            Value: "File #1"
       id-6:
         Children: []
         ClassName: StringValue
@@ -106,8 +101,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #2"
-            Value: "File #2"
       id-7:
         Children: []
         ClassName: StringValue
@@ -118,8 +112,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #3"
-            Value: "File #3"
       id-8:
         Children: []
         ClassName: StringValue
@@ -130,8 +123,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #4"
-            Value: "File #4"
       id-9:
         Children: []
         ClassName: StringValue
@@ -142,8 +134,8 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
+            String: "File #5"
-            Value: "File #5"
     removed: []
     updated: []
 sessionId: id-1
+

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -23,7 +24,7 @@ instances:
     Parent: id-2
     Properties:
       Value:
-        Type: String
+        String: This file will be removed!
-        Value: This file will be removed!
 messageCursor: 0
 sessionId: id-1
+

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: remove_file
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -24,8 +25,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
+        String: "-- Hello, from bar!"
-        Value: "-- Hello, from bar!"
   id-4:
     Children: []
     ClassName: ModuleScript
@@ -36,7 +36,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
+        String: Updated foo!
-        Value: Updated foo!
 messageCursor: 1
 sessionId: id-1
+

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -24,8 +25,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
+        String: "-- Hello, from bar!"
-        Value: "-- Hello, from bar!"
   id-4:
     Children: []
     ClassName: ModuleScript
@@ -36,7 +36,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
+        String: "-- Hello, from foo!"
-        Value: "-- Hello, from foo!"
 messageCursor: 0
 sessionId: id-1
+

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

@@ -4,6 +4,8 @@ expression: redactions.redacted_yaml(info)
 
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: scripts
 protocolVersion: 4
 rootInstanceId: id-2

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

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -12,7 +13,7 @@ messages:
         changedName: ~
         changedProperties:
           Source:
-            Type: String
+            String: Updated foo!
-            Value: Updated foo!
         id: id-4
 sessionId: id-1
+

rojo-test/serve-tests/empty_json_model/default.project.json

@@ -1,5 +1,5 @@
 {
-  "name": "rbx_dom_lua",
+  "name": "empty_folder",
   "tree": {
     "$path": "src"
   }

src/bin.rs

@@ -3,20 +3,7 @@ use std::{env, panic, process};
 use backtrace::Backtrace;
 use structopt::StructOpt;
 
-use librojo::cli::{self, GlobalOptions, Options, Subcommand};
+use librojo::cli::Options;
-
-fn run(global: GlobalOptions, subcommand: Subcommand) -> anyhow::Result<()> {
-    match subcommand {
-        Subcommand::Init(init_options) => cli::init(init_options)?,
-        Subcommand::Serve(serve_options) => cli::serve(global, serve_options)?,
-        Subcommand::Build(build_options) => cli::build(build_options)?,
-        Subcommand::Upload(upload_options) => cli::upload(upload_options)?,
-        Subcommand::Doc => cli::doc()?,
-        Subcommand::Plugin(plugin_options) => cli::plugin(plugin_options)?,
-    }
-
-    Ok(())
-}
 
 fn main() {
     panic::set_hook(Box::new(|panic_info| {
@@ -81,7 +68,7 @@ fn main() {
         .write_style(options.global.color.into())
         .init();
 
-    if let Err(err) = run(options.global, options.subcommand) {
+    if let Err(err) = options.run() {
         log::error!("{:?}", err);
         process::exit(1);
     }

src/change_processor.rs

@@ -16,6 +16,9 @@ use crate::{
     snapshot_middleware::{snapshot_from_vfs, snapshot_project_node},
 };
 
+/// Processes file change events, updates the DOM, and sends those updates
+/// through a channel for other stuff to consume.
+///
 /// Owns the connection between Rojo's VFS and its DOM by holding onto another
 /// thread that processes messages.
 ///

src/cli/build.rs

@@ -1,24 +1,88 @@
 use std::{
-    fs::File,
     io::{BufWriter, Write},
+    path::{Path, PathBuf},
 };
 
+use anyhow::Context;
+use fs_err::File;
 use memofs::Vfs;
-use thiserror::Error;
+use structopt::StructOpt;
 use tokio::runtime::Runtime;
 
-use crate::{cli::BuildCommand, serve_session::ServeSession, snapshot::RojoTree};
+use crate::serve_session::ServeSession;
 
+use super::resolve_path;
+
+const UNKNOWN_OUTPUT_KIND_ERR: &str = "Could not detect what kind of file to build. \
+                                       Expected output file to end in .rbxl, .rbxlx, .rbxm, or .rbxmx.";
+
+/// Generates a model or place file from the Rojo project.
+#[derive(Debug, StructOpt)]
+pub struct BuildCommand {
+    /// Path to the project to serve. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+
+    /// Where to output the result.
+    ///
+    /// Should end in .rbxm, .rbxl, .rbxmx, or .rbxlx.
+    #[structopt(long, short)]
+    pub output: PathBuf,
+
+    /// Whether to automatically rebuild when any input files change.
+    #[structopt(long)]
+    pub watch: bool,
+}
+
+impl BuildCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        let project_path = resolve_path(&self.project);
+
+        let output_kind = detect_output_kind(&self.output).context(UNKNOWN_OUTPUT_KIND_ERR)?;
+
+        log::trace!("Constructing in-memory filesystem");
+        let vfs = Vfs::new_default();
+        vfs.set_watch_enabled(self.watch);
+
+        let session = ServeSession::new(vfs, &project_path)?;
+        let mut cursor = session.message_queue().cursor();
+
+        write_model(&session, &self.output, output_kind)?;
+
+        if self.watch {
+            let rt = Runtime::new().unwrap();
+
+            loop {
+                let receiver = session.message_queue().subscribe(cursor);
+                let (new_cursor, _patch_set) = rt.block_on(receiver).unwrap();
+                cursor = new_cursor;
+
+                write_model(&session, &self.output, output_kind)?;
+            }
+        }
+
+        Ok(())
+    }
+}
+
+/// The different kinds of output that Rojo can build to.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 enum OutputKind {
+    /// An XML model file.
     Rbxmx,
+
+    /// An XML place file.
     Rbxlx,
+
+    /// A binary model file.
     Rbxm,
+
+    /// A binary place file.
     Rbxl,
 }
 
-fn detect_output_kind(options: &BuildCommand) -> Option<OutputKind> {
+fn detect_output_kind(output: &Path) -> Option<OutputKind> {
-    let extension = options.output.extension()?.to_str()?;
+    let extension = output.extension()?.to_str()?;
 
     match extension {
         "rbxlx" => Some(OutputKind::Rbxlx),
@@ -29,57 +93,33 @@ fn detect_output_kind(options: &BuildCommand) -> Option<OutputKind> {
     }
 }
 
-#[derive(Debug, Error)]
-enum Error {
-    #[error("Could not detect what kind of file to build. Expected output file to end in .rbxl, .rbxlx, .rbxm, or .rbxmx.")]
-    UnknownOutputKind,
-}
-
 fn xml_encode_config() -> rbx_xml::EncodeOptions {
     rbx_xml::EncodeOptions::new().property_behavior(rbx_xml::EncodePropertyBehavior::WriteUnknown)
 }
 
-pub fn build(options: BuildCommand) -> Result<(), anyhow::Error> {
+fn write_model(
-    log::trace!("Constructing in-memory filesystem");
+    session: &ServeSession,
-
+    output: &Path,
-    let vfs = Vfs::new_default();
+    output_kind: OutputKind,
-    vfs.set_watch_enabled(options.watch);
+) -> anyhow::Result<()> {
-
+    println!("Building project '{}'", session.project_name());
-    let session = ServeSession::new(vfs, &options.absolute_project())?;
-    let mut cursor = session.message_queue().cursor();
-
-    {
-        let tree = session.tree();
-        write_model(&tree, &options)?;
-    }
-
-    if options.watch {
-        let mut rt = Runtime::new().unwrap();
-
-        loop {
-            let receiver = session.message_queue().subscribe(cursor);
-            let (new_cursor, _patch_set) = rt.block_on(receiver).unwrap();
-            cursor = new_cursor;
-
-            let tree = session.tree();
-            write_model(&tree, &options)?;
-        }
-    }
-
-    Ok(())
-}
-
-fn write_model(tree: &RojoTree, options: &BuildCommand) -> Result<(), anyhow::Error> {
-    let output_kind = detect_output_kind(&options).ok_or(Error::UnknownOutputKind)?;
-    log::debug!("Hoping to generate file of type {:?}", output_kind);
 
+    let tree = session.tree();
     let root_id = tree.get_root_id();
 
     log::trace!("Opening output file for write");
-    let file = File::create(&options.output)?;
+    let mut file = BufWriter::new(File::create(output)?);
-    let mut file = BufWriter::new(file);
 
     match output_kind {
+        OutputKind::Rbxm => {
+            rbx_binary::to_writer(&mut file, tree.inner(), &[root_id])?;
+        }
+        OutputKind::Rbxl => {
+            let root_instance = tree.get_instance(root_id).unwrap();
+            let top_level_ids = root_instance.children();
+
+            rbx_binary::to_writer(&mut file, tree.inner(), top_level_ids)?;
+        }
         OutputKind::Rbxmx => {
             // Model files include the root instance of the tree and all its
             // descendants.
@@ -95,25 +135,15 @@ fn write_model(tree: &RojoTree, options: &BuildCommand) -> Result<(), anyhow::Er
 
             rbx_xml::to_writer(&mut file, tree.inner(), top_level_ids, xml_encode_config())?;
         }
-        OutputKind::Rbxm => {
-            rbx_binary::to_writer_default(&mut file, tree.inner(), &[root_id])?;
-        }
-        OutputKind::Rbxl => {
-            let root_instance = tree.get_instance(root_id).unwrap();
-            let top_level_ids = root_instance.children();
-
-            rbx_binary::to_writer_default(&mut file, tree.inner(), top_level_ids)?;
-        }
     }
 
     file.flush()?;
 
-    let filename = options
+    let filename = output
-        .output
         .file_name()
         .and_then(|name| name.to_str())
         .unwrap_or("<invalid utf-8>");
-    log::info!("Built project to {}", filename);
+    println!("Built project to {}", filename);
 
     Ok(())
 }

src/cli/doc.rs

@@ -1,4 +1,12 @@
-pub fn doc() -> Result<(), anyhow::Error> {
+use structopt::StructOpt;
-    opener::open("https://rojo.space/docs")?;
+
-    Ok(())
+/// Open Rojo's documentation in your browser.
+#[derive(Debug, StructOpt)]
+pub struct DocCommand {}
+
+impl DocCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        opener::open("https://rojo.space/docs")?;
+        Ok(())
+    }
 }

src/cli/fmt_project.rs

@@ -0,0 +1,29 @@
+use std::path::PathBuf;
+
+use anyhow::Context;
+use structopt::StructOpt;
+
+use crate::project::Project;
+
+/// Reformat a Rojo project using the standard JSON formatting rules.
+#[derive(Debug, StructOpt)]
+pub struct FmtProjectCommand {
+    /// Path to the project to format. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+}
+
+impl FmtProjectCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        let project = Project::load_fuzzy(&self.project)?
+            .context("A project file is required to run 'rojo fmt-project'")?;
+
+        let serialized = serde_json::to_string_pretty(&project)
+            .context("could not re-encode project file as JSON")?;
+
+        fs_err::write(&project.file_location, &serialized)
+            .context("could not write back to project file")?;
+
+        Ok(())
+    }
+}

src/cli/init.rs

@@ -1,13 +1,14 @@
-use std::{
+use std::io::{self, Write};
-    fs::{self, OpenOptions},
+use std::path::{Path, PathBuf};
-    io::{self, Write},
+use std::process::{Command, Stdio};
-    path::Path,
+use std::str::FromStr;
-    process::{Command, Stdio},
-};
 
-use thiserror::Error;
+use anyhow::{bail, format_err};
+use fs_err as fs;
+use fs_err::OpenOptions;
+use structopt::StructOpt;
 
-use crate::cli::{InitCommand, InitKind};
+use super::resolve_path;
 
 static MODEL_PROJECT: &str =
     include_str!("../../assets/default-model-project/default.project.json");
@@ -20,37 +21,71 @@ static PLACE_PROJECT: &str =
 static PLACE_README: &str = include_str!("../../assets/default-place-project/README.md");
 static PLACE_GIT_IGNORE: &str = include_str!("../../assets/default-place-project/gitignore.txt");
 
-#[derive(Debug, Error)]
+/// Initializes a new Rojo project.
-enum Error {
+#[derive(Debug, StructOpt)]
-    #[error("A project file named default.project.json already exists in this folder")]
+pub struct InitCommand {
-    AlreadyExists,
+    /// Path to the place to create the project. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub path: PathBuf,
 
-    #[error("git init failed")]
+    /// The kind of project to create, 'place' or 'model'. Defaults to place.
-    GitInit,
+    #[structopt(long, default_value = "place")]
+    pub kind: InitKind,
 }
 
-pub fn init(options: InitCommand) -> Result<(), anyhow::Error> {
+impl InitCommand {
-    let base_path = options.absolute_path();
+    pub fn run(self) -> anyhow::Result<()> {
-    fs::create_dir_all(&base_path)?;
+        let base_path = resolve_path(&self.path);
+        fs::create_dir_all(&base_path)?;
 
-    let canonical = fs::canonicalize(&base_path)?;
+        let canonical = fs::canonicalize(&base_path)?;
-    let project_name = canonical
+        let project_name = canonical
-        .file_name()
+            .file_name()
-        .and_then(|name| name.to_str())
+            .and_then(|name| name.to_str())
-        .unwrap_or("new-project");
+            .unwrap_or("new-project");
 
-    let project_params = ProjectParams {
+        let project_params = ProjectParams {
-        name: project_name.to_owned(),
+            name: project_name.to_owned(),
-    };
+        };
 
-    match options.kind {
+        match self.kind {
-        InitKind::Place => init_place(&base_path, project_params),
+            InitKind::Place => init_place(&base_path, project_params)?,
-        InitKind::Model => init_model(&base_path, project_params),
+            InitKind::Model => init_model(&base_path, project_params)?,
+        }
+
+        println!("Created project successfully.");
+
+        Ok(())
     }
 }
 
-fn init_place(base_path: &Path, project_params: ProjectParams) -> Result<(), anyhow::Error> {
+/// The templates we support for initializing a Rojo project.
-    eprintln!("Creating new place project '{}'", project_params.name);
+#[derive(Debug, Clone, Copy)]
+pub enum InitKind {
+    /// A place that contains a baseplate.
+    Place,
+
+    /// An empty model, suitable for a library or plugin.
+    Model,
+}
+
+impl FromStr for InitKind {
+    type Err = anyhow::Error;
+
+    fn from_str(source: &str) -> Result<Self, Self::Err> {
+        match source {
+            "place" => Ok(InitKind::Place),
+            "model" => Ok(InitKind::Model),
+            _ => Err(format_err!(
+                "Invalid init kind '{}'. Valid kinds are: place, model",
+                source
+            )),
+        }
+    }
+}
+
+fn init_place(base_path: &Path, project_params: ProjectParams) -> anyhow::Result<()> {
+    println!("Creating new place project '{}'", project_params.name);
 
     let project_file = project_params.render_template(PLACE_PROJECT);
     try_create_project(base_path, &project_file)?;
@@ -88,13 +123,11 @@ fn init_place(base_path: &Path, project_params: ProjectParams) -> Result<(), any
     let git_ignore = project_params.render_template(PLACE_GIT_IGNORE);
     try_git_init(base_path, &git_ignore)?;
 
-    eprintln!("Created project successfully.");
-
     Ok(())
 }
 
-fn init_model(base_path: &Path, project_params: ProjectParams) -> Result<(), anyhow::Error> {
+fn init_model(base_path: &Path, project_params: ProjectParams) -> anyhow::Result<()> {
-    eprintln!("Creating new model project '{}'", project_params.name);
+    println!("Creating new model project '{}'", project_params.name);
 
     let project_file = project_params.render_template(MODEL_PROJECT);
     try_create_project(base_path, &project_file)?;
@@ -111,8 +144,6 @@ fn init_model(base_path: &Path, project_params: ProjectParams) -> Result<(), any
     let git_ignore = project_params.render_template(MODEL_GIT_IGNORE);
     try_git_init(base_path, &git_ignore)?;
 
-    eprintln!("Created project successfully.");
-
     Ok(())
 }
 
@@ -138,7 +169,7 @@ fn try_git_init(path: &Path, git_ignore: &str) -> Result<(), anyhow::Error> {
         let status = Command::new("git").arg("init").current_dir(path).status()?;
 
         if !status.success() {
-            return Err(Error::GitInit.into());
+            bail!("git init failed: status code {:?}", status.code());
         }
     }
 
@@ -195,13 +226,15 @@ fn try_create_project(base_path: &Path, contents: &str) -> Result<(), anyhow::Er
     let file_res = OpenOptions::new()
         .write(true)
         .create_new(true)
-        .open(project_path);
+        .open(&project_path);
 
     let mut file = match file_res {
         Ok(file) => file,
         Err(err) => {
             return match err.kind() {
-                io::ErrorKind::AlreadyExists => Err(Error::AlreadyExists.into()),
+                io::ErrorKind::AlreadyExists => {
+                    bail!("Project file already exists: {}", project_path.display())
+                }
                 _ => Err(err.into()),
             }
         }

src/cli/mod.rs

@@ -2,29 +2,24 @@
 
 mod build;
 mod doc;
+mod fmt_project;
 mod init;
 mod plugin;
 mod serve;
 mod upload;
 
-use std::{
+use std::{borrow::Cow, env, path::Path, str::FromStr};
-    borrow::Cow,
-    env,
-    error::Error,
-    fmt,
-    path::{Path, PathBuf},
-    str::FromStr,
-};
 
 use structopt::StructOpt;
 use thiserror::Error;
 
-pub use self::build::*;
+pub use self::build::BuildCommand;
-pub use self::doc::*;
+pub use self::doc::DocCommand;
-pub use self::init::*;
+pub use self::fmt_project::FmtProjectCommand;
-pub use self::plugin::*;
+pub use self::init::{InitCommand, InitKind};
-pub use self::serve::*;
+pub use self::plugin::{PluginCommand, PluginSubcommand};
-pub use self::upload::*;
+pub use self::serve::ServeCommand;
+pub use self::upload::UploadCommand;
 
 /// Command line options that Rojo accepts, defined using the structopt crate.
 #[derive(Debug, StructOpt)]
@@ -38,6 +33,20 @@ pub struct Options {
     pub subcommand: Subcommand,
 }
 
+impl Options {
+    pub fn run(self) -> anyhow::Result<()> {
+        match self.subcommand {
+            Subcommand::Init(subcommand) => subcommand.run(),
+            Subcommand::Serve(subcommand) => subcommand.run(self.global),
+            Subcommand::Build(subcommand) => subcommand.run(),
+            Subcommand::Upload(subcommand) => subcommand.run(),
+            Subcommand::FmtProject(subcommand) => subcommand.run(),
+            Subcommand::Doc(subcommand) => subcommand.run(),
+            Subcommand::Plugin(subcommand) => subcommand.run(),
+        }
+    }
+}
+
 #[derive(Debug, StructOpt)]
 pub struct GlobalOptions {
     /// Sets verbosity level. Can be specified multiple times.
@@ -99,214 +108,19 @@ pub struct ColorChoiceParseError {
 
 #[derive(Debug, StructOpt)]
 pub enum Subcommand {
-    /// Creates a new Rojo project.
     Init(InitCommand),
-
-    /// Serves the project's files for use with the Rojo Studio plugin.
     Serve(ServeCommand),
-
-    /// Generates a model or place file from the project.
     Build(BuildCommand),
-
-    /// Generates a place or model file out of the project and uploads it to Roblox.
     Upload(UploadCommand),
-
+    FmtProject(FmtProjectCommand),
-    /// Open Rojo's documentation in your browser.
+    Doc(DocCommand),
-    Doc,
-
-    /// Manages Rojo's Roblox Studio plugin.
     Plugin(PluginCommand),
 }
 
-/// Initializes a new Rojo project.
+pub(super) fn resolve_path(path: &Path) -> Cow<'_, Path> {
-#[derive(Debug, StructOpt)]
-pub struct InitCommand {
-    /// Path to the place to create the project. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub path: PathBuf,
-
-    /// The kind of project to create, 'place' or 'model'. Defaults to place.
-    #[structopt(long, default_value = "place")]
-    pub kind: InitKind,
-}
-
-impl InitCommand {
-    pub fn absolute_path(&self) -> Cow<'_, Path> {
-        resolve_path(&self.path)
-    }
-}
-
-/// The templates we support for initializing a Rojo project.
-#[derive(Debug, Clone, Copy)]
-pub enum InitKind {
-    /// A place that matches what File -> New does in Roblox Studio.
-    Place,
-
-    /// An empty model, suitable for a library or plugin.
-    Model,
-}
-
-impl FromStr for InitKind {
-    type Err = InitKindParseError;
-
-    fn from_str(source: &str) -> Result<Self, Self::Err> {
-        match source {
-            "place" => Ok(InitKind::Place),
-            "model" => Ok(InitKind::Model),
-            _ => Err(InitKindParseError {
-                attempted: source.to_owned(),
-            }),
-        }
-    }
-}
-
-/// Error type for failing to parse an `InitKind`.
-#[derive(Debug)]
-pub struct InitKindParseError {
-    attempted: String,
-}
-
-impl Error for InitKindParseError {}
-
-impl fmt::Display for InitKindParseError {
-    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            formatter,
-            "Invalid init kind '{}'. Valid kinds are: place, model",
-            self.attempted
-        )
-    }
-}
-
-/// Expose a Rojo project through a web server that can communicate with the
-/// Rojo Roblox Studio plugin, or be visited by the user in the browser.
-#[derive(Debug, StructOpt)]
-pub struct ServeCommand {
-    /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// The port to listen on. Defaults to the project's preference, or 34872 if
-    /// it has none.
-    #[structopt(long)]
-    pub port: Option<u16>,
-}
-
-impl ServeCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// Build a Rojo project into a file.
-#[derive(Debug, StructOpt)]
-pub struct BuildCommand {
-    /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// Where to output the result.
-    #[structopt(long, short)]
-    pub output: PathBuf,
-
-    /// Whether to automatically rebuild when any input files change.
-    #[structopt(long)]
-    pub watch: bool,
-}
-
-impl BuildCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// Build and upload a Rojo project to Roblox.com.
-#[derive(Debug, StructOpt)]
-pub struct UploadCommand {
-    /// Path to the project to upload. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// Authenication cookie to use. If not specified, Rojo will attempt to find one from the system automatically.
-    #[structopt(long)]
-    pub cookie: Option<String>,
-
-    /// Asset ID to upload to.
-    #[structopt(long = "asset_id")]
-    pub asset_id: u64,
-}
-
-impl UploadCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// The kind of asset to upload to the website. Affects what endpoints Rojo uses
-/// and changes how the asset is built.
-#[derive(Debug, Clone, Copy)]
-pub enum UploadKind {
-    /// Upload to a place.
-    Place,
-
-    /// Upload to a model-like asset, like a Model, Plugin, or Package.
-    Model,
-}
-
-impl FromStr for UploadKind {
-    type Err = UploadKindParseError;
-
-    fn from_str(source: &str) -> Result<Self, Self::Err> {
-        match source {
-            "place" => Ok(UploadKind::Place),
-            "model" => Ok(UploadKind::Model),
-            _ => Err(UploadKindParseError {
-                attempted: source.to_owned(),
-            }),
-        }
-    }
-}
-
-/// Error type for failing to parse an `UploadKind`.
-#[derive(Debug)]
-pub struct UploadKindParseError {
-    attempted: String,
-}
-
-impl Error for UploadKindParseError {}
-
-impl fmt::Display for UploadKindParseError {
-    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            formatter,
-            "Invalid upload kind '{}'. Valid kinds are: place, model",
-            self.attempted
-        )
-    }
-}
-
-fn resolve_path(path: &Path) -> Cow<'_, Path> {
     if path.is_absolute() {
         Cow::Borrowed(path)
     } else {
         Cow::Owned(env::current_dir().unwrap().join(path))
     }
 }
-
-#[derive(Debug, StructOpt)]
-pub enum PluginSubcommand {
-    /// Install the plugin in Roblox Studio's plugins folder. If the plugin is
-    /// already installed, installing it again will overwrite the current plugin
-    /// file.
-    Install,
-
-    /// Removes the plugin if it is installed.
-    Uninstall,
-}
-
-/// Install Rojo's plugin.
-#[derive(Debug, StructOpt)]
-pub struct PluginCommand {
-    #[structopt(subcommand)]
-    subcommand: PluginSubcommand,
-}

src/cli/plugin.rs

@@ -3,26 +3,50 @@ use std::{
     io::BufWriter,
 };
 
-use anyhow::Result;
 use memofs::{InMemoryFs, Vfs, VfsSnapshot};
 use roblox_install::RobloxStudio;
+use structopt::StructOpt;
 
-use crate::{
+use crate::serve_session::ServeSession;
-    cli::{PluginCommand, PluginSubcommand},
-    serve_session::ServeSession,
-};
 
 static PLUGIN_BINCODE: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/plugin.bincode"));
 static PLUGIN_FILE_NAME: &str = "RojoManagedPlugin.rbxm";
 
-pub fn plugin(options: PluginCommand) -> Result<()> {
+/// Install Rojo's plugin.
-    match options.subcommand {
+#[derive(Debug, StructOpt)]
-        PluginSubcommand::Install => install_plugin(),
+pub struct PluginCommand {
-        PluginSubcommand::Uninstall => uninstall_plugin(),
+    #[structopt(subcommand)]
+    subcommand: PluginSubcommand,
+}
+
+/// Manages Rojo's Roblox Studio plugin.
+#[derive(Debug, StructOpt)]
+pub enum PluginSubcommand {
+    /// Install the plugin in Roblox Studio's plugins folder. If the plugin is
+    /// already installed, installing it again will overwrite the current plugin
+    /// file.
+    Install,
+
+    /// Removes the plugin if it is installed.
+    Uninstall,
+}
+
+impl PluginCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        self.subcommand.run()
     }
 }
 
-pub fn install_plugin() -> Result<()> {
+impl PluginSubcommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        match self {
+            PluginSubcommand::Install => install_plugin(),
+            PluginSubcommand::Uninstall => uninstall_plugin(),
+        }
+    }
+}
+
+fn install_plugin() -> anyhow::Result<()> {
     let plugin_snapshot: VfsSnapshot = bincode::deserialize(PLUGIN_BINCODE)
         .expect("Rojo's plugin was not properly packed into Rojo's binary");
 
@@ -49,12 +73,12 @@ pub fn install_plugin() -> Result<()> {
     let tree = session.tree();
     let root_id = tree.get_root_id();
 
-    rbx_binary::to_writer_default(&mut file, tree.inner(), &[root_id])?;
+    rbx_binary::to_writer(&mut file, tree.inner(), &[root_id])?;
 
     Ok(())
 }
 
-fn uninstall_plugin() -> Result<()> {
+fn uninstall_plugin() -> anyhow::Result<()> {
     let studio = RobloxStudio::locate()?;
 
     let plugin_path = studio.plugins_path().join(PLUGIN_FILE_NAME);

src/cli/serve.rs

@@ -1,51 +1,82 @@
 use std::{
     io::{self, Write},
+    net::{IpAddr, Ipv4Addr},
+    path::PathBuf,
     sync::Arc,
 };
 
-use anyhow::Result;
 use memofs::Vfs;
+use structopt::StructOpt;
 use termcolor::{BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
 
-use crate::{
+use crate::{serve_session::ServeSession, web::LiveServer};
-    cli::{GlobalOptions, ServeCommand},
-    serve_session::ServeSession,
-    web::LiveServer,
-};
 
+use super::{resolve_path, GlobalOptions};
+
+const DEFAULT_BIND_ADDRESS: Ipv4Addr = Ipv4Addr::new(127, 0, 0, 1);
 const DEFAULT_PORT: u16 = 34872;
 
-pub fn serve(global: GlobalOptions, options: ServeCommand) -> Result<()> {
+/// Expose a Rojo project to the Rojo Studio plugin.
-    let vfs = Vfs::new_default();
+#[derive(Debug, StructOpt)]
+pub struct ServeCommand {
+    /// Path to the project to serve. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
 
-    let session = Arc::new(ServeSession::new(vfs, &options.absolute_project())?);
+    /// The IP address to listen on. Defaults to `127.0.0.1`.
+    #[structopt(long)]
+    pub address: Option<IpAddr>,
 
-    let port = options
+    /// The port to listen on. Defaults to the project's preference, or `34872` if
-        .port
+    /// it has none.
-        .or_else(|| session.project_port())
+    #[structopt(long)]
-        .unwrap_or(DEFAULT_PORT);
+    pub port: Option<u16>,
-
-    let server = LiveServer::new(session);
-
-    let _ = show_start_message(port, global.color.into());
-    server.start(port);
-
-    Ok(())
 }
 
-fn show_start_message(port: u16, color: ColorChoice) -> io::Result<()> {
+impl ServeCommand {
+    pub fn run(self, global: GlobalOptions) -> anyhow::Result<()> {
+        let project_path = resolve_path(&self.project);
+
+        let vfs = Vfs::new_default();
+
+        let session = Arc::new(ServeSession::new(vfs, &project_path)?);
+
+        let ip = self.address.unwrap_or(DEFAULT_BIND_ADDRESS.into());
+
+        let port = self
+            .port
+            .or_else(|| session.project_port())
+            .unwrap_or(DEFAULT_PORT);
+
+        let server = LiveServer::new(session);
+
+        let _ = show_start_message(ip, port, global.color.into());
+        server.start((ip, port).into());
+
+        Ok(())
+    }
+}
+
+fn show_start_message(bind_address: IpAddr, port: u16, color: ColorChoice) -> io::Result<()> {
+    let mut green = ColorSpec::new();
+    green.set_fg(Some(Color::Green)).set_bold(true);
+
     let writer = BufferWriter::stdout(color);
     let mut buffer = writer.buffer();
 
     writeln!(&mut buffer, "Rojo server listening:")?;
 
     write!(&mut buffer, "  Address: ")?;
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
+    buffer.set_color(&green)?;
-    writeln!(&mut buffer, "localhost")?;
+    if bind_address.is_loopback() {
+        writeln!(&mut buffer, "localhost")?;
+    } else {
+        writeln!(&mut buffer, "{}", bind_address)?;
+    }
 
     buffer.set_color(&ColorSpec::new())?;
     write!(&mut buffer, "  Port:    ")?;
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
+    buffer.set_color(&green)?;
     writeln!(&mut buffer, "{}", port)?;
 
     writeln!(&mut buffer)?;
@@ -53,7 +84,7 @@ fn show_start_message(port: u16, color: ColorChoice) -> io::Result<()> {
     buffer.set_color(&ColorSpec::new())?;
     write!(&mut buffer, "Visit ")?;
 
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
+    buffer.set_color(&green)?;
     write!(&mut buffer, "http://localhost:{}/", port)?;
 
     buffer.set_color(&ColorSpec::new())?;

src/cli/upload.rs

@@ -1,46 +1,87 @@
+use std::path::PathBuf;
+use std::str::FromStr;
+
+use anyhow::{bail, format_err, Context};
 use memofs::Vfs;
 use reqwest::{
     header::{ACCEPT, CONTENT_TYPE, COOKIE, USER_AGENT},
     StatusCode,
 };
-use thiserror::Error;
+use structopt::StructOpt;
 
-use crate::{auth_cookie::get_auth_cookie, cli::UploadCommand, serve_session::ServeSession};
+use crate::{auth_cookie::get_auth_cookie, serve_session::ServeSession};
 
-#[derive(Debug, Error)]
+use super::resolve_path;
-enum Error {
-    #[error("Rojo could not find your Roblox auth cookie. Please pass one via --cookie.")]
-    NeedAuthCookie,
 
-    #[error("The Roblox API returned an unexpected error: {body}")]
+/// Builds the project and uploads it to Roblox.
-    RobloxApi { body: String },
+#[derive(Debug, StructOpt)]
+pub struct UploadCommand {
+    /// Path to the project to upload. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+
+    /// Authenication cookie to use. If not specified, Rojo will attempt to find one from the system automatically.
+    #[structopt(long)]
+    pub cookie: Option<String>,
+
+    /// Asset ID to upload to.
+    #[structopt(long = "asset_id")]
+    pub asset_id: u64,
 }
 
-pub fn upload(options: UploadCommand) -> Result<(), anyhow::Error> {
+impl UploadCommand {
-    let cookie = options
+    pub fn run(self) -> Result<(), anyhow::Error> {
-        .cookie
+        let project_path = resolve_path(&self.project);
-        .clone()
-        .or_else(get_auth_cookie)
-        .ok_or(Error::NeedAuthCookie)?;
 
-    let vfs = Vfs::new_default();
+        let cookie = self.cookie.or_else(get_auth_cookie).context(
+            "Rojo could not find your Roblox auth cookie. Please pass one via --cookie.",
+        )?;
 
-    let session = ServeSession::new(vfs, &options.absolute_project())?;
+        let vfs = Vfs::new_default();
 
-    let tree = session.tree();
+        let session = ServeSession::new(vfs, project_path)?;
-    let inner_tree = tree.inner();
-    let root = inner_tree.root();
 
-    let encode_ids = match root.class.as_str() {
+        let tree = session.tree();
-        "DataModel" => root.children().to_vec(),
+        let inner_tree = tree.inner();
-        _ => vec![root.referent()],
+        let root = inner_tree.root();
-    };
 
-    let mut buffer = Vec::new();
+        let encode_ids = match root.class.as_str() {
+            "DataModel" => root.children().to_vec(),
+            _ => vec![root.referent()],
+        };
 
-    log::trace!("Encoding binary model");
+        let mut buffer = Vec::new();
-    rbx_binary::to_writer_default(&mut buffer, tree.inner(), &encode_ids)?;
+
-    do_upload(buffer, options.asset_id, &cookie)
+        log::trace!("Encoding binary model");
+        rbx_binary::to_writer(&mut buffer, tree.inner(), &encode_ids)?;
+        do_upload(buffer, self.asset_id, &cookie)
+    }
+}
+
+/// The kind of asset to upload to the website. Affects what endpoints Rojo uses
+/// and changes how the asset is built.
+#[derive(Debug, Clone, Copy)]
+enum UploadKind {
+    /// Upload to a place.
+    Place,
+
+    /// Upload to a model-like asset, like a Model, Plugin, or Package.
+    Model,
+}
+
+impl FromStr for UploadKind {
+    type Err = anyhow::Error;
+
+    fn from_str(source: &str) -> Result<Self, Self::Err> {
+        match source {
+            "place" => Ok(UploadKind::Place),
+            "model" => Ok(UploadKind::Model),
+            attempted => Err(format_err!(
+                "Invalid upload kind '{}'. Valid kinds are: place, model",
+                attempted
+            )),
+        }
+    }
 }
 
 fn do_upload(buffer: Vec<u8>, asset_id: u64, cookie: &str) -> anyhow::Result<()> {
@@ -76,10 +117,10 @@ fn do_upload(buffer: Vec<u8>, asset_id: u64, cookie: &str) -> anyhow::Result<()>
 
     let status = response.status();
     if !status.is_success() {
-        return Err(Error::RobloxApi {
+        bail!(
-            body: response.text()?,
+            "The Roblox API returned an unexpected error: {}",
-        }
+            response.text()?
-        .into());
+        );
     }
 
     Ok(())

src/lua_ast.rs

@@ -1,4 +1,5 @@
-//! Defines module for defining a small Lua AST for simple codegen.
+//! Defines module for defining a small Lua AST for simple codegen. Rojo uses
+//! this module to convert JSON into generated Lua code.
 
 use std::{
     fmt::{self, Write},

src/message_queue.rs

@@ -1,26 +1,6 @@
 use std::sync::{Mutex, RwLock};
 
-use futures::sync::oneshot;
+use futures::channel::oneshot;
-
-struct Listener<T> {
-    sender: oneshot::Sender<(u32, Vec<T>)>,
-    cursor: u32,
-}
-
-fn fire_listener_if_ready<T: Clone>(
-    messages: &[T],
-    listener: Listener<T>,
-) -> Result<(), Listener<T>> {
-    let current_cursor = messages.len() as u32;
-
-    if listener.cursor < current_cursor {
-        let new_messages = messages[(listener.cursor as usize)..].to_vec();
-        let _ = listener.sender.send((current_cursor, new_messages));
-        Ok(())
-    } else {
-        Err(listener)
-    }
-}
 
 /// A message queue with persistent history that can be subscribed to.
 ///
@@ -97,3 +77,23 @@ impl<T: Clone> MessageQueue<T> {
         self.messages.read().unwrap().len() as u32
     }
 }
+
+struct Listener<T> {
+    sender: oneshot::Sender<(u32, Vec<T>)>,
+    cursor: u32,
+}
+
+fn fire_listener_if_ready<T: Clone>(
+    messages: &[T],
+    listener: Listener<T>,
+) -> Result<(), Listener<T>> {
+    let current_cursor = messages.len() as u32;
+
+    if listener.cursor < current_cursor {
+        let new_messages = messages[(listener.cursor as usize)..].to_vec();
+        let _ = listener.sender.send((current_cursor, new_messages));
+        Ok(())
+    } else {
+        Err(listener)
+    }
+}

src/project.rs

@@ -57,6 +57,16 @@ pub struct Project {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub serve_place_ids: Option<HashSet<u64>>,
 
+    /// If specified, sets the current place's place ID when connecting to the
+    /// Rojo server from Roblox Studio.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub place_id: Option<u64>,
+
+    /// If specified, sets the current place's game ID when connecting to the
+    /// Rojo server from Roblox Studio.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub game_id: Option<u64>,
+
     /// 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/resolution.rs

@@ -1,10 +1,16 @@
+use std::borrow::Borrow;
+
 use anyhow::format_err;
-use rbx_dom_weak::types::{
+use rbx_dom_weak::types::{Color3, Content, Enum, Variant, VariantType, Vector2, Vector3};
-    Color3, Color3uint8, Content, Enum, Variant, VariantType, Vector2, Vector3,
-};
 use rbx_reflection::{DataType, PropertyDescriptor};
 use serde::{Deserialize, Serialize};
 
+/// A user-friendly version of `Variant` that supports specifying ambiguous
+/// values. Ambiguous values need a reflection database to be resolved to a
+/// usable value.
+///
+/// This type is used in Rojo projects and JSON models to make specifying the
+/// most common types of properties, like strings or vectors, much easier.
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum UnresolvedValue {
@@ -46,13 +52,14 @@ impl AmbiguousValue {
                 })?;
 
                 let error = |what: &str| {
-                    let sample_values = enum_descriptor
+                    let mut all_values = enum_descriptor
                         .items
                         .keys()
-                        .take(3)
+                        .map(|value| value.borrow())
-                        .map(|name| format!(r#""{}""#, name))
+                        .collect::<Vec<_>>();
-                        .collect::<Vec<_>>()
+                    all_values.sort();
-                        .join(", ");
+
+                    let examples = nonexhaustive_list(&all_values);
 
                     format_err!(
                         "Invalid value for property {}.{}. Got {} but \
@@ -61,7 +68,7 @@ impl AmbiguousValue {
                         prop_name,
                         what,
                         enum_name,
-                        sample_values
+                        examples,
                     )
                 };
 
@@ -101,15 +108,6 @@ impl AmbiguousValue {
                 (VariantType::Color3, AmbiguousValue::Array3(value)) => {
                     Ok(Color3::new(value[0] as f32, value[1] as f32, value[2] as f32).into())
                 }
-                (VariantType::Color3uint8, AmbiguousValue::Array3(value)) => {
-                    let value = Color3uint8::new(
-                        (value[0] / 255.0) as u8,
-                        (value[1] / 255.0) as u8,
-                        (value[2] / 255.0) as u8,
-                    );
-
-                    Ok(value.into())
-                }
 
                 (_, unresolved) => Err(format_err!(
                     "Wrong type of value for property {}.{}. Expected {:?}, got {}",
@@ -155,3 +153,121 @@ fn find_descriptor(
         current_class_name = class.superclass.as_deref()?;
     }
 }
+
+/// Outputs a string containing up to MAX_ITEMS entries from the given list. If
+/// there are more than MAX_ITEMS items, the number of remaining items will be
+/// listed.
+fn nonexhaustive_list(values: &[&str]) -> String {
+    use std::fmt::Write;
+
+    const MAX_ITEMS: usize = 8;
+
+    let mut output = String::new();
+
+    let last_index = values.len() - 1;
+    let main_length = last_index.min(9);
+
+    let main_list = &values[..main_length];
+    for value in main_list {
+        output.push_str(value);
+        output.push_str(", ");
+    }
+
+    if values.len() > MAX_ITEMS {
+        write!(output, "or {} more", values.len() - main_length).unwrap();
+    } else {
+        output.push_str("or ");
+        output.push_str(values[values.len() - 1]);
+    }
+
+    output
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    fn resolve(class: &str, prop: &str, json_value: &str) -> Variant {
+        let unresolved: UnresolvedValue = serde_json::from_str(json_value).unwrap();
+        unresolved.resolve(class, prop).unwrap()
+    }
+
+    #[test]
+    fn bools() {
+        assert_eq!(resolve("BoolValue", "Value", "false"), Variant::Bool(false));
+
+        // Script.Disabled is inherited from BaseScript
+        assert_eq!(resolve("Script", "Disabled", "true"), Variant::Bool(true));
+    }
+
+    #[test]
+    fn strings() {
+        // String literals can stay as strings
+        assert_eq!(
+            resolve("StringValue", "Value", "\"Hello!\""),
+            Variant::String("Hello!".into()),
+        );
+
+        // String literals can also turn into Content
+        assert_eq!(
+            resolve("Sky", "MoonTextureId", "\"rbxassetid://12345\""),
+            Variant::Content("rbxassetid://12345".into()),
+        );
+
+        // What about BinaryString values? For forward-compatibility reasons, we
+        // don't support any shorthands for BinaryString.
+        //
+        // assert_eq!(
+        //     resolve("Folder", "Tags", "\"a\\u0000b\\u0000c\""),
+        //     Variant::BinaryString(b"a\0b\0c".to_vec().into()),
+        // );
+    }
+
+    #[test]
+    fn numbers() {
+        assert_eq!(
+            resolve("Part", "CollisionGroupId", "123"),
+            Variant::Int32(123),
+        );
+
+        assert_eq!(
+            resolve("Folder", "SourceAssetId", "532413"),
+            Variant::Int64(532413),
+        );
+
+        assert_eq!(resolve("Part", "Transparency", "1"), Variant::Float32(1.0));
+        assert_eq!(resolve("NumberValue", "Value", "1"), Variant::Float64(1.0));
+    }
+
+    #[test]
+    fn vectors() {
+        assert_eq!(
+            resolve("ParticleEmitter", "SpreadAngle", "[1, 2]"),
+            Variant::Vector2(Vector2::new(1.0, 2.0)),
+        );
+
+        assert_eq!(
+            resolve("Part", "Position", "[4, 5, 6]"),
+            Variant::Vector3(Vector3::new(4.0, 5.0, 6.0)),
+        );
+    }
+
+    #[test]
+    fn colors() {
+        assert_eq!(
+            resolve("Part", "Color", "[1, 1, 1]"),
+            Variant::Color3(Color3::new(1.0, 1.0, 1.0)),
+        );
+
+        // There aren't any user-facing Color3uint8 properties. If there are
+        // some, we should treat them the same in the future.
+    }
+
+    #[test]
+    fn enums() {
+        assert_eq!(
+            resolve("Lighting", "Technology", "\"Voxel\""),
+            Variant::Enum(Enum::from_u32(1)),
+        );
+    }
+}

src/serve_session.rs

@@ -24,7 +24,9 @@ use crate::{
     snapshot_middleware::snapshot_from_vfs,
 };
 
-/// Contains all of the state for a Rojo serve session.
+/// Contains all of the state for a Rojo serve session. A serve session is used
+/// when we need to build a Rojo tree and possibly rebuild it when input files
+/// change.
 ///
 /// Nothing here is specific to any Rojo interface. Though the primary way to
 /// interact with a serve session is Rojo's HTTP right now, there's no reason
@@ -195,6 +197,14 @@ impl ServeSession {
         self.root_project.serve_port
     }
 
+    pub fn place_id(&self) -> Option<u64> {
+        self.root_project.place_id
+    }
+
+    pub fn game_id(&self) -> Option<u64> {
+        self.root_project.game_id
+    }
+
     pub fn start_time(&self) -> Instant {
         self.start_time
     }

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__add_property-2.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot/tests/apply.rs
 expression: applied_patch_value
+
 ---
 removed: []
 added: []
@@ -10,6 +11,6 @@ updated:
     changed_class_name: ~
     changed_properties:
       Foo:
-        Type: String
+        String: Value of Foo
-        Value: Value of Foo
     changed_metadata: ~
+

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__add_property.snap

@@ -1,16 +1,17 @@
 ---
 source: src/snapshot/tests/apply.rs
 expression: tree_view
+
 ---
 id: id-1
 name: ROOT
 class_name: ROOT
 properties:
   Foo:
-    Type: String
+    String: Value of Foo
-    Value: Value of Foo
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
   context: {}
 children: []
+

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__remove_property_initial.snap

@@ -1,16 +1,17 @@
 ---
 source: src/snapshot/tests/apply.rs
 expression: tree_view
+
 ---
 id: id-1
 name: ROOT
 class_name: ROOT
 properties:
   Foo:
-    Type: String
+    String: Should be removed
-    Value: Should be removed
 metadata:
   ignore_unknown_instances: false
   relevant_paths: []
   context: {}
 children: []
+

src/snapshot/tests/snapshots/librojo__snapshot__tests__compute__set_property.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot/tests/compute.rs
 expression: patch_value
+
 ---
 removed_instances: []
 added_instances: []
@@ -10,6 +11,6 @@ updated_instances:
     changed_class_name: ~
     changed_properties:
       PropertyName:
-        Type: String
+        String: "Hello, world!"
-        Value: "Hello, world!"
     changed_metadata: ~
+

src/snapshot_middleware/json_model.rs

@@ -1,4 +1,4 @@
-use std::{borrow::Cow, collections::HashMap, path::Path};
+use std::{borrow::Cow, collections::HashMap, path::Path, str};
 
 use anyhow::Context;
 use memofs::Vfs;
@@ -18,7 +18,14 @@ pub fn snapshot_json_model(
     instance_name: &str,
 ) -> SnapshotInstanceResult {
     let contents = vfs.read(path)?;
-    let instance: JsonModel = serde_json::from_slice(&contents)
+    let contents_str = str::from_utf8(&contents)
+        .with_context(|| format!("File was not valid UTF-8: {}", path.display()))?;
+
+    if contents_str.trim().is_empty() {
+        return Ok(None);
+    }
+
+    let instance: JsonModel = serde_json::from_str(contents_str)
         .with_context(|| format!("File is not a valid JSON model: {}", path.display()))?;
 
     let mut snapshot = instance

src/snapshot_middleware/mod.rs

@@ -1,5 +1,7 @@
 //! Defines the semantics that Rojo uses to turn entries on the filesystem into
 //! Roblox instances using the instance snapshot subsystem.
+//!
+//! These modules define how files turn into instances.
 
 #![allow(dead_code)]
 
@@ -38,6 +40,8 @@ use self::{
 
 pub use self::project::snapshot_project_node;
 
+/// The main entrypoint to the snapshot function. This function can be pointed
+/// at any path and will return something if Rojo knows how to deal with it.
 pub fn snapshot_from_vfs(
     context: &InstanceContext,
     vfs: &Vfs,

src/snapshot_middleware/project.rs

@@ -1,6 +1,6 @@
 use std::{borrow::Cow, collections::HashMap, path::Path};
 
-use anyhow::Context;
+use anyhow::{bail, Context};
 use memofs::Vfs;
 use rbx_reflection::ClassTag;
 
@@ -66,11 +66,13 @@ pub fn snapshot_project_node(
 ) -> SnapshotInstanceResult {
     let project_folder = project_path.parent().unwrap();
 
-    let name = Cow::Owned(instance_name.to_owned());
+    let class_name_from_project = node
-    let mut class_name = node
         .class_name
         .as_ref()
         .map(|name| Cow::Owned(name.clone()));
+    let mut class_name_from_path = None;
+
+    let name = Cow::Owned(instance_name.to_owned());
     let mut properties = HashMap::new();
     let mut children = Vec::new();
     let mut metadata = InstanceMetadata::default();
@@ -85,24 +87,7 @@ pub fn snapshot_project_node(
         };
 
         if let Some(snapshot) = snapshot_from_vfs(context, vfs, &path)? {
-            // If a class name was already specified, then it'll override the
+            class_name_from_path = Some(snapshot.class_name);
-            // class name of this snapshot ONLY if it's a Folder.
-            //
-            // This restriction is in place to prevent applying properties to
-            // instances that don't make sense. The primary use-case for using
-            // $className and $path at the same time is to use a directory as a
-            // service in a place file.
-            class_name = match class_name {
-                Some(class_name) => {
-                    if snapshot.class_name == "Folder" {
-                        Some(class_name)
-                    } else {
-                        // TODO: Turn this into an error object.
-                        panic!("If $className and $path are specified, $path must yield an instance of class Folder");
-                    }
-                }
-                None => Some(snapshot.class_name),
-            };
 
             // Properties from the snapshot are pulled in unchanged, and
             // overridden by properties set on the project node.
@@ -129,34 +114,66 @@ pub fn snapshot_project_node(
         }
     }
 
-    let class_name = class_name
+    let class_name_from_inference = infer_class_name(&name, parent_class);
-        .or_else(|| {
-            // If className wasn't defined from another source, we may be able
-            // to infer one.
 
-            let parent_class = parent_class?;
+    let class_name = match (
+        class_name_from_project,
+        class_name_from_path,
+        class_name_from_inference,
+    ) {
+        // These are the easy, happy paths!
+        (Some(project), None, None) => project,
+        (None, Some(path), None) => path,
+        (None, None, Some(inference)) => inference,
 
-            if parent_class == "DataModel" {
+        // If the user specifies a class name, but there's an inferred class
-                // Members of DataModel with names that match known services are
+        // name, we prefer the name listed explicitly by the user.
-                // probably supposed to be those services.
+        (Some(project), None, Some(_)) => project,
 
-                let descriptor = rbx_reflection_database::get().classes.get(&name)?;
+        // If the user has a $path pointing to a folder and we're able to infer
-
+        // a class name, let's use the inferred name. If the path we're pointing
-                if descriptor.tags.contains(&ClassTag::Service) {
+        // to isn't a folder, though, that's a user error.
-                    return Some(name.clone());
+        (None, Some(path), Some(inference)) => {
-                }
+            if path == "Folder" {
-            } else if parent_class == "StarterPlayer" {
+                inference
-                // StarterPlayer has two special members with their own classes.
+            } else {
-
+                path
-                if name == "StarterPlayerScripts" || name == "StarterCharacterScripts" {
-                    return Some(name.clone());
-                }
             }
+        }
 
-            None
+        (Some(project), Some(path), _) => {
-        })
+            if path == "Folder" {
-        // TODO: Turn this into an error object.
+                project
-        .expect("$className or $path must be specified");
+            } else {
+                bail!(
+                    "ClassName for Instance \"{}\" was specified in both the project file (as \"{}\") and from the filesystem (as \"{}\").\n\
+                     If $className and $path are both set, $path must refer to a Folder.
+                     \n\
+                     Project path: {}\n\
+                     Filesystem path: {}\n",
+                    instance_name,
+                    project,
+                    path,
+                    project_path.display(),
+                    node.path.as_ref().unwrap().display()
+                );
+            }
+        }
+
+        (None, None, None) => {
+            bail!(
+                "Instance \"{}\" is missing some required information.\n\
+                 One of the following must be true:\n\
+                 - $className must be set to the name of a Roblox class\n\
+                 - $path must be set to a path of an instance\n\
+                 - The instance must be a known service, like ReplicatedStorage\n\
+                 \n\
+                 Project path: {}",
+                instance_name,
+                project_path.display(),
+            );
+        }
+    };
 
     for (child_name, child_project_node) in &node.children {
         if let Some(child) = snapshot_project_node(
@@ -182,6 +199,20 @@ pub fn snapshot_project_node(
                 )
             })?;
 
+        match key.as_str() {
+            "Name" | "Parent" => {
+                log::warn!(
+                    "Property '{}' cannot be set manually, ignoring. Attempted to set in '{}' at {}",
+                    key,
+                    instance_name,
+                    project_path.display()
+                );
+                continue;
+            }
+
+            _ => {}
+        }
+
         properties.insert(key.clone(), value);
     }
 
@@ -216,6 +247,32 @@ pub fn snapshot_project_node(
     }))
 }
 
+fn infer_class_name(name: &str, parent_class: Option<&str>) -> Option<Cow<'static, str>> {
+    // If className wasn't defined from another source, we may be able
+    // to infer one.
+
+    let parent_class = parent_class?;
+
+    if parent_class == "DataModel" {
+        // Members of DataModel with names that match known services are
+        // probably supposed to be those services.
+
+        let descriptor = rbx_reflection_database::get().classes.get(name)?;
+
+        if descriptor.tags.contains(&ClassTag::Service) {
+            return Some(Cow::Owned(name.to_owned()));
+        }
+    } else if parent_class == "StarterPlayer" {
+        // StarterPlayer has two special members with their own classes.
+
+        if name == "StarterPlayerScripts" || name == "StarterCharacterScripts" {
+            return Some(Cow::Owned(name.to_owned()));
+        }
+    }
+
+    None
+}
+
 // #[cfg(feature = "broken-tests")]
 #[cfg(test)]
 mod test {
@@ -303,8 +360,7 @@ mod test {
                             "$className": "StringValue",
                             "$properties": {
                                 "Value": {
-                                    "Type": "String",
+                                    "String": "Hello, world!"
-                                    "Value": "Hello, world!"
                                 }
                             }
                         }

src/snapshot_middleware/rbxm.rs

@@ -13,7 +13,7 @@ pub fn snapshot_rbxm(
     path: &Path,
     instance_name: &str,
 ) -> SnapshotInstanceResult {
-    let temp_tree = rbx_binary::from_reader_default(vfs.read(path)?.as_slice())
+    let temp_tree = rbx_binary::from_reader(vfs.read(path)?.as_slice())
         .with_context(|| format!("Malformed rbxm file: {}", path.display()))?;
 
     let root_instance = temp_tree.root();
@@ -32,7 +32,7 @@ pub fn snapshot_rbxm(
         Ok(Some(snapshot))
     } else {
         anyhow::bail!(
-            "Rojo doesn't have support for model files with zero or more than one top-level instances yet.\n\n \
+            "Rojo currently only supports model files with one top-level instance.\n\n \
              Check the model file at path {}",
             path.display()
         );

src/snapshot_middleware/rbxmx.rs

@@ -35,7 +35,7 @@ pub fn snapshot_rbxmx(
         Ok(Some(snapshot))
     } else {
         anyhow::bail!(
-            "Rojo doesn't have support for model files with zero or more than one top-level instances yet.\n\n \
+            "Rojo currently only supports model files with one top-level instance.\n\n \
              Check the model file at path {}",
             path.display()
         );

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/csv.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: LocalizationTable
 properties:
   Contents:
-    Type: String
+    String: "[{\"key\":\"Ack\",\"example\":\"An exclamation of despair\",\"source\":\"Ack!\",\"values\":{\"es\":\"¡Ay!\"}}]"
-    Value: "[{\"key\":\"Ack\",\"example\":\"An exclamation of despair\",\"source\":\"Ack!\",\"values\":{\"es\":\"¡Ay!\"}}]"
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_with_meta.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/csv.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: LocalizationTable
 properties:
   Contents:
-    Type: String
+    String: "[{\"key\":\"Ack\",\"example\":\"An exclamation of despair\",\"source\":\"Ack!\",\"values\":{\"es\":\"¡Ay!\"}}]"
-    Value: "[{\"key\":\"Ack\",\"example\":\"An exclamation of despair\",\"source\":\"Ack!\",\"values\":{\"es\":\"¡Ay!\"}}]"
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json__test__instance_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/json.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: ModuleScript
 properties:
   Source:
-    Type: String
+    String: "return {\n\t[\"1invalidident\"] = \"nice\",\n\tarray = {1, 2, 3},\n\t[\"false\"] = false,\n\tfloat = 1234.5452,\n\tint = 1234,\n\tnull = nil,\n\tobject = {\n\t\thello = \"world\",\n\t},\n\t[\"true\"] = true,\n}"
-    Value: "return {\n\t[\"1invalidident\"] = \"nice\",\n\tarray = {1, 2, 3},\n\t[\"false\"] = false,\n\tfloat = 1234.5452,\n\tint = 1234,\n\tnull = nil,\n\tobject = {\n\t\thello = \"world\",\n\t},\n\t[\"true\"] = true,\n}"
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json_model__test__model_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/json_model.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -14,8 +15,7 @@ name: foo
 class_name: IntValue
 properties:
   Value:
-    Type: Int64
+    Int64: 5
-    Value: 5
 children:
   - snapshot_id: ~
     metadata:
@@ -26,3 +26,4 @@ children:
     class_name: StringValue
     properties: {}
     children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__client_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: LocalScript
 properties:
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__module_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: ModuleScript
 properties:
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__module_with_meta.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: ModuleScript
 properties:
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__script_disabled.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,9 +16,8 @@ name: bar
 class_name: Script
 properties:
   Disabled:
-    Type: Bool
+    Bool: true
-    Value: true
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__script_with_meta.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: Script
 properties:
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__server_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/lua.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: Script
 properties:
   Source:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_path_property_overrides.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/project.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: path-property-override
 class_name: StringValue
 properties:
   Value:
-    Type: String
+    String: Changed
-    Value: Changed
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_path_to_txt.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/project.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -16,6 +17,6 @@ name: path-project
 class_name: StringValue
 properties:
   Value:
-    Type: String
+    String: "Hello, world!"
-    Value: "Hello, world!"
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_resolved_properties.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/project.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -14,6 +15,6 @@ name: resolved-properties
 class_name: StringValue
 properties:
   Value:
-    Type: String
+    String: "Hello, world!"
-    Value: "Hello, world!"
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_unresolved_properties.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/project.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -14,6 +15,6 @@ name: unresolved-properties
 class_name: StringValue
 properties:
   Value:
-    Type: String
+    String: Hi!
-    Value: Hi!
 children: []
+

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__txt__test__instance_from_vfs.snap

@@ -1,6 +1,7 @@
 ---
 source: src/snapshot_middleware/txt.rs
 expression: instance_snapshot
+
 ---
 snapshot_id: ~
 metadata:
@@ -15,6 +16,6 @@ name: foo
 class_name: StringValue
 properties:
   Value:
-    Type: String
+    String: Hello there!
-    Value: Hello there!
 children: []
+

src/tree_view.rs

@@ -1,3 +1,6 @@
+//! Utiilty that helps redact nondeterministic information from trees so that
+//! they can be part of snapshot tests.
+
 use std::collections::HashMap;
 
 use rbx_dom_weak::types::{Ref, Variant};