Release v0.5.1

* This should be everything?

* Add contributing guide

.gitignore

@@ -5,4 +5,5 @@
 /*.rbxm
 /*.rbxmx
 /*.rbxl
-/*.rbxlx
+/*.rbxlx
+**/*.snap.new

.gitmodules

@@ -15,4 +15,4 @@
 	url = https://github.com/osyrisrblx/t.git
 [submodule "plugin/modules/rbx-dom"]
 	path = plugin/modules/rbx-dom
-	url = http://github.com/LPGhatguy/rbx-dom
+	url = http://github.com/rojo-rbx/rbx-dom

.travis.yml

@@ -35,20 +35,10 @@ matrix:
 
       script:
         - cargo test --verbose
-        - cargo test --verbose --all-features
 
     - language: rust
       rust: stable
       cache: cargo
 
       script:
-        - cargo test --verbose
+        - cargo test --verbose
-        - cargo test --verbose --all-features
-
-    - language: rust
-      rust: beta
-      cache: cargo
-
-      script:
-        - cargo test --verbose
-        - cargo test --verbose --all-features

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## Unreleased Changes
 
+## [0.5.1](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.1) (October 4, 2019)
+* Fixed an issue where Rojo would drop changes if they happened too quickly ([#252](https://github.com/rojo-rbx/rojo/issues/252))
+* Improved diagnostics for when the Rojo plugin cannot create an instance.
+* Updated dependencies
+    * This brings Rojo's reflection database from client release 395 to client release 404.
+
+## [0.5.0](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0) (August 27, 2019)
+* Changed `.model.json` naming, which may require projects to migrate ambiguous cases:
+    * The file name now takes precedence over the `Name` field in the model, like Rojo 0.4.x.
+    * The `Name` field of the top-level instance is now optional. It's recommended that you remove it from your models.
+    * Rojo will emit a warning when `Name` is specified and does not match the name from the file.
+* Fixed `Rect` values being set to `0, 0, 0, 0` when synced with the Rojo plugin. ([#201](https://github.com/rojo-rbx/rojo/issues/201))
+* Fixed live-syncing of `PhysicalProperties`, `NumberSequence`, and `ColorSequence` values
+
 ## [0.5.0 Alpha 13](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.13) (August 2, 2019)
 * Bumped minimum Rust version to 1.34.0.
 * Fixed default port documentation in `rojo serve --help` ([#219](https://github.com/rojo-rbx/rojo/issues/219))

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to the Rojo Project
+Rojo is a big project and can always use more help! This guide covers all repositories underneath the [rojo-rbx organization on GitHub](https://github.com/rojo-rbx).
+
+Some of the repositories covered are:
+
+* https://github.com/rojo-rbx/rojo
+* https://github.com/rojo-rbx/rbx-dom
+* https://github.com/rojo-rbx/vscode-rojo
+* https://github.com/rojo-rbx/rbxlx-to-rojo
+
+## Code
+Code contributions are welcome for features and bugs that have been reported in the project's bug tracker. We want to make sure that no one wastes their time, so be sure to talk with maintainers about what changes would be accepted before doing any work!
+
+## Documentation
+Documentation impacts way more people than the individual lines of code we write.
+
+If you find any problems in documentation, including typos, bad grammar, misleading phrasing, or missing content, feel free to file issues and pull requests to fix them.
+
+## Bug Reports and Feature Requests
+Most of the tools around Rojo try to be clear when an issue is a bug. Even if they aren't, sometimes things don't work quite right.
+
+Sometimes there's something that Rojo doesn't do that it probably should.
+
+Please file issues and we'll try to help figure out what the best way forward is.
+
+## Pushing a Rojo Release
+The Rojo release process is pretty manual right now. If you need to do it, here's how:
+
+1. Bump server version in [`server/Cargo.toml`](server/Cargo.toml)
+2. Bump plugin version in [`plugin/src/Config.lua`](plugin/src/Config.lua)
+3. Run `cargo test` to update `Cargo.lock` and double-check tests
+4. Update [`CHANGELOG.md`](CHANGELOG.md)
+5. Commit!
+    * `git add . && git commit -m "Release vX.Y.Z"`
+6. Tag the commit with the version from `Cargo.toml` prepended with a v, like `v0.4.13`
+7. Build Windows release build of CLI
+    * `cargo build --release`
+7. Publish the CLI
+    * `cargo publish`
+8. Build and upload the plugin
+    * `rojo build plugin -o Rojo.rbxm`
+    * Upload `Rojo.rbxm` to Roblox.com, keep it for later
+9. Push commits and tags
+    * `git push && git push --tags`
+10. Copy GitHub release content from previous release
+    * Update the leading text with a summary about the release
+    * Paste the changelog notes (as-is!) from [`CHANGELOG.md`](CHANGELOG.md)
+    * Write a small summary of each major feature

Cargo.toml

@@ -1,6 +1,7 @@
 [workspace]
 members = [
 	"server",
+	"rojo-test",
 ]
 
 [profile.dev]

README.md

@@ -48,6 +48,8 @@ Soon, Rojo will be able to:
 If you find any mistakes, feel free to make changes in the [docs](https://github.com/rojo-rbx/rojo/tree/master/docs) folder of this repository and submit a pull request!
 
 ## Contributing
+Check out our [contribution guide](CONTRIBUTING.md) for detailed instructions for helping work on Rojo!
+
 Pull requests are welcome!
 
 Rojo supports Rust 1.34.0 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.

docs/guide/installation.md

@@ -26,12 +26,14 @@ The Rojo CLI must be run from the command line, like Terminal.app on MacOS or `c
 ### Installing from Cargo
 If you have Rust installed, the easiest way to get Rojo is with Cargo!
 
-To install the latest 0.5.0 alpha, use:
+To install the latest 0.5.x release, use:
 
 ```sh
-cargo install rojo --version 0.5.0-alpha.13
+cargo install rojo
 ```
 
+If you're upgrading from a previous version of Rojo, you may need to pass `--force` to tell Cargo to overwrite your existing version.
+
 ## Installing the Plugin
 
 ### Installing from GitHub
@@ -43,4 +45,4 @@ Download the attached `rbxm` file and put it into your Roblox Studio plugins fol
 {: align="center" }
 
 ### Installing from Roblox.com
-Visit [Rojo's Roblox.com Plugin page](https://www.roblox.com/library/1997686364/Rojo-0-5-0-alpha-3) in Roblox Studio and press **Install**.
+Visit [Rojo's Roblox.com Plugin page](https://www.roblox.com/library/1997686364) in Roblox Studio and press **Install**.

docs/guide/migrating-to-epiphany.md

@@ -60,4 +60,4 @@ Unknown files are now ignored in Rojo instead of being converted to `StringValue
 ## Migrating `init.model.json` files
 In Rojo 0.4.x, it's possible to create a file named `init.model.json` that lets you describe a model that becomes the container for all of the other files in the folder, just like `init.lua`.
 
-In Rojo 0.5.x, this feature has been replaced with `init.meta.json` files. See [Sync Details](../reference/sync-details) for more information about these new files.
+In Rojo 0.5.x, this feature has been replaced with `init.meta.json` files. See [Sync Details](../../reference/sync-details) for more information about these new files.

docs/help.md

@@ -0,0 +1,7 @@
+Rojo is a fairly complex tool to adopt, but there's a community willing to help!
+
+The [Roblox Open Source Community Discord](https://discord.gg/wH5ncNS) currently hosts a Rojo support channel, **#rojo**, that is a great place to get help as problems come up.
+
+If you find anything that looks like a bug or have ideas for how to improve Rojo, feel free to file an issue on [Rojo's GitHub issue tracker](https://github.com/rojo-rbx/rojo/issues).
+
+Rojo's primary maintainer is also available on Twitter, [@LPGhatguy](https://twitter.com/LPGhatguy).

docs/index.md

@@ -1,11 +1,11 @@
-This is the documentation home for Rojo 0.5.x.
+This is the documentation home for **Rojo 0.5.x**.
 
 Available versions of these docs:
 
-* [Latest version (currently 0.5.x)](https://rojo.space/docs/latest)
+* [Latest version from `master` branch](https://rojo.space/docs/latest)
 * [0.5.x](https://rojo.space/docs/0.5.x)
 * [0.4.x](https://rojo.space/docs/0.4.x)
 
-**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
+**Rojo** is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
 
 This documentation is a continual work in progress. If you find any issues, please file an issue on [Rojo's issue tracker](https://github.com/rojo-rbx/rojo/issues)!

docs/reference/project-format.md

@@ -1,25 +1,31 @@
 [TOC]
 
 ## Project File
+Rojo projects are JSON files that have the `.project.json` extension. They have the following fields:
 
-Rojo projects are JSON files that have the `.project.json` extension. They have these fields:
+* `name`: A string indicating the name of the project. This name is used when building the project into a model or place file.
-
+    * **Required**
-* `name`: A string indicating the name of the project.
-    * This is only used for diagnostics.
 * `tree`: An [Instance Description](#instance-description) describing the root instance of the project.
+    * **Required**
+* `servePort`: The port that `rojo serve` should listen on. Passing `--port` will override this setting.
+    * **Optional**
+    * Default is `34872`
+* `servePlaceIds`: A list of place IDs that this project may be live-synced to. This feature can help prevent overwriting the wrong game with source from Rojo.
+    * **Optional**
+    * Default is `null`
 
 ## Instance Description
-Instance Descriptions correspond one-to-one with the actual Roblox Instances in the project. They can be specified directly in the project file or be pulled from the filesystem.
+Instance Descriptions correspond one-to-one with the actual Roblox Instances in the project.
 
 * `$className`: The ClassName of the Instance being described.
-    * Optional if `$path` is specified.
+    * **Optional if `$path` is specified.**
 * `$path`: The path on the filesystem to pull files from into the project.
-    * Optional if `$className` is specified.
+    * **Optional if `$className` is specified.**
     * Paths are relative to the folder containing the project file.
 * `$properties`: Properties to apply to the instance. Values should be [Instance Property Values](#instance-property-value).
-    * Optional
+    * **Optional**
 * `$ignoreUnknownInstances`: Whether instances that Rojo doesn't know about should be deleted.
-    * Optional
+    * **Optional**
     * Default is `false` if `$path` is specified, otherwise `true`.
 
 All other fields in an Instance Description are turned into instances whose name is the key. These values should also be Instance Descriptions!

docs/reference/sync-details.md

@@ -86,6 +86,11 @@ It would turn into instances in this shape:
 ![Tree of instances in Roblox](../images/sync-example-json-model.svg)
 {: align="center" }
 
+!!! warning
+    Starting in Rojo 0.5.0 (stable), the `Name` field is no longer required. The name of the top-level instance in a JSON model is now based on its file name, and the `Name` field is now ignored.
+
+    Rojo will emit a warning if the `Name` field is specified and does not match the file's name.
+
 ## Binary and XML Models
 Rojo supports both binary (`.rbxm`) and XML (`.rbxmx`) models generated by Roblox Studio or another tool.
 

docs/why-rojo.md

@@ -2,6 +2,11 @@ Adding a tool like Rojo to your Roblox workflow can be daunting, but it comes wi
 
 [TOC]
 
+## Rojo at RDC 2019
+Nathan Riemer (Kampfkarren) gave a talk at RDC 2019 talking about some of the benefits of using a tool like Rojo.
+
+<iframe style="margin: 0 auto; max-width: 100%" width="560" height="315" src="https://www.youtube-nocookie.com/embed/czlvzEyhaBc" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
 ## External Text Editors
 Rojo opens the door to use the absolute best text editors in the world and their rich plugin ecosystems.
 

mkdocs.yml

@@ -11,6 +11,7 @@ theme:
 nav:
   - Home: index.md
   - Why Rojo?: why-rojo.md
+  - Get Help with Rojo: help.md
   - Guide:
     - Installation: guide/installation.md
     - Creating a Game with Rojo: guide/new-game.md

plugin/src/ApiContext.lua

@@ -131,13 +131,15 @@ function ApiContext:read(ids)
 				return Promise.reject("Server changed ID")
 			end
 
-			self.messageCursor = body.messageCursor
-
 			return body
 		end)
 end
 
-function ApiContext:retrieveMessages()
+function ApiContext:retrieveMessages(initialCursor)
+	if initialCursor ~= nil then
+		self.messageCursor = initialCursor
+	end
+
 	local url = ("%s/api/subscribe/%s"):format(self.baseUrl, self.messageCursor)
 
 	local function sendRequest()

plugin/src/Config.lua

@@ -1,6 +1,6 @@
 return {
 	codename = "Epiphany",
-	version = {0, 5, 0, "-alpha.13"},
+	version = {0, 5, 1},
 	expectedServerVersionString = "0.5.0 or newer",
 	protocolVersion = 2,
 	defaultHost = "localhost",

plugin/src/Reconciler.lua

@@ -50,6 +50,8 @@ function Reconciler:reconcile(virtualInstancesById, id, instance)
 	-- If an instance changes ClassName, we assume it's very different. That's
 	-- not always the case!
 	if virtualInstance.ClassName ~= instance.ClassName then
+		Logging.trace("Switching to reify for %s because ClassName is different", instance:GetFullName())
+
 		-- TODO: Preserve existing children instead?
 		local parent = instance.Parent
 		self.instanceMap:destroyId(id)
@@ -93,6 +95,12 @@ function Reconciler:reconcile(virtualInstancesById, id, instance)
 			unvisitedExistingChildren[existingChildInstance] = nil
 			self:reconcile(virtualInstancesById, childId, existingChildInstance)
 		else
+			Logging.trace(
+				"Switching to reify for %s.%s because it does not exist",
+				instance:GetFullName(),
+				virtualInstancesById[childId].Name
+			)
+
 			self:__reify(virtualInstancesById, childId, instance)
 		end
 	end
@@ -148,7 +156,13 @@ function Reconciler:__reify(virtualInstancesById, id, parent)
 
 	local virtualInstance = virtualInstancesById[id]
 
-	local instance = Instance.new(virtualInstance.ClassName)
+	local ok, instance = pcall(function()
+		return Instance.new(virtualInstance.ClassName)
+	end)
+
+	if not ok then
+		error(("Couldn't create an Instance of type %q, a child of %s"):format(virtualInstance.ClassName, parent:GetFullName()))
+	end
 
 	for key, value in pairs(virtualInstance.Properties) do
 		setCanonicalProperty(instance, key, rojoValueToRobloxValue(value))

plugin/src/Session.lua

@@ -33,7 +33,7 @@ function Session.new(config)
 			end
 
 			self.reconciler:reconcile(response.instances, api.rootInstanceId, game)
-			return self:__processMessages()
+			return self:__processMessages(response.messageCursor)
 		end)
 		:catch(function(message)
 			self.disconnected = true
@@ -43,12 +43,12 @@ function Session.new(config)
 	return not self.disconnected, setmetatable(self, Session)
 end
 
-function Session:__processMessages()
+function Session:__processMessages(initialCursor)
 	if self.disconnected then
 		return Promise.resolve()
 	end
 
-	return self.api:retrieveMessages()
+	return self.api:retrieveMessages(initialCursor)
 		:andThen(function(messages)
 			local promise = Promise.resolve(nil)
 

rojo-test/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "rojo-test"
+version = "0.1.0"
+authors = ["Lucien Greathouse <me@lpghatguy.com>"]
+edition = "2018"
+publish = false
+
+[dependencies]
+insta = "0.10.0"
+paste = "0.1.5"
+tempfile = "3.1.0"
+
+# We execute Rojo via std::process::Command, so depend on it so it's built!
+rojo = { path = "../server" }

rojo-test/build-tests/client_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "client_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/client_in_folder/folder/localScript.client.lua

@@ -0,0 +1 @@
+-- This is a Lua client script

rojo-test/build-tests/client_init/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "client_init",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/client_init/folder/init.client.lua

@@ -0,0 +1 @@
+return "From folder/init.client.lua"

rojo-test/build-tests/csv_bug_145/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "csv_bug_145",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/csv_bug_147/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "csv_bug_147",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/csv_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "csv_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/gitkeep/default.project.json

@@ -1,5 +1,5 @@
 {
-  "name": "localization",
+  "name": "gitkeep",
   "tree": {
     "$path": "src"
   }

rojo-test/build-tests/json_model_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "json_model_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/json_model_in_folder/folder/simple-model.model.json

@@ -0,0 +1,12 @@
+{
+  "ClassName": "IntValue",
+  "Properties": {
+    "Value": 5
+  },
+  "Children": [
+    {
+      "Name": "A Child",
+      "ClassName": "Folder"
+    }
+  ]
+}

rojo-test/build-tests/json_model_legacy_name/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "json_model_legacy_name",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/json_model_legacy_name/folder/Expected Name.model.json

@@ -0,0 +1,4 @@
+{
+  "Name": "Overridden Name",
+  "ClassName": "Folder"
+}

rojo-test/build-tests/module_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "module_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/module_in_folder/folder/aModule.lua

@@ -0,0 +1 @@
+-- This is a Lua module

rojo-test/build-tests/module_init/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "module_init",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/module_init/folder/init.lua

@@ -0,0 +1 @@
+return "From folder/init.lua"

rojo-test/build-tests/rbxm_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "rbxm_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/rbxmx_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "rbxmx_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/rbxmx_in_folder/folder/test-model.rbxmx

@@ -0,0 +1,33 @@
+<roblox xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.roblox.com/roblox.xsd" version="4">
+	<Meta name="ExplicitAutoJoints">true</Meta>
+	<External>null</External>
+	<External>nil</External>
+	<Item class="Model" referent="RBX7E9D90237E87493FB533B16578969429">
+		<Properties>
+			<CoordinateFrame name="ModelInPrimary">
+				<X>0</X>
+				<Y>0</Y>
+				<Z>0</Z>
+				<R00>1</R00>
+				<R01>0</R01>
+				<R02>0</R02>
+				<R10>0</R10>
+				<R11>1</R11>
+				<R12>0</R12>
+				<R20>0</R20>
+				<R21>0</R21>
+				<R22>1</R22>
+			</CoordinateFrame>
+			<string name="Name">Awesome Model</string>
+			<Ref name="PrimaryPart">null</Ref>
+			<BinaryString name="Tags"></BinaryString>
+		</Properties>
+		<Item class="StringValue" referent="RBXD2A682F437C84BE89C7B356CF5E4D92E">
+			<Properties>
+				<string name="Name">Cool StringValue</string>
+				<BinaryString name="Tags"></BinaryString>
+				<string name="Value">Did you know that BaseValue.Changed is different than Instance.Changed?</string>
+			</Properties>
+		</Item>
+	</Item>
+</roblox>

rojo-test/build-tests/server_in_folder/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "server_in_folder",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/server_in_folder/folder/serverScript.server.lua

@@ -0,0 +1 @@
+-- This is a Lua server script

rojo-test/build-tests/server_init/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "server_init",
+  "tree": {
+    "$path": "folder"
+  }
+}

rojo-test/build-tests/server_init/folder/init.server.lua

@@ -0,0 +1 @@
+return "From folder/init.server.lua"

rojo-test/build-tests/txt_in_folder/default.project.json

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

rojo-test/src/build_test.rs

@@ -0,0 +1,71 @@
+use std::{
+    fs,
+    path::Path,
+    process::Command,
+};
+
+use insta::assert_snapshot_matches;
+use tempfile::tempdir;
+
+macro_rules! gen_build_tests {
+    ( $($test_name: ident,)* ) => {
+        $(
+            paste::item! {
+                #[test]
+                fn [<build_ $test_name>]() {
+                    run_build_test(stringify!($test_name));
+                }
+            }
+        )*
+    };
+}
+
+gen_build_tests! {
+    client_in_folder,
+    client_init,
+    csv_bug_145,
+    csv_bug_147,
+    csv_in_folder,
+    gitkeep,
+    json_model_in_folder,
+    json_model_legacy_name,
+    module_in_folder,
+    module_init,
+    rbxm_in_folder,
+    rbxmx_in_folder,
+    server_in_folder,
+    server_init,
+    txt_in_folder,
+}
+
+fn run_build_test(test_name: &str) {
+    let manifest_dir = Path::new(env!("CARGO_MANIFEST_DIR"));
+    let build_test_path = manifest_dir.join("build-tests");
+    let working_dir = manifest_dir.parent().unwrap();
+
+    let output_dir = tempdir().expect("couldn't create temporary directory");
+
+    let input_path = build_test_path.join(test_name);
+    let output_path = output_dir.path().join(format!("{}.rbxmx", test_name));
+
+    let mut exe_path = working_dir.join("target/debug/rojo");
+    if cfg!(windows) {
+        exe_path.set_extension("exe");
+    }
+
+    let status = Command::new(exe_path)
+        .args(&[
+            "build", input_path.to_str().unwrap(), "-o", output_path.to_str().unwrap(),
+        ])
+        .env("RUST_LOG", "error")
+        .current_dir(working_dir)
+        .status()
+        .expect("Couldn't start Rojo");
+
+    assert!(status.success(), "Rojo did not exit successfully");
+
+    let contents = fs::read_to_string(&output_path)
+        .expect("Couldn't read output file");
+
+    assert_snapshot_matches!(test_name, contents);
+}

rojo-test/src/lib.rs

@@ -0,0 +1,2 @@
+#[cfg(test)]
+mod build_test;

rojo-test/src/snapshots/build_test__client_in_folder.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-09T01:29:47.650277200Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">client_in_folder</string>
+    </Properties>
+    <Item class="LocalScript" referent="1">
+      <Properties>
+        <string name="Name">localScript</string>
+        <string name="Source">-- This is a Lua client script</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__client_init.snap

@@ -0,0 +1,14 @@
+---
+created: "2019-08-16T19:37:51.277332900Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="LocalScript" referent="0">
+    <Properties>
+      <string name="Name">client_init</string>
+      <string name="Source">return "From folder/init.client.lua"</string>
+    </Properties>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__csv_bug_145.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-14T22:42:52.297447700Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">csv_bug_145</string>
+    </Properties>
+    <Item class="LocalizationTable" referent="1">
+      <Properties>
+        <string name="Name">normal</string>
+        <string name="Contents">[{"key":"Count","example":"A number demonstrating issue 145","source":"3","values":{"es":"7"}}]</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__csv_bug_147.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-14T22:42:52.310414Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">csv_bug_147</string>
+    </Properties>
+    <Item class="LocalizationTable" referent="1">
+      <Properties>
+        <string name="Name">normal</string>
+        <string name="Contents">[{"key":"Language.Name","source":"English","values":{}},{"key":"Language.Region","source":"United States","values":{}},{"key":"Label.Thickness","source":"Thickness","values":{}},{"key":"Label.Opacity","source":"Opacity","values":{}},{"key":"Toolbar.Undo","source":"Undo","values":{}},{"key":"Toolbar.Redo","source":"Redo","values":{}},{"key":"Toolbar.Camera","source":"Top-down camera","values":{}},{"key":"Toolbar.Saves","source":"Saved drawings","values":{}},{"key":"Toolbar.Preferences","source":"Settings","values":{}},{"key":"Toolbar.Mode.Vector","source":"Vector mode","values":{}},{"key":"Toolbar.Mode.Pixel","source":"Pixel mode","values":{}}]</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__csv_in_folder.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-14T22:34:06.206495600Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">csv_in_folder</string>
+    </Properties>
+    <Item class="LocalizationTable" referent="1">
+      <Properties>
+        <string name="Name">normal</string>
+        <string name="Contents">[{"key":"Ack","example":"An exclamation of despair","source":"Ack!","values":{"es":"¡Ay!"}}]</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__gitkeep.snap

@@ -0,0 +1,13 @@
+---
+created: "2019-08-08T00:48:33.382271800Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">gitkeep</string>
+    </Properties>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__json_model_in_folder.snap

@@ -0,0 +1,24 @@
+---
+created: "2019-08-15T20:40:50.467761900Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">json_model_in_folder</string>
+    </Properties>
+    <Item class="IntValue" referent="1">
+      <Properties>
+        <string name="Name">simple-model</string>
+        <int name="Value">5</int>
+      </Properties>
+      <Item class="Folder" referent="2">
+        <Properties>
+          <string name="Name">A Child</string>
+        </Properties>
+      </Item>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__json_model_legacy_name.snap

@@ -0,0 +1,18 @@
+---
+created: "2019-08-15T20:41:28.743618200Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">json_model_legacy_name</string>
+    </Properties>
+    <Item class="Folder" referent="1">
+      <Properties>
+        <string name="Name">Expected Name</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__module_in_folder.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-09T01:27:22.597759700Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">module_in_folder</string>
+    </Properties>
+    <Item class="ModuleScript" referent="1">
+      <Properties>
+        <string name="Name">aModule</string>
+        <string name="Source">-- This is a Lua module</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__module_init.snap

@@ -0,0 +1,14 @@
+---
+created: "2019-08-16T19:36:55.442461700Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="ModuleScript" referent="0">
+    <Properties>
+      <string name="Name">module_init</string>
+      <string name="Source">return "From folder/init.lua"</string>
+    </Properties>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__rbxm_in_folder.snap

@@ -0,0 +1,18 @@
+---
+created: "2019-08-14T22:05:46.597722600Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">rbxm_in_folder</string>
+    </Properties>
+    <Item class="Folder" referent="1">
+      <Properties>
+        <string name="Name">foo</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__rbxmx_in_folder.snap

@@ -0,0 +1,41 @@
+---
+created: "2019-08-10T07:45:07.961823500Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">rbxmx_in_folder</string>
+    </Properties>
+    <Item class="Model" referent="1">
+      <Properties>
+        <string name="Name">test-model</string>
+        <CoordinateFrame name="ModelInPrimary">
+          <X>0</X>
+          <Y>0</Y>
+          <Z>0</Z>
+          <R00>1</R00>
+          <R01>0</R01>
+          <R02>0</R02>
+          <R10>0</R10>
+          <R11>1</R11>
+          <R12>0</R12>
+          <R20>0</R20>
+          <R21>0</R21>
+          <R22>1</R22>
+        </CoordinateFrame>
+        <Ref name="PrimaryPart">null</Ref>
+        <BinaryString name="Tags"><![CDATA[]]></BinaryString>
+      </Properties>
+      <Item class="StringValue" referent="2">
+        <Properties>
+          <string name="Name">Cool StringValue</string>
+          <BinaryString name="Tags"><![CDATA[]]></BinaryString>
+          <string name="Value">Did you know that BaseValue.Changed is different than Instance.Changed?</string>
+        </Properties>
+      </Item>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__server_in_folder.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-09T01:29:48.071133300Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">server_in_folder</string>
+    </Properties>
+    <Item class="Script" referent="1">
+      <Properties>
+        <string name="Name">serverScript</string>
+        <string name="Source">-- This is a Lua server script</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__server_init.snap

@@ -0,0 +1,14 @@
+---
+created: "2019-08-16T19:36:55.442461700Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Script" referent="0">
+    <Properties>
+      <string name="Name">server_init</string>
+      <string name="Source">return "From folder/init.server.lua"</string>
+    </Properties>
+  </Item>
+</roblox>

rojo-test/src/snapshots/build_test__txt_in_folder.snap

@@ -0,0 +1,19 @@
+---
+created: "2019-08-08T00:48:33.502257600Z"
+creator: insta@0.10.0
+source: rojo-test/src/build_test.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">txt_in_folder</string>
+    </Properties>
+    <Item class="StringValue" referent="1">
+      <Properties>
+        <string name="Name">foo</string>
+        <string name="Value"></string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "0.5.0-alpha.13"
+version = "0.5.1"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "Enables professional-grade development tools for Roblox developers"
 license = "MIT"

server/src/rbx_snapshot.rs

@@ -724,28 +724,63 @@ fn snapshot_csv_file<'source>(
 fn snapshot_json_model_file<'source>(
     file: &'source ImfsFile,
 ) -> SnapshotResult<'source> {
+    let file_name = file.path
+        .file_name().expect("Could not extract file stem")
+        .to_str().expect("Could not convert path to UTF-8");
+
+    let instance_name = match_trailing(file_name, ".model.json")
+        .expect("JSON model file did not end in .model.json");
+
     let contents = str::from_utf8(&file.contents)
         .map_err(|inner| SnapshotError::Utf8Error {
             inner,
             path: file.path.to_owned(),
         })?;
 
-    let json_instance: JsonModelInstance = serde_json::from_str(contents)
+    let json_instance: JsonModel = serde_json::from_str(contents)
         .map_err(|inner| SnapshotError::JsonModelDecodeError {
             inner,
             path: file.path.to_owned(),
         })?;
 
-    let mut snapshot = json_instance.into_snapshot()?;
+    if let Some(json_name) = &json_instance.name {
+        if json_name != instance_name {
+            log::warn!("Name from JSON model did not match its file name: {}", file.path.display());
+            log::warn!("In Rojo <  alpha 14, this model is named \"{}\" (from its 'Name' property)", json_name);
+            log::warn!("In Rojo >= alpha 14, this model is named \"{}\" (from its file name)", instance_name);
+            log::warn!("'Name' for the top-level instance in a JSON model is now optional and will be ignored.");
+        }
+    }
+
+    let mut snapshot = json_instance.core.into_snapshot(instance_name.to_owned())?;
+
+    snapshot.name = Cow::Borrowed(instance_name);
     snapshot.metadata.source_path = Some(file.path.to_owned());
 
     Ok(Some(snapshot))
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+struct JsonModel {
+    name: Option<String>,
+
+    #[serde(flatten)]
+    core: JsonModelCore,
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "PascalCase")]
 struct JsonModelInstance {
     name: String,
+
+    #[serde(flatten)]
+    core: JsonModelCore,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+struct JsonModelCore {
     class_name: String,
 
     #[serde(default = "Vec::new", skip_serializing_if = "Vec::is_empty")]
@@ -755,12 +790,12 @@ struct JsonModelInstance {
     properties: HashMap<String, UnresolvedRbxValue>,
 }
 
-impl JsonModelInstance {
+impl JsonModelCore {
-    fn into_snapshot(self) -> Result<RbxSnapshotInstance<'static>, SnapshotError> {
+    fn into_snapshot(self, name: String) -> Result<RbxSnapshotInstance<'static>, SnapshotError> {
         let mut children = Vec::with_capacity(self.children.len());
 
         for child in self.children {
-            children.push(child.into_snapshot()?);
+            children.push(child.core.into_snapshot(child.name)?);
         }
 
         let mut properties = HashMap::with_capacity(self.properties.len());
@@ -771,7 +806,7 @@ impl JsonModelInstance {
         }
 
         Ok(RbxSnapshotInstance {
-            name: Cow::Owned(self.name),
+            name: Cow::Owned(name),
             class_name: Cow::Owned(self.class_name),
             properties,
             children,

server/src/web/interface.rs

@@ -73,7 +73,7 @@ impl InterfaceService {
                         <h2 class="subtitle">
                             "Version " { self.server_version }
                         </h2>
-                        <a class="docs" href="https://lpghatguy.github.io/rojo">
+                        <a class="docs" href="https://rojo.space/docs">
                             "Rojo Documentation"
                         </a>
                     </div>

server/tests/snapshot_reconciler.rs

@@ -2,7 +2,6 @@ mod test_util;
 
 use std::collections::HashMap;
 
-use pretty_assertions::assert_eq;
 use rbx_dom_weak::{RbxTree, RbxInstanceProperties};
 
 use librojo::{

server/tests/snapshot_snapshots.rs

@@ -2,8 +2,6 @@ mod test_util;
 
 use std::path::Path;
 
-use pretty_assertions::assert_eq;
-
 use librojo::{
     imfs::Imfs,
     project::Project,
@@ -34,7 +32,6 @@ macro_rules! generate_snapshot_tests {
 generate_snapshot_tests!(
     empty,
     json_model,
-    localization,
     meta_files,
     multi_partition_game,
     nested_partitions,

test-projects/localization/expected-snapshot.json

@@ -1,69 +0,0 @@
-{
-  "name": "localization",
-  "class_name": "Folder",
-  "properties": {},
-  "children": [
-    {
-      "name": "empty-column-bug-147",
-      "class_name": "LocalizationTable",
-      "properties": {
-        "Contents": {
-          "Type": "String",
-          "Value": "[{\"key\":\"Language.Name\",\"source\":\"English\",\"values\":{}},{\"key\":\"Language.Region\",\"source\":\"United States\",\"values\":{}},{\"key\":\"Label.Thickness\",\"source\":\"Thickness\",\"values\":{}},{\"key\":\"Label.Opacity\",\"source\":\"Opacity\",\"values\":{}},{\"key\":\"Toolbar.Undo\",\"source\":\"Undo\",\"values\":{}},{\"key\":\"Toolbar.Redo\",\"source\":\"Redo\",\"values\":{}},{\"key\":\"Toolbar.Camera\",\"source\":\"Top-down camera\",\"values\":{}},{\"key\":\"Toolbar.Saves\",\"source\":\"Saved drawings\",\"values\":{}},{\"key\":\"Toolbar.Preferences\",\"source\":\"Settings\",\"values\":{}},{\"key\":\"Toolbar.Mode.Vector\",\"source\":\"Vector mode\",\"values\":{}},{\"key\":\"Toolbar.Mode.Pixel\",\"source\":\"Pixel mode\",\"values\":{}}]"
-        }
-      },
-      "children": [],
-      "metadata": {
-        "ignore_unknown_instances": false,
-        "source_path": "src/empty-column-bug-147.csv",
-        "project_definition": null
-      }
-    },
-    {
-      "name": "integers-bug-145",
-      "class_name": "LocalizationTable",
-      "properties": {
-        "Contents": {
-          "Type": "String",
-          "Value": "[{\"key\":\"Count\",\"example\":\"A number demonstrating issue 145\",\"source\":\"3\",\"values\":{\"es\":\"7\"}}]"
-        }
-      },
-      "children": [],
-      "metadata": {
-        "ignore_unknown_instances": false,
-        "source_path": "src/integers-bug-145.csv",
-        "project_definition": null
-      }
-    },
-    {
-      "name": "normal",
-      "class_name": "LocalizationTable",
-      "properties": {
-        "Contents": {
-          "Type": "String",
-          "Value": "[{\"key\":\"Ack\",\"example\":\"An exclamation of despair\",\"source\":\"Ack!\",\"values\":{\"es\":\"¡Ay!\"}}]"
-        }
-      },
-      "children": [],
-      "metadata": {
-        "ignore_unknown_instances": false,
-        "source_path": "src/normal.csv",
-        "project_definition": null
-      }
-    }
-  ],
-  "metadata": {
-    "ignore_unknown_instances": false,
-    "source_path": "src",
-    "project_definition": [
-      "localization",
-      {
-        "class_name": null,
-        "children": {},
-        "properties": {},
-        "ignore_unknown_instances": null,
-        "path": "src"
-      }
-    ]
-  }
-}

test-projects/slice-center-gh-201/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "slice-center-gh-201",
+  "tree": {
+    "$className": "DataModel",
+
+    "ReplicatedStorage": {
+      "$className": "ReplicatedStorage",
+
+      "$path": "folder"
+    }
+  }
+}

test-projects/slice-center-gh-201/folder/image-label.rbxmx

@@ -0,0 +1,89 @@
+<roblox xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.roblox.com/roblox.xsd" version="4">
+	<Meta name="ExplicitAutoJoints">true</Meta>
+	<External>null</External>
+	<External>nil</External>
+	<Item class="ImageLabel" referent="RBXBB7AE810E3EE49438CCAA4DF1409C167">
+		<Properties>
+			<bool name="Active">false</bool>
+			<Vector2 name="AnchorPoint">
+				<X>0</X>
+				<Y>0</Y>
+			</Vector2>
+			<bool name="AutoLocalize">true</bool>
+			<Color3 name="BackgroundColor3">
+				<R>1</R>
+				<G>1</G>
+				<B>1</B>
+			</Color3>
+			<float name="BackgroundTransparency">0</float>
+			<Color3 name="BorderColor3">
+				<R>0.105882362</R>
+				<G>0.164705887</G>
+				<B>0.207843155</B>
+			</Color3>
+			<token name="BorderMode">0</token>
+			<int name="BorderSizePixel">1</int>
+			<bool name="ClipsDescendants">false</bool>
+			<bool name="Draggable">false</bool>
+			<Content name="Image"><url>rbxasset://textures/ui/GuiImagePlaceholder.png</url></Content>
+			<Color3 name="ImageColor3">
+				<R>1</R>
+				<G>1</G>
+				<B>1</B>
+			</Color3>
+			<Vector2 name="ImageRectOffset">
+				<X>0</X>
+				<Y>0</Y>
+			</Vector2>
+			<Vector2 name="ImageRectSize">
+				<X>0</X>
+				<Y>0</Y>
+			</Vector2>
+			<float name="ImageTransparency">0</float>
+			<int name="LayoutOrder">0</int>
+			<string name="Name">ImageLabel</string>
+			<Ref name="NextSelectionDown">null</Ref>
+			<Ref name="NextSelectionLeft">null</Ref>
+			<Ref name="NextSelectionRight">null</Ref>
+			<Ref name="NextSelectionUp">null</Ref>
+			<UDim2 name="Position">
+				<XS>0</XS>
+				<XO>0</XO>
+				<YS>0</YS>
+				<YO>0</YO>
+			</UDim2>
+			<Ref name="RootLocalizationTable">null</Ref>
+			<float name="Rotation">0</float>
+			<token name="ScaleType">1</token>
+			<bool name="Selectable">false</bool>
+			<Ref name="SelectionImageObject">null</Ref>
+			<UDim2 name="Size">
+				<XS>0</XS>
+				<XO>100</XO>
+				<YS>0</YS>
+				<YO>100</YO>
+			</UDim2>
+			<token name="SizeConstraint">0</token>
+			<Rect2D name="SliceCenter">
+				<min>
+					<X>1</X>
+					<Y>2</Y>
+				</min>
+				<max>
+					<X>3</X>
+					<Y>4</Y>
+				</max>
+			</Rect2D>
+			<float name="SliceScale">1</float>
+			<BinaryString name="Tags"></BinaryString>
+			<UDim2 name="TileSize">
+				<XS>1</XS>
+				<XO>0</XO>
+				<YS>1</YS>
+				<YO>0</YO>
+			</UDim2>
+			<bool name="Visible">true</bool>
+			<int name="ZIndex">1</int>
+		</Properties>
+	</Item>
+</roblox>