Fix typos (#239)

Fixes #78.

.gitignore

@@ -1 +1,2 @@
 /site
+/generate-docs

CHANGES.md

@@ -3,6 +3,13 @@
 ## Current master
 * *No changes*
 
+## 0.4.13 (November 12, 2018)
+* When `rojo.json` points to a file or directory that does not exist, Rojo now issues a warning instead of throwing an error and exiting
+
+## 0.4.12 (June 21, 2018)
+* Fixed obscure assertion failure when renaming or deleting files ([#78](https://github.com/LPGhatguy/rojo/issues/78))
+* Added a `PluginAction` for the sync in command, which should help with some automation scripts ([#80](https://github.com/LPGhatguy/rojo/pull/80))
+
 ## 0.4.11 (June 10, 2018)
 * Defensively insert existing instances into RouteMap; should fix most duplication cases when syncing into existing trees.
 * Fixed incorrect synchronization from `Plugin:_pull` that would cause polling to create issues

README.md

@@ -8,7 +8,7 @@
     <a href="https://travis-ci.org/LPGhatguy/rojo">
         <img src="https://api.travis-ci.org/LPGhatguy/rojo.svg?branch=master" alt="Travis-CI Build Status" />
     </a>
-    <img src="https://img.shields.io/badge/latest_version-0.4.11-brightgreen.svg" alt="Current server version" />
+    <img src="https://img.shields.io/badge/latest_version-0.4.13-brightgreen.svg" alt="Current server version" />
     <a href="https://lpghatguy.github.io/rojo">
         <img src="https://img.shields.io/badge/documentation-website-brightgreen.svg" alt="Rojo Documentation" />
     </a>

docs/getting-started/creating-a-project.md

@@ -56,7 +56,7 @@ If your project is in the right place, Rojo will let you know that it was found
 
 In Roblox Studio, open the plugins tab and find Rojo's buttons.
 
-![Location of Rojo's plugin buttons in Roblox Studio](/images/plugin-buttons.png)
+![Location of Rojo's plugin buttons in Roblox Studio](../images/plugin-buttons.png)
 {: align="center" }
 
 Press **Test Connection** to verify that the plugin can communicate with the dev server. Watch the Output panel for the results.
@@ -64,7 +64,7 @@ Press **Test Connection** to verify that the plugin can communicate with the dev
 !!! info
     If you see an error message, return to the previous steps and make sure that the Rojo dev server is running.
 
-    ![Rojo error in Roblox Studio Output](/images/connection-error.png)
+    ![Rojo error in Roblox Studio Output](../images/connection-error.png)
     {: align="center" }
 
 After your connection was successful, press **Sync In** to move code from the filesystem into Studio, or use **Toggle Polling** to have Rojo automatically sync in changes as they happen.

docs/index.md

@@ -1,6 +1,16 @@
-# Home
+This is the documentation home for **Rojo 0.4.x**.
-This is the documentation home for Rojo.
 
-**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
+!!! warning
+    Rojo 0.4.x has reached end-of-life as of the release of Rojo 0.5.0 on August 27, 2019.
 
-This documentation is a work in progress, and is incomplete.
+    Upgrading to Rojo 0.5.0 is strongly recommended to get new features and continue getting support.
+
+Available versions of these docs:
+
+* [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 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/sync-details.md

@@ -5,7 +5,7 @@ This page aims to describe how Rojo turns files on the filesystem into Roblox ob
 Any directory on the filesystem will turn into a `Folder` instance in Roblox, unless that folder matches the name of a service or other existing instance. In those cases, that instance will be preserved.
 
 ## Scripts
-Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structued Roblox projects will be modules.
+Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structured Roblox projects will be modules.
 
 | File Name      | Instance Type  |
 | -------------- | -------------- |
@@ -13,7 +13,7 @@ Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The defa
 | `*.client.lua` | `LocalScript`  |
 | `*.lua`        | `ModuleScript` |
 
-If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the conents of the `init` file. This can be used to create scripts inside of scripts.
+If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the contents of the `init` file. This can be used to create scripts inside of scripts.
 
 For example, this file tree:
 
@@ -23,7 +23,7 @@ For example, this file tree:
 
 Will turn into these instances in Roblox:
 
-![Example of Roblox instances](/images/sync-example.png)
+![Example of Roblox instances](images/sync-example.png)
 
 ## Models
 Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `Value` objects, and is not suitable for larger models.

mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: Rojo Documentation
-site_url: https://lpghatguy.github.io/rojo/
+site_url: https://lpghatguy.github.io/rojo/0.4.x
 repo_name: LPGhatguy/rojo
 repo_url: https://github.com/LPGhatguy/rojo
 
@@ -9,7 +9,7 @@ theme:
     primary: 'Red'
     accent: 'Red'
 
-pages:
+nav:
   - Home: index.md
   - Why Rojo?: why-rojo.md
   - Getting Started:

plugin/src/Config.lua

@@ -1,6 +1,6 @@
 return {
-	pollingRate = 0.2,
+	pollingRate = 0.3,
-	version = {0, 4, 11},
+	version = {0, 4, 13},
 	expectedServerVersionString = "0.4.x",
 	protocolVersion = 1,
 	icons = {

plugin/src/Main.server.lua

@@ -55,15 +55,20 @@ local function main()
 				end)
 		end)
 
-	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", Config.icons.syncIn)
+	local function syncIn()
-		.Click:Connect(function()
 		checkUpgrade()
 
 		pluginInstance:syncIn()
 			:catch(function(err)
 				warn(err)
 			end)
-		end)
+	end
+
+	local shortDescription = "Sync In"
+	local longDescription = "Sync into Roblox Studio"
+
+	toolbar:CreateButton(shortDescription, longDescription, Config.icons.syncIn).Click:Connect(syncIn)
+	plugin:CreatePluginAction("RojoSyncIn", shortDescription, longDescription).Triggered:Connect(syncIn)
 
 	toolbar:CreateButton("Toggle Polling", "Poll server for changes", Config.icons.togglePolling)
 		.Click:Connect(function()

plugin/src/Reconciler.lua

@@ -170,6 +170,8 @@ function Reconciler:reconcile(rbx, item)
 	-- Item was deleted
 	if item == nil then
 		if rbx ~= nil then
+			-- TODO: If this is a partition root, should we leave it alone?
+
 			self._routeMap:removeByRbx(rbx)
 			rbx:Destroy()
 		end
@@ -240,7 +242,9 @@ function Reconciler:reconcileRoute(rbxRoute, item, fileRoute)
 
 	rbx = self:reconcile(rbx, item)
 
+	if rbx ~= nil then
 		reparent(rbx, parent)
+	end
 end
 
 return Reconciler

server/Cargo.lock

@@ -636,7 +636,7 @@ dependencies = [
 
 [[package]]
 name = "rojo"
-version = "0.4.11"
+version = "0.4.13"
 dependencies = [
  "clap 2.31.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",

server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "0.4.11"
+version = "0.4.13"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "A tool to create robust Roblox projects"
 license = "MIT"

server/src/vfs/vfs_watcher.rs

@@ -83,7 +83,8 @@ impl VfsWatcher {
                 match watcher.watch(&root_path, RecursiveMode::Recursive) {
                     Ok(_) => (),
                     Err(_) => {
-                        panic!("Unable to watch partition {}, with path {}! Make sure that it's a file or directory.", partition_name, root_path.display());
+                        eprintln!("WARNING: Unable to watch partition {}, with path {}\nMake sure that it's a file or directory.", partition_name, root_path.display());
+                        continue;
                     },
                 }
 

test-project/rojo.json

@@ -9,6 +9,10 @@
     "extra": {
       "path": "extra-script.lua",
       "target": "ReplicatedStorage.ExtraScript"
+    },
+    "does-not-exist": {
+      "path": "hahah",
+      "target": "ReplicatedStorage.Never"
     }
   }
 }