Release 0.4.11

Closes #66.

.editorconfig

@@ -4,18 +4,12 @@ root = true
 end_of_line = lf
 charset = utf-8
 
-[*.lua]
-indent_style = tab
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.rs]
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
-insert_final_newline = true
-
 [*.json]
 indent_style = space
 indent_size = 2
+trim_trailing_whitespace = true
+
+[*.md]
+indent_style = space
+indent_size = 4
 trim_trailing_whitespace = true

.gitignore

@@ -1,2 +1 @@
-/target/
-**/*.rs.bk
+/site

.gitmodules

@@ -0,0 +1,18 @@
+[submodule "plugin/modules/roact"]
+	path = plugin/modules/roact
+	url = https://github.com/Roblox/roact.git
+[submodule "plugin/modules/rodux"]
+	path = plugin/modules/rodux
+	url = https://github.com/Roblox/rodux.git
+[submodule "plugin/modules/roact-rodux"]
+	path = plugin/modules/roact-rodux
+	url = https://github.com/Roblox/roact-rodux.git
+[submodule "plugin/modules/testez"]
+	path = plugin/modules/testez
+	url = https://github.com/Roblox/testez.git
+[submodule "plugin/modules/lemur"]
+	path = plugin/modules/lemur
+	url = https://github.com/LPGhatguy/lemur.git
+[submodule "plugin/modules/promise"]
+	path = plugin/modules/promise
+	url = https://github.com/LPGhatguy/roblox-lua-promise.git

.travis.yml

@@ -0,0 +1,39 @@
+matrix:
+  include:
+    - language: python
+      env:
+        - LUA="lua=5.1"
+
+      before_install:
+        - pip install hererocks
+        - hererocks lua_install -r^ --$LUA
+        - export PATH=$PATH:$PWD/lua_install/bin
+
+      install:
+        - luarocks install luafilesystem
+        - luarocks install busted
+        - luarocks install luacov
+        - luarocks install luacov-coveralls
+        - luarocks install luacheck
+
+      script:
+        - cd plugin
+        - luacheck src
+        - lua -lluacov spec.lua
+
+      after_success:
+        - cd plugin
+        - luacov-coveralls -e $TRAVIS_BUILD_DIR/lua_install
+
+    - language: rust
+      rust: stable
+
+      script:
+        - cd server
+        - cargo test --verbose
+    - language: rust
+      rust: beta
+
+      script:
+        - cd server
+        - cargo test --verbose

CHANGES.md

@@ -1,19 +1,100 @@
 # Rojo Change Log
 
-## Current Master
+## Current master
 * *No changes*
 
-## 0.2.2
+## 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
+* Fixed incorrect file routes being assigned to `init.lua` and `init.model.json` files
+* Untangled route handling-internals slightly
+
+## 0.4.10 (June 2, 2018)
+* Added support for `init.model.json` files, which enable versioning `Tool` instances (among other things) with Rojo. ([#66](https://github.com/LPGhatguy/rojo/issues/66))
+* Fixed obscure error when syncing into an invalid service.
+* Fixed multiple sync processes occurring when a server ID mismatch is detected.
+
+## 0.4.9 (May 26, 2018)
+* Fixed warning when renaming or removing files that would sometimes corrupt the instance cache ([#72](https://github.com/LPGhatguy/rojo/pull/72))
+* JSON models are no longer as strict -- `Children` and `Properties` are now optional.
+
+## 0.4.8 (May 26, 2018)
+* Hotfix to prevent errors from being thrown when objects managed by Rojo are deleted
+
+## 0.4.7 (May 25, 2018)
+* Added icons to the Rojo plugin, made by [@Vorlias](https://github.com/Vorlias)! ([#70](https://github.com/LPGhatguy/rojo/pull/70))
+* Server will now issue a warning if no partitions are specified in `rojo serve` ([#40](https://github.com/LPGhatguy/rojo/issues/40))
+
+## 0.4.6 (May 21, 2018)
+* Rojo handles being restarted by Roblox Studio more gracefully ([#67](https://github.com/LPGhatguy/rojo/issues/67))
+* Folders should no longer get collapsed when syncing occurs.
+* **Significant** robustness improvements with regards to caching.
+    * **This should catch all existing script duplication bugs.**
+    * If there are any bugs with script duplication or caching in the future, restarting the Rojo server process will fix them for that session.
+* Fixed message in plugin not being prefixed with `Rojo: `.
+
+## 0.4.5 (May 1, 2018)
+* Rojo messages are now prefixed with `Rojo: ` to make them stand out in the output more.
+* Fixed server to notice file changes *much* more quickly. (200ms vs 1000ms)
+* Server now lists name of project when starting up.
+* Rojo now throws an error if no project file is found. ([#63](https://github.com/LPGhatguy/rojo/issues/63))
+* Fixed multiple sync operations occuring at the same time. ([#61](https://github.com/LPGhatguy/rojo/issues/61))
+* Partitions targeting files directly now work as expected. ([#57](https://github.com/LPGhatguy/rojo/issues/57))
+
+## 0.4.4 (April 7, 2018)
+* Fix small regression introduced in 0.4.3
+
+## 0.4.3 (April 7, 2018)
+* Plugin now automatically selects `HttpService` if it determines that HTTP isn't enabled ([#58](https://github.com/LPGhatguy/rojo/pull/58))
+* Plugin now has much more robust handling and will wipe all state when the server changes.
+    * This should fix issues that would otherwise be solved by restarting Roblox Studio.
+
+## 0.4.2 (April 4, 2018)
+* Fixed final case of duplicated instance insertion, caused by reconciled instances not being inserted into `RouteMap`.
+    * The reconciler is still not a perfect solution, especially if script instances get moved around without being destroyed. I don't think this can be fixed before a big refactor.
+
+## 0.4.1 (April 1, 2018)
+* Merged plugin repository into main Rojo repository for easier tracking.
+* Improved `RouteMap` object tracking; this should fix some cases of duplicated instances being synced into the tree.
+
+## 0.4.0 (March 27, 2018)
+* Protocol version 1, which shifts more responsibility onto the server
+    * This is a **major breaking** change!
+    * The server now has a content of 'filter plugins', which transform data at various stages in the pipeline
+    * The server now exposes Roblox instance objects instead of file contents, which lines up with how `rojo pack` will work, and paves the way for more robust syncing.
+* Added `*.model.json` files, which let you embed small Roblox objects into your Rojo tree.
+* Improved error messages in some cases ([#46](https://github.com/LPGhatguy/rojo/issues/46))
+
+## 0.3.2 (December 20, 2017)
+* Fixed `rojo serve` failing to correctly construct an absolute root path when passed as an argument
+* Fixed intense CPU usage when running `rojo serve`
+
+## 0.3.1 (December 14, 2017)
+* Improved error reporting when invalid JSON is found in a `rojo.json` project
+    * These messages are passed on from Serde
+
+## 0.3.0 (December 12, 2017)
+* Factored out the plugin into a separate repository
+* Fixed server when using a file as a partition
+    * Previously, trailing slashes were put on the end of a partition even if the read request was an empty string. This broke file reading on Windows when a partition pointed to a file instead of a directory!
+* Started running automatic tests on Travis CI (#9)
+
+## 0.2.3 (December 4, 2017)
+* Plugin only release
+* Tightened `init` file rules to only match script files
+    * Previously, Rojo would sometimes pick up the wrong file when syncing
+
+## 0.2.2 (December 1, 2017)
 * Plugin only release
 * Fixed broken reconciliation behavior with `init` files
 
-## 0.2.1
+## 0.2.1 (December 1, 2017)
 * Plugin only release
 * Changes default port to 8000
 
-## 0.2.0
+## 0.2.0 (December 1, 2017)
 * Support for `init.lua` like rbxfs and rbxpacker
 * More robust syncing with a new reconciler
 
-## 0.1.0
+## 0.1.0 (November 29, 2017)
 * Initial release, functionally very similar to [rbxfs](https://github.com/LPGhatguy/rbxfs)

DESIGN.md

@@ -0,0 +1,49 @@
+# Rojo Design - Protocol Version 1
+This is a super rough draft that I'm trying to use to lay out some of my thoughts.
+
+## API
+
+### POST `/read`
+Accepts a `Vec<Route>` of items to read.
+
+Returns `Vec<Option<RbxInstance>>`, in the same order as the request.
+
+### POST `/write`
+Accepts a `Vec<{ Route, RbxInstance }>` of items to write.
+
+I imagine that the `Name` attribute of the top-level `RbxInstance` would be ignored in favor of the route name?
+
+## CLI
+The `rojo serve` command uses three major components:
+* A Virtual Filesystem (VFS), which exposes the filesystem as `VfsItem` objects
+* A VFS watcher, which tracks changes to the filesystem and logs them
+* An HTTP API, which exposes an interface to the Roblox Studio plugin
+
+### Transform Plugins
+Transform plugins (or filter plugins?) can interject in three places:
+* Transform a `VfsItem` that's being read into an `RbxInstance` in the VFS
+* Transform an `RbxInstance` that's being written into a `VfsItem` in the VFS
+* Transform a file change into paths that need to be updated in the VFS watcher
+
+The plan is to have several built-in plugins that can be rearranged/configured in project settings:
+
+* Base plugin
+	* Transforms all unhandled files to/from StringValue objects
+* Script plugin
+	* Transforms `*.lua` files to their appropriate file types
+* JSON/rbxmx/rbxlx model plugin
+* External binary plugin
+	* User passes a binary name (like `moonc`) that modifies file contents
+
+## Roblox Studio Plugin
+With the protocol version 1 change, the Roblox Studio plugin got a lot simpler. Notably, the plugin doesn't need to be aware of anything about the filesystem's semantics, which is super handy.
+
+## Bi-directional syncing
+Quenty laid out a good way to handle bi-directional syncing.
+
+When receiving a change from the plugin:
+1. Hash the new contents of the file, store it in a map from routes to hashes
+2. Write the new file contents to the filesystem
+3. Later down the line, receive a change event from the filesystem watcher
+4. When receiving a change, if the item is in the hash map, read it and hash those contents
+5. If the hash matches the last noted hash, discard the change, else continue as normal

LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

LICENSE.md

@@ -1,9 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Lucien Greathouse
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,140 +1,60 @@
-<h1 align="center">Rojo</h1>
 <div align="center">
-	<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="assets/rojo-logo.png" alt="Rojo" height="217" />
 </div>
 
 <div>&nbsp;</div>
 
-Rojo is a flexible multi-tool designed for creating robust Roblox projects. It's in early development, but is still useful for many projects.
+<div align="center">
+    <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" />
+    <a href="https://lpghatguy.github.io/rojo">
+        <img src="https://img.shields.io/badge/documentation-website-brightgreen.svg" alt="Rojo Documentation" />
+    </a>
+</div>
+
+<hr />
+
+**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
 
 It's designed for power users who want to use the **best tools available** for building games, libraries, and plugins.
 
 ## Features
-
-Rojo has a number of desirable features *right now*:
+Rojo lets you:
 
 * Work on scripts from the filesystem, in your favorite editor
 * Version your place, library, or plugin using Git or another VCS
+* Sync JSON-format models from the filesystem into your game
 
-Soon, Rojo will be able to:
+Later this year, Rojo will be able to:
 
-* Sync Roblox objects (including models) bi-directionally between the filesystem and Roblox Studio
-* Create installation scripts for libraries to be used in standalone places
-	* Similar to [rbxpacker](https://github.com/LPGhatguy/rbxpacker), another one of my projects
-* Add strongly-versioned dependencies to your project
+* Sync `rbxmx` models between the filesystem and Roblox Studio
+* Package projects into `rbxmx` files from the command line
 
-## Installation
-Rojo has two components:
-* The command line tool, written in Rust
-* The [Roblox Studio plugin](https://www.roblox.com/library/1211549683/Rojo-v0-0-0), written in Lua
-
-To install the command line tool, there are two options:
-* Cargo, if you have Rust installed
-	* Use `cargo install rojo` -- Rojo will be available with the `rojo` command
-* Download a pre-built Windows binary from [the GitHub releases page](https://github.com/LPGhatguy/rojo/releases)
-
-## Usage
-For more help, use `rojo help`.
-
-### New Project
-Just create a new folder and tell Rojo to initialize it!
-
-```sh
-mkdir my-new-project
-cd my-new-project
-
-rojo init
-```
-
-Rojo will create an empty project in the directory.
-
-The default project looks like this:
-
-```json
-{
-  "name": "my-new-project",
-  "servePort": 8000,
-  "partitions": {}
-}
-```
-
-### Start Dev Server
-To create a server that allows the Rojo Dev Plugin to access your project, use:
-
-```sh
-rojo serve
-```
-
-The tool will tell you whether it found an existing project. You should then be able to connect and use the project from within Roblox Studio!
-
-### Migrating an Existing Roblox Project
-**Coming soon!**
-
-### Syncing into Roblox
-In order to sync code into Roblox, you'll need to add one or more "partitions" to your configuration. A partition tells Rojo how to map directories to Roblox objects.
-
-Each entry in the partitions table has a unique name, a filesystem path, and the full name of the Roblox object to sync into.
-
-For example, if you want to map your `src` directory to an object named `My Cool Game` in `ReplicatedStorage`, you could use this configuration:
-
-```json
-{
-  "name": "rojo",
-  "servePort": 8000,
-  "partitions": {
-    "game": {
-      "path": "src",
-      "target": "ReplicatedStorage.My Cool Game"
-    }
-  }
-}
-```
-
-The `path` parameter is relative to the project file.
-
-The `target` starts at `game` and crawls down the tree. If any objects don't exist along the way, they'll be created as `Folder` instances.
-
-Run `rojo serve` in the directory containing this project, then press the "Sync In" or "Toggle Polling" buttons in the Roblox Studio plugin to move code into your game.
-
-### Sync Details
-The structure of files and folders on the filesystem are preserved when syncing into game.
-
-Creation of Roblox instances follows a simple set of rules. The first rule that matches the file name is chosen:
-
-| File Name      | Instance Type  | Notes                                     |
-| -------------- | -------------- | ----------------------------------------- |
-| `*.server.lua` | `Script`       | `Source` will contain the file's contents |
-| `*.client.lua` | `LocalScript`  | `Source` will contain the file's contents |
-| `*.lua`        | `ModuleScript` | `Source` will contain the file's contents |
-| `*`            | `StringValue`  | `Value` will contain the file's contents  |
-
-Any folders on the filesystem will turn into `Folder` objects unless they contain a file named `init` with any extension. Following the convention of Lua, those objects will instead be whatever the `init` file would turn into.
-
-For example, this file tree:
-
-* my-game
-	* init.lua
-	* foo.lua
-
-Will turn into this tree in Roblox:
-
-* `my-game` (`ModuleScript` with source from `my-game/init.lua`)
-	* `foo` (`ModuleScript` with source from `my-game/foo.lua`)
+## [Documentation Website](https://lpghatguy.github.io/rojo)
+You can also view the documentation by browsing the [docs folder of the repository](https://github.com/LPGhatguy/rojo/tree/master/docs), but because it uses a number of Markdown extensions, it may not be very readable.
 
 ## Inspiration
-There are lots of other tools that sync scripts into Roblox, or otherwise work to improve the development flow outside of Roblox Studio.
+There are lots of other tools that sync scripts into Roblox or provide other tools for working with Roblox places.
 
 Here are a few, if you're looking for alternatives or supplements to Rojo:
-* [rbxmk by Anaminus](https://github.com/anaminus/rbxmk)
+
+* [Studio Bridge by Vocksel](https://github.com/vocksel/studio-bridge)
 * [RbxRefresh by Osyris](https://github.com/osyrisrblx/RbxRefresh)
 * [RbxSync by evaera](https://github.com/evaera/RbxSync)
 * [CodeSync](https://github.com/MemoryPenguin/CodeSync) and [rbx-exteditor](https://github.com/MemoryPenguin/rbx-exteditor) by [MemoryPenguin](https://github.com/MemoryPenguin)
+* [rbxmk by Anaminus](https://github.com/anaminus/rbxmk)
 
 I also have a couple tools that Rojo intends to replace:
+
 * [rbxfs](https://github.com/LPGhatguy/rbxfs), which has been deprecated by Rojo
 * [rbxpacker](https://github.com/LPGhatguy/rbxpacker), which is still useful
 
+## Contributing
+Pull requests are welcome!
+
+All pull requests are run against a test suite on Travis CI. That test suite should always pass!
+
 ## License
-Rojo is available under the terms of the MIT license. See [LICENSE.md](LICENSE.md) for details.
+Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE](LICENSE) for details.

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

@@ -0,0 +1,77 @@
+# Creating a Project
+To use Rojo, you'll need to create a new project file, which tells Rojo what your project is, and how to load it into Roblox Studio.
+
+## New Project
+Create a new folder, then run `rojo init` inside that folder to initialize an empty project.
+
+```sh
+mkdir my-new-project
+cd my-new-project
+
+rojo init
+```
+
+Rojo will create an empty project file named `rojo.json` in the directory.
+
+The default configuration doesn't do anything. We need to tell Rojo where our code is on the filesystem, and where we want to put it in the Roblox tree.
+
+To do that, open up `rojo.json` and add an entry to the `partitions` table:
+
+```json
+{
+    "name": "your-project-name-here",
+    "servePort": 8000,
+    "partitions": {
+        "src": {
+            "path": "src",
+            "target": "ReplicatedStorage.Project"
+        }
+    }
+}
+```
+
+!!! warning
+    Make sure that the `src` directory exists in your project, or Rojo will throw an error!
+
+!!! warning
+    Any objects contained in the `target` of a partition will be destroyed by Rojo if not found on the filesystem!
+
+A Rojo project has one or more *partitions*. Partitions define how code should be transferred between the filesystem and Roblox by mapping directories and files to Roblox objects.
+
+Each partition has:
+
+* A name (the key in the `partitions` object), which is used for debugging
+* `path`, the location on the filesystem relative to `rojo.json`
+* `target`, the location in Roblox relative to `game`
+
+## Syncing into Studio
+
+Once you've added your partition to the project file, you can start the Rojo dev server by running a command in your project's directory:
+
+```sh
+rojo serve
+```
+
+If your project is in the right place, Rojo will let you know that it was found and start an HTTP server that the plugin can connect to.
+
+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)
+{: align="center" }
+
+Press **Test Connection** to verify that the plugin can communicate with the dev server. Watch the Output panel for the results.
+
+!!! 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)
+    {: 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.
+
+## Importing an Existing Project
+Rojo will eventually support importing an existing Roblox project onto the filesystem for use with Rojo.
+
+Rojo doesn't currently support converting an existing project or syncing files from Roblox Studio onto the filesystem. In the mean time, you can manually copy your files into the structure that Rojo expects.
+
+Up-to-date information will be available on [issue #5](https://github.com/LPGhatguy/rojo/issues/5) as this is worked on.

docs/getting-started/installation.md

@@ -0,0 +1,26 @@
+# Installation
+Rojo has two components:
+
+* The server, a binary written in Rust
+* The plugin, a Roblox Studio plugin written in Lua
+
+It's important that the plugin and server are compatible. The plugin will show errors in the Roblox Studio Output window if there is a version mismatch.
+
+## Installing the Server
+To install the server, either:
+
+* If you have Rust installed, use `cargo install rojo`
+* Or, download a pre-built Windows binary from [the GitHub releases page](https://github.com/LPGhatguy/rojo/releases)
+
+**The Rojo binary must be run from the command line, like Terminal on MacOS or `cmd.exe` on Windows. It's recommended that you put the Rojo binary on your `PATH` to make this easier.**
+
+## Installing the Plugin
+To install the plugin, either:
+
+* Install the plugin from the [Roblox plugin page](https://www.roblox.com/library/1211549683/Rojo).
+  * This gives you less control over what version you install -- you will always have the latest version.
+* Or, download the latest release from [the GitHub releases section](https://github.com/LPGhatguy/rojo/releases) and install it into your Roblox plugins folder
+  * You can open this folder by clicking the "Plugins Folder" button from the Plugins toolbar in Roblox Studio
+
+## Visual Studio Code Extension
+If you use Visual Studio Code on Windows, you can install [Evaera's unofficial Rojo extension](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo), which will install both halves of Rojo for you. It even has a nifty UI to add partitions and start/stop the Rojo server!

docs/index.md

@@ -0,0 +1,6 @@
+# Home
+This is the documentation home for Rojo.
+
+**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
+
+This documentation is a work in progress, and is incomplete.

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-material
+pymdown-extensions

docs/sync-details.md

@@ -0,0 +1,65 @@
+# Sync Details
+This page aims to describe how Rojo turns files on the filesystem into Roblox objects.
+
+## Folders
+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.
+
+| File Name      | Instance Type  |
+| -------------- | -------------- |
+| `*.server.lua` | `Script`       |
+| `*.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.
+
+For example, this file tree:
+
+* my-game
+    * init.client.lua
+    * foo.lua
+
+Will turn into these instances in Roblox:
+
+![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.
+
+Rojo JSON models are stored in `.model.json` files.
+
+Starting in Rojo version **0.4.10**, model files named `init.model.json` that are located in folders will replace that folder, much like Rojo's `init.lua` support. This can be useful to version instances like `Tool` that tend to contain several instances as well as one or more scripts.
+
+!!! info
+    In the future, Rojo will support `.rbxmx` models. See [issue #7](https://github.com/LPGhatguy/rojo/issues/7) for more details and updates on this feature.
+
+!!! warning
+    Prior to Rojo version **0.4.9**, the `Properties` and `Children` properties are required on all instances in JSON models!
+
+JSON model files are fairly strict; any syntax errors will cause the model to fail to sync! They look like this:
+
+`hello.model.json`
+```json
+{
+    "Name": "hello",
+    "ClassName": "Model",
+    "Children": [
+        {
+            "Name": "Some Part",
+            "ClassName": "Part"
+        },
+        {
+            "Name": "Some StringValue",
+            "ClassName": "StringValue",
+            "Properties": {
+                "Value": {
+                    "Type": "String",
+                    "Value": "Hello, world!"
+                }
+            }
+        }
+    ]
+}
+```

docs/why-rojo.md

@@ -0,0 +1,21 @@
+# Why Rojo?
+There are a number of existing plugins for Roblox that move code from the filesystem into Roblox.
+
+Besides Rojo, there is:
+
+* [Studio Bridge](https://github.com/vocksel/studio-bridge) by [Vocksel](https://github.com/vocksel)
+* [RbxRefresh](https://github.com/osyrisrblx/RbxRefresh) by [Osyris](https://github.com/osyrisrblx)
+* [RbxSync](https://github.com/evaera/RbxSync) by [evaera](https://github.com/evaera)
+* [CodeSync](https://github.com/MemoryPenguin/CodeSync) and [rbx-exteditor](https://github.com/MemoryPenguin/rbx-exteditor) by [MemoryPenguin](https://github.com/MemoryPenguin)
+* [rbxmk](https://github.com/anaminus/rbxmk) by [Anaminus](https://github.com/anaminus)
+
+So why did I build Rojo?
+
+Each of these tools solves what is essentially the same problem from a few different angles. The goal of Rojo is to take all of the lessons and ideas learned from these projects and build a tool that can solve the problem for good.
+
+Additionally:
+
+* I think that this tool needs to be built in a compiled language without a runtime, for easy distribution and good performance.
+* I think that the conventions promoted by other sync plugins (`.module.lua` for modules, as well a single sync point) are sub-optimal.
+* I think that I have a good enough understanding of the problem to build something robust.
+* I think that Rojo should be able to do more than just sync code.

mkdocs.yml

@@ -0,0 +1,26 @@
+site_name: Rojo Documentation
+site_url: https://lpghatguy.github.io/rojo/
+repo_name: LPGhatguy/rojo
+repo_url: https://github.com/LPGhatguy/rojo
+
+theme:
+  name: material
+  palette:
+    primary: 'Red'
+    accent: 'Red'
+
+pages:
+  - Home: index.md
+  - Why Rojo?: why-rojo.md
+  - Getting Started:
+    - Installation: getting-started/installation.md
+    - Creating a Project: getting-started/creating-a-project.md
+  - Sync Details: sync-details.md
+
+markdown_extensions:
+  - attr_list
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true

plugin/.editorconfig

@@ -0,0 +1,4 @@
+[*.lua]
+indent_style = tab
+trim_trailing_whitespace = true
+insert_final_newline = true

plugin/.gitignore

@@ -0,0 +1 @@
+/luacov.*

plugin/.luacheckrc

@@ -9,7 +9,7 @@ stds.roblox = {
 
 		-- Extra functions
 		"tick", "warn", "spawn",
-		"wait", "settings",
+		"wait", "settings", "typeof",
 
 		-- Types
 		"Vector2", "Vector3",
@@ -39,10 +39,6 @@ stds.testez = {
 
 ignore = {
 	"212", -- unused arguments
-	"421", -- shadowing local variable
-	"422", -- shadowing argument
-	"431", -- shadowing upvalue
-	"432", -- shadowing upvalue argument
 }
 
 std = "lua51+roblox"
@@ -51,6 +47,6 @@ files["**/*.server.lua"] = {
 	std = "+plugin",
 }
 
-files["**/*-spec.lua"] = {
+files["**/*.spec.lua"] = {
 	std = "+testez",
 }

plugin/.luacov

@@ -0,0 +1,8 @@
+return {
+	include = {
+		"^src",
+	},
+	exclude = {
+		"%.spec$",
+	},
+}

plugin/rojo.json

@@ -0,0 +1,34 @@
+{
+  "name": "rojo",
+  "servePort": 8000,
+  "partitions": {
+    "plugin": {
+      "path": "src",
+      "target": "ReplicatedStorage.Rojo.plugin"
+    },
+    "modules/roact": {
+      "path": "modules/roact/lib",
+      "target": "ReplicatedStorage.Rojo.modules.Roact"
+    },
+    "modules/rodux": {
+      "path": "modules/rodux/lib",
+      "target": "ReplicatedStorage.Rojo.modules.Rodux"
+    },
+    "modules/roact-rodux": {
+      "path": "modules/roact-rodux/lib",
+      "target": "ReplicatedStorage.Rojo.modules.RoactRodux"
+    },
+    "modules/promise": {
+      "path": "modules/promise/lib",
+      "target": "ReplicatedStorage.Rojo.modules.Promise"
+    },
+    "modules/testez": {
+      "path": "modules/testez/lib",
+      "target": "ReplicatedStorage.TestEZ"
+    },
+    "tests": {
+      "path": "tests",
+      "target": "TestService"
+    }
+  }
+}

plugin/spec.lua

@@ -0,0 +1,69 @@
+--[[
+	Loads our library and all of its dependencies, then runs tests using TestEZ.
+]]
+
+-- If you add any dependencies, add them to this table so they'll be loaded!
+local LOAD_MODULES = {
+	{"src", "Plugin"},
+	{"modules/testez/lib", "TestEZ"},
+}
+
+-- This makes sure we can load Lemur and other libraries that depend on init.lua
+package.path = package.path .. ";?/init.lua"
+
+-- If this fails, make sure you've run `lua bin/install-dependencies.lua` first!
+local lemur = require("modules.lemur")
+
+--[[
+	Collapses ModuleScripts named 'init' into their parent folders.
+
+	This is the same result as the collapsing mechanism from Rojo.
+]]
+local function collapse(root)
+	local init = root:FindFirstChild("init")
+	if init then
+		init.Name = root.Name
+		init.Parent = root.Parent
+
+		for _, child in ipairs(root:GetChildren()) do
+			child.Parent = init
+		end
+
+		root:Destroy()
+		root = init
+	end
+
+	for _, child in ipairs(root:GetChildren()) do
+		if child:IsA("Folder") then
+			collapse(child)
+		end
+	end
+
+	return root
+end
+
+-- Create a virtual Roblox tree
+local habitat = lemur.Habitat.new()
+
+-- We'll put all of our library code and dependencies here
+local Root = lemur.Instance.new("Folder")
+Root.Name = "Root"
+
+-- Load all of the modules specified above
+for _, module in ipairs(LOAD_MODULES) do
+	local container = lemur.Instance.new("Folder", Root)
+	container.Name = module[2]
+	habitat:loadFromFs(module[1], container)
+end
+
+collapse(Root)
+
+-- Load TestEZ and run our tests
+local TestEZ = habitat:require(Root.TestEZ)
+
+local results = TestEZ.TestBootstrap:run(Root.Plugin, TestEZ.Reporters.TextReporter)
+
+-- Did something go wrong?
+if results.failureCount > 0 then
+	os.exit(1)
+end

plugin/src/Api.lua

@@ -0,0 +1,114 @@
+local HttpService = game:GetService("HttpService")
+
+local Promise = require(script.Parent.Parent.modules.Promise)
+
+local Config = require(script.Parent.Config)
+local Version = require(script.Parent.Version)
+
+local Api = {}
+Api.__index = Api
+
+Api.Error = {
+	ServerIdMismatch = "ServerIdMismatch",
+}
+
+setmetatable(Api.Error, {
+	__index = function(_, key)
+		error("Invalid API.Error name " .. key, 2)
+	end
+})
+
+--[[
+	Api.connect(Http) -> Promise<Api>
+
+	Create a new Api using the given HTTP implementation.
+
+	Attempting to invoke methods on an invalid conext will throw errors!
+]]
+function Api.connect(http)
+	local context = {
+		http = http,
+		serverId = nil,
+		currentTime = 0,
+	}
+
+	setmetatable(context, Api)
+
+	return context:_start()
+		:andThen(function()
+			return context
+		end)
+end
+
+function Api:_start()
+	return self.http:get("/")
+		:andThen(function(response)
+			response = response:json()
+
+			if response.protocolVersion ~= Config.protocolVersion then
+				local message = (
+					"Found a Rojo dev server, but it's using a different protocol version, and is incompatible." ..
+					"\nMake sure you have matching versions of both the Rojo plugin and server!" ..
+					"\n\nYour client is version %s, with protocol version %s. It expects server version %s." ..
+					"\nYour server is version %s, with protocol version %s." ..
+					"\n\nGo to https://github.com/LPGhatguy/rojo for more details."
+				):format(
+					Version.display(Config.version), Config.protocolVersion,
+					Config.expectedApiVersionString,
+					response.serverVersion, response.protocolVersion
+				)
+
+				return Promise.reject(message)
+			end
+
+			self.serverId = response.serverId
+			self.currentTime = response.currentTime
+		end)
+end
+
+function Api:getInfo()
+	return self.http:get("/")
+		:andThen(function(response)
+			response = response:json()
+
+			if response.serverId ~= self.serverId then
+				return Promise.reject(Api.Error.ServerIdMismatch)
+			end
+
+			return response
+		end)
+end
+
+function Api:read(paths)
+	local body = HttpService:JSONEncode(paths)
+
+	return self.http:post("/read", body)
+		:andThen(function(response)
+			response = response:json()
+
+			if response.serverId ~= self.serverId then
+				return Promise.reject(Api.Error.ServerIdMismatch)
+			end
+
+			return response.items
+		end)
+end
+
+function Api:getChanges()
+	local url = ("/changes/%f"):format(self.currentTime)
+
+	return self.http:get(url)
+		:andThen(function(response)
+			response = response:json()
+
+			if response.serverId ~= self.serverId then
+				return Promise.reject(Api.Error.ServerIdMismatch)
+			end
+
+			self.currentTime = response.currentTime
+
+			return response.changes
+		end)
+end
+
+return Api

plugin/src/Config.lua

@@ -1,4 +1,12 @@
 return {
-	pollingRate = 0.3,
-	version = "0.2.2",
+	pollingRate = 0.2,
+	version = {0, 4, 11},
+	expectedServerVersionString = "0.4.x",
+	protocolVersion = 1,
+	icons = {
+		syncIn = "rbxassetid://1820320573",
+		togglePolling = "rbxassetid://1820320064",
+		testConnection = "rbxassetid://1820320989",
+	},
+	dev = false,
 }

plugin/src/Config.spec.lua

@@ -0,0 +1,7 @@
+return function()
+	local Config = require(script.Parent.Config)
+
+	it("should have 'dev' disabled", function()
+		expect(Config.dev).to.equal(false)
+	end)
+end

plugin/src/Http.lua

@@ -2,7 +2,8 @@ local HttpService = game:GetService("HttpService")
 
 local HTTP_DEBUG = false
 
-local Promise = require(script.Parent.Promise)
+local Promise = require(script.Parent.Parent.modules.Promise)
+
 local HttpError = require(script.Parent.HttpError)
 local HttpResponse = require(script.Parent.HttpResponse)
 

plugin/src/HttpError.lua

@@ -52,6 +52,9 @@ end
 
 function HttpError:report()
 	warn(self.message)
+	if self.type == HttpError.Error.HttpNotEnabled then
+		game:GetService("Selection"):Set{game:GetService("HttpService")}
+	end
 end
 
 return HttpError

plugin/src/Main.server.lua

@@ -4,36 +4,75 @@ end
 
 local Plugin = require(script.Parent.Plugin)
 local Config = require(script.Parent.Config)
+local Version = require(script.Parent.Version)
+
+--[[
+	Check if the user is using a newer version of Rojo than last time. If they
+	are, show them a reminder to make sure they check their server version.
+]]
+local function checkUpgrade()
+	-- When developing Rojo, there's no use in doing version checks
+	if Config.dev then
+		return
+	end
+
+	local lastVersion = plugin:GetSetting("LastRojoVersion")
+
+	if lastVersion then
+		local wasUpgraded = Version.compare(Config.version, lastVersion) == 1
+
+		if wasUpgraded then
+			local message = (
+				"\nRojo detected an upgrade from version %s to version %s." ..
+				"\nMake sure you have also upgraded your server!" ..
+				"\n\nRojo version %s is intended for use with server version %s.\n"
+			):format(
+				Version.display(lastVersion), Version.display(Config.version),
+				Version.display(Config.version), Config.expectedServerVersionString
+			)
+
+			print(message)
+		end
+	end
+
+	plugin:SetSetting("LastRojoVersion", Config.version)
+end
 
 local function main()
 	local pluginInstance = Plugin.new()
 
-	local toolbar = plugin:CreateToolbar("Rojo Plugin v" .. Config.version)
+	local displayedVersion = Config.dev and "DEV" or Version.display(Config.version)
 
-	toolbar:CreateButton("Test Connection", "Connect to Rojo Server", "")
+	local toolbar = plugin:CreateToolbar("Rojo Plugin " .. displayedVersion)
+
+	toolbar:CreateButton("Test Connection", "Connect to Rojo Server", Config.icons.testConnection)
 		.Click:Connect(function()
+			checkUpgrade()
+
 			pluginInstance:connect()
 				:catch(function(err)
 					warn(err)
 				end)
 		end)
 
-	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", "")
+	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", Config.icons.syncIn)
 		.Click:Connect(function()
+			checkUpgrade()
+
 			pluginInstance:syncIn()
 				:catch(function(err)
 					warn(err)
 				end)
 		end)
 
-	toolbar:CreateButton("Toggle Polling", "Poll server for changes", "")
+	toolbar:CreateButton("Toggle Polling", "Poll server for changes", Config.icons.togglePolling)
 		.Click:Connect(function()
-			spawn(function()
-				pluginInstance:togglePolling()
-					:catch(function(err)
-						warn(err)
-					end)
-			end)
+			checkUpgrade()
+
+			pluginInstance:togglePolling()
+				:catch(function(err)
+					warn(err)
+				end)
 		end)
 end
 

plugin/src/Plugin.lua

@@ -1,8 +1,15 @@
+local CoreGui = game:GetService("CoreGui")
+
+local Promise = require(script.Parent.Parent.modules.Promise)
+
 local Config = require(script.Parent.Config)
 local Http = require(script.Parent.Http)
-local Server = require(script.Parent.Server)
-local Promise = require(script.Parent.Promise)
+local Api = require(script.Parent.Api)
 local Reconciler = require(script.Parent.Reconciler)
+local Version = require(script.Parent.Version)
+
+local MESSAGE_SERVER_CHANGED = "Rojo: The server has changed since the last request, reloading plugin..."
+local MESSAGE_PLUGIN_CHANGED = "Rojo: Another instance of Rojo came online, unloading..."
 
 local function collectMatch(source, pattern)
 	local result = {}
@@ -19,22 +26,38 @@ Plugin.__index = Plugin
 
 function Plugin.new()
 	local address = "localhost"
-	local port = 8000
+	local port = Config.dev and 8001 or 8000
 
 	local remote = ("http://%s:%d"):format(address, port)
 
-	local foop = {
+	local self = {
 		_http = Http.new(remote),
-		_server = nil,
+		_reconciler = Reconciler.new(),
+		_api = nil,
 		_polling = false,
+		_syncInProgress = false,
 	}
 
-	setmetatable(foop, Plugin)
+	setmetatable(self, Plugin)
 
 	do
+		local uiName = ("Rojo %s UI"):format(Version.display(Config.version))
+
+		if Config.dev then
+			uiName = "Rojo Dev UI"
+		end
+
+		-- If there's an existing Rojo UI, like from a Roblox plugin upgrade
+		-- that wasn't Rojo, make sure we clean it up.
+		local existingUi = CoreGui:FindFirstChild(uiName)
+
+		if existingUi ~= nil then
+			existingUi:Destroy()
+		end
+
 		local screenGui = Instance.new("ScreenGui")
-		screenGui.Name = "Rojo UI"
-		screenGui.Parent = game.CoreGui
+		screenGui.Name = uiName
+		screenGui.Parent = CoreGui
 		screenGui.DisplayOrder = -1
 		screenGui.Enabled = false
 
@@ -50,43 +73,84 @@ function Plugin.new()
 		label.Position = UDim2.new(0, 0, 0, 0)
 		label.Parent = screenGui
 
-		foop._label = screenGui
+		self._label = screenGui
+
+		-- If our UI was destroyed, we assume it was from another instance of
+		-- the Rojo plugin coming online.
+		--
+		-- Roblox doesn't notify plugins when they get unloaded, so this is the
+		-- best trigger we have right now unless we create a dedicated event
+		-- object.
+		screenGui.AncestryChanged:Connect(function(_, parent)
+			if parent == nil then
+				warn(MESSAGE_PLUGIN_CHANGED)
+				self:restart()
+			end
+		end)
 	end
 
-	return foop
+	return self
 end
 
-function Plugin:server()
-	if not self._server then
-		self._server = Server.connect(self._http)
-			:catch(function(err)
-				self._server = nil
+--[[
+	Clears all state and issues a notice to the user that the plugin has
+	restarted.
+]]
+function Plugin:restart()
+	self:stopPolling()
+
+	self._reconciler:destruct()
+	self._reconciler = Reconciler.new()
+
+	self._api = nil
+	self._polling = false
+	self._syncInProgress = false
+end
+
+function Plugin:getApi()
+	if self._api == nil then
+		return Api.connect(self._http)
+			:andThen(function(api)
+				self._api = api
+
+				return api
+			end, function(err)
 				return Promise.reject(err)
 			end)
 	end
 
-	return self._server
+	return Promise.resolve(self._api)
 end
 
 function Plugin:connect()
-	print("Testing connection...")
+	print("Rojo: Testing connection...")
 
-	return self:server()
-		:andThen(function(server)
-			return server:getInfo()
+	return self:getApi()
+		:andThen(function(api)
+			local ok, info = api:getInfo():await()
+
+			if not ok then
+				return Promise.reject(info)
+			end
+
+			print("Rojo: Server found!")
+			print("Rojo: Protocol version:", info.protocolVersion)
+			print("Rojo: Server version:", info.serverVersion)
 		end)
-		:andThen(function(result)
-			print("Server found!")
-			print("Protocol version:", result.protocolVersion)
-			print("Server version:", result.serverVersion)
+		:catch(function(err)
+			if err == Api.Error.ServerIdMismatch then
+				warn(MESSAGE_SERVER_CHANGED)
+				self:restart()
+				return self:connect()
+			else
+				return Promise.reject(err)
+			end
 		end)
 end
 
 function Plugin:togglePolling()
 	if self._polling then
-		self:stopPolling()
-
-		return Promise.resolve(nil)
+		return self:stopPolling()
 	else
 		return self:startPolling()
 	end
@@ -94,31 +158,47 @@ end
 
 function Plugin:stopPolling()
 	if not self._polling then
-		return
+		return Promise.resolve(false)
 	end
 
-	print("Stopped polling.")
+	print("Rojo: Stopped polling server for changes.")
 
 	self._polling = false
 	self._label.Enabled = false
+
+	return Promise.resolve(true)
 end
 
-function Plugin:_pull(server, project, routes)
-	local items = server:read(routes):await()
+function Plugin:_pull(api, project, fileRoutes)
+	return api:read(fileRoutes)
+		:andThen(function(items)
+			for index = 1, #fileRoutes do
+				local fileRoute = fileRoutes[index]
+				local partitionName = fileRoute[1]
+				local partition = project.partitions[partitionName]
+				local item = items[index]
 
-	for index = 1, #routes do
-		local route = routes[index]
-		local partitionName = route[1]
-		local partition = project.partitions[partitionName]
-		local item = items[index]
+				local partitionTargetRbxRoute = collectMatch(partition.target, "[^.]+")
 
-		local fullRoute = collectMatch(partition.target, "[^.]+")
-		for i = 2, #route do
-			table.insert(fullRoute, routes[index][i])
-		end
+				-- If the item route's length was 1, we need to rename the instance to
+				-- line up with the partition's root object name.
+				if item ~= nil and #fileRoute == 1 then
+					local objectName = partition.target:match("[^.]+$")
+					item.Name = objectName
+				end
 
-		Reconciler.reconcileRoute(fullRoute, item)
-	end
+				local itemRbxRoute = {}
+				for _, piece in ipairs(partitionTargetRbxRoute) do
+					table.insert(itemRbxRoute, piece)
+				end
+
+				for i = 2, #fileRoute do
+					table.insert(itemRbxRoute, fileRoute[i])
+				end
+
+				self._reconciler:reconcileRoute(itemRbxRoute, item, fileRoute)
+			end
+		end)
 end
 
 function Plugin:startPolling()
@@ -126,52 +206,105 @@ function Plugin:startPolling()
 		return
 	end
 
-	print("Starting to poll...")
+	print("Rojo: Starting to poll server for changes...")
 
 	self._polling = true
 	self._label.Enabled = true
 
-	return self:server()
-		:andThen(function(server)
-			self:syncIn():await()
+	return self:getApi()
+		:andThen(function(api)
+			local infoOk, info = api:getInfo():await()
 
-			local project = server:getInfo():await().project
+			if not infoOk then
+				return Promise.reject(info)
+			end
+
+			local syncOk, result = self:syncIn():await()
+
+			if not syncOk then
+				return Promise.reject(result)
+			end
 
 			while self._polling do
-				local changes = server:getChanges():await()
+				local changesOk, changes = api:getChanges():await()
 
-				local routes = {}
-
-				for _, change in ipairs(changes) do
-					table.insert(routes, change.route)
+				if not changesOk then
+					return Promise.reject(changes)
 				end
 
-				self:_pull(server, project, routes)
+				if #changes > 0 then
+					local routes = {}
+
+					for _, change in ipairs(changes) do
+						table.insert(routes, change.route)
+					end
+
+					local pullOk, pullResult = self:_pull(api, info.project, routes):await()
+
+					if not pullOk then
+						return Promise.reject(pullResult)
+					end
+				end
 
 				wait(Config.pollingRate)
 			end
 		end)
-		:catch(function()
-			self:stopPolling()
+		:catch(function(err)
+			if err == Api.Error.ServerIdMismatch then
+				warn(MESSAGE_SERVER_CHANGED)
+				self:restart()
+				return self:startPolling()
+			else
+				self:stopPolling()
+				return Promise.reject(err)
+			end
 		end)
 end
 
 function Plugin:syncIn()
-	print("Syncing from server...")
+	if self._syncInProgress then
+		warn("Rojo: Can't sync right now, because a sync is already in progress.")
 
-	return self:server()
-		:andThen(function(server)
-			local project = server:getInfo():await().project
+		return Promise.resolve()
+	end
 
-			local routes = {}
+	self._syncInProgress = true
+	print("Rojo: Syncing from server...")
 
-			for name in pairs(project.partitions) do
-				table.insert(routes, {name})
+	return self:getApi()
+		:andThen(function(api)
+			local ok, info = api:getInfo():await()
+
+			if not ok then
+				return Promise.reject(info)
 			end
 
-			self:_pull(server, project, routes)
+			local fileRoutes = {}
 
-			print("Sync successful!")
+			for name in pairs(info.project.partitions) do
+				table.insert(fileRoutes, {name})
+			end
+
+			local pullSuccess, pullResult = self:_pull(api, info.project, fileRoutes):await()
+
+			self._syncInProgress = false
+
+			if not pullSuccess then
+				return Promise.reject(pullResult)
+			end
+
+			print("Rojo: Sync successful!")
+		end)
+		:catch(function(err)
+			self._syncInProgress = false
+
+			if err == Api.Error.ServerIdMismatch then
+				warn(MESSAGE_SERVER_CHANGED)
+				self:restart()
+				return self:syncIn()
+			else
+				return Promise.reject(err)
+			end
 		end)
 end
 

plugin/src/Promise-spec.lua

@@ -1,70 +0,0 @@
-return function()
-	local Promise = require(script.Parent.Promise)
-
-	describe("Promise.new", function()
-		it("should instantiate with a callback", function()
-			local promise = Promise.new(function() end)
-
-			expect(promise).to.be.ok()
-		end)
-
-		it("should invoke the given callback with resolve and reject", function()
-			local callCount = 0
-			local resolveArg
-			local rejectArg
-
-			local promise = Promise.new(function(resolve, reject)
-				callCount = callCount + 1
-				resolveArg = resolve
-				rejectArg = reject
-			end)
-
-			expect(promise).to.be.ok()
-
-			expect(callCount).to.equal(1)
-			expect(resolveArg).to.be.a("function")
-			expect(rejectArg).to.be.a("function")
-			expect(promise._status).to.equal(Promise.Status.Started)
-		end)
-
-		it("should resolve promises on resolve()", function()
-			local callCount = 0
-
-			local promise = Promise.new(function(resolve)
-				callCount = callCount + 1
-				resolve()
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Resolved)
-		end)
-
-		it("should reject promises on reject()", function()
-			local callCount = 0
-
-			local promise = Promise.new(function(resolve, reject)
-				callCount = callCount + 1
-				reject()
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-		end)
-
-		it("should reject on error in callback", function()
-			local callCount = 0
-
-			local promise = Promise.new(function()
-				callCount = callCount + 1
-				error("hahah")
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]:find("hahah")).to.be.ok()
-		end)
-	end)
-end

plugin/src/Promise.lua

@@ -1,308 +0,0 @@
---[[
-	An implementation of Promises similar to Promise/A+.
-]]
-
-local PROMISE_DEBUG = false
-
--- If promise debugging is on, use a version of pcall that warns on failure.
--- This is useful for finding errors that happen within Promise itself.
-local wpcall
-if PROMISE_DEBUG then
-	wpcall = function(f, ...)
-		local result = { pcall(f, ...) }
-
-		if not result[1] then
-			warn(result[2])
-		end
-
-		return unpack(result)
-	end
-else
-	wpcall = pcall
-end
-
---[[
-	Creates a function that invokes a callback with correct error handling and
-	resolution mechanisms.
-]]
-local function createAdvancer(callback, resolve, reject)
-	return function(...)
-		local result = { wpcall(callback, ...) }
-		local ok = table.remove(result, 1)
-
-		if ok then
-			resolve(unpack(result))
-		else
-			reject(unpack(result))
-		end
-	end
-end
-
-local function isEmpty(t)
-	return next(t) == nil
-end
-
-local Promise = {}
-Promise.__index = Promise
-
-Promise.Status = {
-	Started = "Started",
-	Resolved = "Resolved",
-	Rejected = "Rejected",
-}
-
---[[
-	Constructs a new Promise with the given initializing callback.
-
-	This is generally only called when directly wrapping a non-promise API into
-	a promise-based version.
-
-	The callback will receive 'resolve' and 'reject' methods, used to start
-	invoking the promise chain.
-
-	For example:
-
-		local function get(url)
-			return Promise.new(function(resolve, reject)
-				spawn(function()
-					resolve(HttpService:GetAsync(url))
-				end)
-			end)
-		end
-
-		get("https://google.com")
-			:andThen(function(stuff)
-				print("Got some stuff!", stuff)
-			end)
-]]
-function Promise.new(callback)
-	local promise = {
-		-- Used to locate where a promise was created
-		_source = debug.traceback(),
-
-		-- A tag to identify us as a promise
-		_type = "Promise",
-
-		_status = Promise.Status.Started,
-
-		-- A table containing a list of all results, whether success or failure.
-		-- Only valid if _status is set to something besides Started
-		_value = nil,
-
-		-- If an error occurs with no observers, this will be set.
-		_unhandledRejection = false,
-
-		-- Queues representing functions we should invoke when we update!
-		_queuedResolve = {},
-		_queuedReject = {},
-	}
-
-	setmetatable(promise, Promise)
-
-	local function resolve(...)
-		promise:_resolve(...)
-	end
-
-	local function reject(...)
-		promise:_reject(...)
-	end
-
-	local ok, err = wpcall(callback, resolve, reject)
-
-	if not ok and promise._status == Promise.Status.Started then
-		reject(err)
-	end
-
-	return promise
-end
-
---[[
-	Create a promise that represents the immediately resolved value.
-]]
-function Promise.resolve(value)
-	return Promise.new(function(resolve)
-		resolve(value)
-	end)
-end
-
---[[
-	Create a promise that represents the immediately rejected value.
-]]
-function Promise.reject(value)
-	return Promise.new(function(_, reject)
-		reject(value)
-	end)
-end
-
---[[
-	Returns a new promise that:
-		* is resolved when all input promises resolve
-		* is rejected if ANY input promises reject
-]]
-function Promise.all(...)
-	error("unimplemented", 2)
-end
-
---[[
-	Is the given object a Promise instance?
-]]
-function Promise.is(object)
-	if type(object) ~= "table" then
-		return false
-	end
-
-	return object._type == "Promise"
-end
-
---[[
-	Creates a new promise that receives the result of this promise.
-
-	The given callbacks are invoked depending on that result.
-]]
-function Promise:andThen(successHandler, failureHandler)
-	self._unhandledRejection = false
-
-	-- Create a new promise to follow this part of the chain
-	return Promise.new(function(resolve, reject)
-		-- Our default callbacks just pass values onto the next promise.
-		-- This lets success and failure cascade correctly!
-
-		local successCallback = resolve
-		if successHandler then
-			successCallback = createAdvancer(successHandler, resolve, reject)
-		end
-
-		local failureCallback = reject
-		if failureHandler then
-			failureCallback = createAdvancer(failureHandler, resolve, reject)
-		end
-
-		if self._status == Promise.Status.Started then
-			-- If we haven't resolved yet, put ourselves into the queue
-			table.insert(self._queuedResolve, successCallback)
-			table.insert(self._queuedReject, failureCallback)
-		elseif self._status == Promise.Status.Resolved then
-			-- This promise has already resolved! Trigger success immediately.
-			successCallback(unpack(self._value))
-		elseif self._status == Promise.Status.Rejected then
-			-- This promise died a terrible death! Trigger failure immediately.
-			failureCallback(unpack(self._value))
-		end
-	end)
-end
-
---[[
-	Used to catch any errors that may have occurred in the promise.
-]]
-function Promise:catch(failureCallback)
-	return self:andThen(nil, failureCallback)
-end
-
---[[
-	Yield until the promise is completed.
-
-	This matches the execution model of normal Roblox functions.
-]]
-function Promise:await()
-	self._unhandledRejection = false
-
-	if self._status == Promise.Status.Started then
-		local result
-		local bindable = Instance.new("BindableEvent")
-
-		self:andThen(function(...)
-			result = {...}
-			bindable:Fire(true)
-		end, function(...)
-			result = {...}
-			bindable:Fire(false)
-		end)
-
-		local ok = bindable.Event:Wait()
-		bindable:Destroy()
-
-		if not ok then
-			error(tostring(result[1]), 2)
-		end
-
-		return unpack(result)
-	elseif self._status == Promise.Status.Resolved then
-		return unpack(self._value)
-	elseif self._status == Promise.Status.Rejected then
-		error(tostring(self._value[1]), 2)
-	end
-end
-
-function Promise:_resolve(...)
-	if self._status ~= Promise.Status.Started then
-		return
-	end
-
-	-- If the resolved value was a Promise, we chain onto it!
-	if Promise.is((...)) then
-		-- Without this warning, arguments sometimes mysteriously disappear
-		if select("#", ...) > 1 then
-			local message = ("When returning a Promise from andThen, extra arguments are discarded! See:\n\n%s"):format(
-				self._source
-			)
-			warn(message)
-		end
-
-		(...):andThen(function(...)
-			self:_resolve(...)
-		end, function(...)
-			self:_reject(...)
-		end)
-
-		return
-	end
-
-	self._status = Promise.Status.Resolved
-	self._value = {...}
-
-	-- We assume that these callbacks will not throw errors.
-	for _, callback in ipairs(self._queuedResolve) do
-		callback(...)
-	end
-end
-
-function Promise:_reject(...)
-	if self._status ~= Promise.Status.Started then
-		return
-	end
-
-	self._status = Promise.Status.Rejected
-	self._value = {...}
-
-	-- If there are any rejection handlers, call those!
-	if not isEmpty(self._queuedReject) then
-		-- We assume that these callbacks will not throw errors.
-		for _, callback in ipairs(self._queuedReject) do
-			callback(...)
-		end
-	else
-		-- At this point, no one was able to observe the error.
-		-- An error handler might still be attached if the error occurred
-		-- synchronously. We'll wait one tick, and if there are still no
-		-- observers, then we should put a message in the console.
-
-		self._unhandledRejection = true
-		local err = tostring((...))
-
-		spawn(function()
-			-- Someone observed the error, hooray!
-			if not self._unhandledRejection then
-				return
-			end
-
-			-- Build a reasonable message
-			local message = ("Unhandled promise rejection:\n\n%s\n\n%s"):format(
-				err,
-				self._source
-			)
-			warn(message)
-		end)
-	end
-end
-
-return Promise

plugin/src/Reconciler.lua

@@ -1,237 +1,246 @@
-local Reconciler = {}
+local RouteMap = require(script.Parent.RouteMap)
 
-local function isInit(item, itemFileName)
-	if item and item.type == "dir" then
+local function classEqual(a, b)
+	assert(typeof(a) == "string")
+	assert(typeof(b) == "string")
+
+	if a == "*" or b == "*" then
+		return true
+	end
+
+	return a == b
+end
+
+local function applyProperties(target, properties)
+	assert(typeof(target) == "Instance")
+	assert(typeof(properties) == "table")
+
+	for key, property in pairs(properties) do
+		-- TODO: Transform property value based on property.Type
+		-- Right now, we assume that 'value' is primitive!
+		target[key] = property.Value
+	end
+end
+
+--[[
+	Attempt to parent `rbx` to `parent`, doing nothing if:
+	* parent is already `parent`
+	* Changing parent threw an error
+]]
+local function reparent(rbx, parent)
+	assert(typeof(rbx) == "Instance")
+	assert(typeof(parent) == "Instance")
+
+	if rbx.Parent == parent then
 		return
 	end
 
-	return not not itemFileName:find("^init%.")
+	-- Setting `Parent` can fail if:
+	-- * The object has been destroyed
+	-- * The object is a service and cannot be reparented
+	pcall(function()
+		rbx.Parent = parent
+	end)
 end
 
-local function findInit(item)
-	if item.type ~= "dir" then
-		return nil, nil
-	end
+--[[
+	Attempts to match up Roblox instances and object specifiers for
+	reconciliation.
 
-	for childFileName, childItem in pairs(item.children) do
-		if isInit(childItem, childFileName) then
-			return childItem, childFileName
+	An object is considered a match if they have the same Name and ClassName.
+
+	primaryChildren and secondaryChildren can each be either a list of Roblox
+	instances or object specifiers. Since they share a common shape, switching
+	the two around isn't problematic!
+
+	visited is expected to be an empty table initially. It will be filled with
+	the set of children that have been visited so far.
+]]
+local function findNextChildPair(primaryChildren, secondaryChildren, visited)
+	for _, primaryChild in ipairs(primaryChildren) do
+		if not visited[primaryChild] then
+			visited[primaryChild] = true
+
+			for _, secondaryChild in ipairs(secondaryChildren) do
+				if classEqual(primaryChild.ClassName, secondaryChild.ClassName) and primaryChild.Name == secondaryChild.Name then
+					visited[secondaryChild] = true
+
+					return primaryChild, secondaryChild
+				end
+			end
+
+			return primaryChild, nil
 		end
 	end
 
 	return nil, nil
 end
 
-local function itemToName(item, fileName)
-	if item and item.type == "dir" then
-		return fileName, "Folder"
-	elseif item and item.type == "file" or not item then
-		if fileName:find("%.server%.lua$") then
-			return fileName:match("^(.-)%.server%.lua$"), "Script"
-		elseif fileName:find("%.client%.lua$") then
-			return fileName:match("^(.-)%.client%.lua$"), "LocalScript"
-		elseif fileName:find("%.lua") then
-			return fileName:match("^(.-)%.lua$"), "ModuleScript"
-		else
-			return fileName, "StringValue"
+local Reconciler = {}
+Reconciler.__index = Reconciler
+
+function Reconciler.new()
+	local reconciler = {
+		_routeMap = RouteMap.new(),
+	}
+
+	setmetatable(reconciler, Reconciler)
+
+	return reconciler
+end
+
+--[[
+	A semi-smart algorithm that attempts to apply the given item's children to
+	an existing Roblox object.
+]]
+function Reconciler:_reconcileChildren(rbx, item)
+	local visited = {}
+	local rbxChildren = rbx:GetChildren()
+
+	-- Reconcile any children that were added or updated
+	while true do
+		local itemChild, rbxChild = findNextChildPair(item.Children, rbxChildren, visited)
+
+		if itemChild == nil then
+			break
 		end
-	else
-		error("unknown item type " .. tostring(item.type))
-	end
-end
 
-local function setValues(rbx, item, fileName)
-	local _, className = itemToName(item, fileName)
+		local newRbxChild = self:reconcile(rbxChild, itemChild)
 
-	if className:find("Script") then
-		rbx.Source = item.contents
-	else
-		rbx.Value = item.contents
-	end
-end
-
-function Reconciler._reifyShallow(item, fileName)
-	if item.type == "dir" then
-		local initItem, initFileName = findInit(item)
-
-		if initItem then
-			local rbx = Reconciler._reify(initItem, initFileName)
-			rbx.Name = fileName
-
-			return rbx
-		else
-			local rbx = Instance.new("Folder")
-			rbx.Name = fileName
-
-			return rbx
-		end
-	elseif item.type == "file" then
-		local objectName, className = itemToName(item, fileName)
-
-		local rbx = Instance.new(className)
-		rbx.Name = objectName
-
-		setValues(rbx, item, fileName)
-
-		return rbx
-	else
-		error("unknown item type " .. tostring(item.type))
-	end
-end
-
-function Reconciler._reify(item, fileName, parent)
-	local rbx = Reconciler._reifyShallow(item, fileName)
-
-	if item.type == "dir" then
-		for childFileName, childItem in pairs(item.children) do
-			if not isInit(childItem, childFileName) then
-				local childRbx = Reconciler._reify(childItem, childFileName)
-				childRbx.Parent = rbx
-			end
+		if newRbxChild ~= nil then
+			newRbxChild.Parent = rbx
 		end
 	end
 
-	rbx.Parent = parent
+	-- Reconcile any children that were deleted
+	while true do
+		local rbxChild, itemChild = findNextChildPair(rbxChildren, item.Children, visited)
+
+		if rbxChild == nil then
+			break
+		end
+
+		local newRbxChild = self:reconcile(rbxChild, itemChild)
+
+		if newRbxChild ~= nil then
+			newRbxChild.Parent = rbx
+		end
+	end
+end
+
+--[[
+	Construct a new Roblox object from the given item.
+]]
+function Reconciler:_reify(item)
+	local className = item.ClassName
+
+	-- "*" represents a match of any class. It reifies as a folder!
+	if className == "*" then
+		className = "Folder"
+	end
+
+	local rbx = Instance.new(className)
+	rbx.Name = item.Name
+
+	applyProperties(rbx, item.Properties)
+
+	for _, child in ipairs(item.Children) do
+		reparent(self:_reify(child), rbx)
+	end
+
+	if item.Route ~= nil then
+		self._routeMap:insert(item.Route, rbx)
+	end
 
 	return rbx
 end
 
-function Reconciler.reconcile(rbx, item, fileName, parent)
-	-- Item was deleted!
-	if not item then
-		if isInit(item, fileName) then
-			if not parent then
-				return
-			end
-
-			-- Un-usurp parent!
-			local newParent = Instance.new("Folder")
-			newParent.Name = parent.Name
-
-			for _, child in ipairs(parent:GetChildren()) do
-				child.Parent = newParent
-			end
-
-			newParent.Parent = parent.Parent
-			parent:Destroy()
-
-			return
-		else
-			if rbx then
-				rbx:Destroy()
-			end
-
-			return
-		end
-	end
-
-	if item.type == "dir" then
-		-- Folder was created!
-		if not rbx then
-			return Reconciler._reify(item, fileName, parent)
-		end
-
-		local initItem, initFileName = findInit(item)
-
-		if initItem then
-			local _, initClassName = itemToName(initItem, initFileName)
-
-			if rbx.ClassName == initClassName then
-				setValues(rbx, initItem, initFileName)
-			else
-				rbx:Destroy()
-				return Reconciler._reify(item, fileName, parent)
-			end
-		else
-			if rbx.ClassName ~= "Folder" then
-				rbx:Destroy()
-				return Reconciler._reify(item, fileName, parent)
-			end
-		end
-
-		local visitedChildren = {}
-
-		for childFileName, childItem in pairs(item.children) do
-			if not isInit(childItem, childFileName) then
-				local childName = itemToName(childItem, childFileName)
-
-				visitedChildren[childName] = true
-
-				Reconciler.reconcile(rbx:FindFirstChild(childName), childItem, childFileName, rbx)
-			end
-		end
-
-		for _, childRbx in ipairs(rbx:GetChildren()) do
-			-- Child was deleted!
-			if not visitedChildren[childRbx.Name] then
-				childRbx:Destroy()
-			end
-		end
-
-		return rbx
-	elseif item.type == "file" then
-		if isInit(item, fileName) then
-			-- Usurp our container!
-			local _, className = itemToName(item, fileName)
-
-			if parent.ClassName == className then
-				rbx = parent
-			else
-				rbx = Reconciler._reify(item, fileName, parent.Parent)
-				rbx.Name = parent.Name
-
-				for _, child in ipairs(parent:GetChildren()) do
-					child.Parent = rbx
-				end
-
-				parent:Destroy()
-			end
-
-			setValues(rbx, item, fileName)
-
-			return rbx
-		else
-			if not rbx then
-				return Reconciler._reify(item, fileName, parent)
-			end
-
-			local _, className = itemToName(item, fileName)
-
-			if rbx.ClassName ~= className then
-				rbx:Destroy()
-				return Reconciler._reify(item, fileName, parent)
-			end
-
-			setValues(rbx, item, fileName)
-
-			return rbx
-		end
-	else
-		error("unknown item type " .. tostring(item.type))
-	end
+--[[
+	Clears any state that the Reconciler has, stopping it completely.
+]]
+function Reconciler:destruct()
+	self._routeMap:destruct()
 end
 
-function Reconciler.reconcileRoute(route, item)
-	local location = game
-
-	for i = 1, #route - 1 do
-		local piece = route[i]
-		local newLocation = location:FindFirstChild(piece)
-
-		if not newLocation then
-			newLocation = Instance.new("Folder")
-			newLocation.Name = piece
-			newLocation.Parent = location
+--[[
+	Apply the changes represented by the given item to a Roblox object that's a
+	child of the given instance.
+]]
+function Reconciler:reconcile(rbx, item)
+	-- Item was deleted
+	if item == nil then
+		if rbx ~= nil then
+			self._routeMap:removeByRbx(rbx)
+			rbx:Destroy()
 		end
 
-		location = newLocation
+		return nil
 	end
 
-	local fileName = route[#route]
+	-- Item was created!
+	if rbx == nil then
+		return self:_reify(item)
+	end
 
-	local name = itemToName(item, fileName)
-	local rbx = location:FindFirstChild(name)
-	Reconciler.reconcile(rbx, item, fileName, location)
+	-- Item changed type!
+	if not classEqual(rbx.ClassName, item.ClassName) then
+		self._routeMap:removeByRbx(rbx)
+		rbx:Destroy()
+
+		return self:_reify(item)
+	end
+
+	-- It's possible that the instance we're associating with this item hasn't
+	-- been inserted into the RouteMap yet.
+	if item.Route ~= nil then
+		self._routeMap:insert(item.Route, rbx)
+	end
+
+	applyProperties(rbx, item.Properties)
+	self:_reconcileChildren(rbx, item)
+
+	return rbx
+end
+
+function Reconciler:reconcileRoute(rbxRoute, item, fileRoute)
+	local parent
+	local rbx = game
+
+	for i = 1, #rbxRoute do
+		local piece = rbxRoute[i]
+
+		local child = rbx:FindFirstChild(piece)
+
+		-- We should get services instead of making folders here.
+		if rbx == game and child == nil then
+			local success
+			success, child = pcall(game.GetService, game, piece)
+
+			-- That isn't a valid service!
+			if not success then
+				child = nil
+			end
+		end
+
+		-- We don't want to create a folder if we're reaching our target item!
+		if child == nil and i ~= #rbxRoute then
+			child = Instance.new("Folder")
+			child.Parent = rbx
+			child.Name = piece
+		end
+
+		parent = rbx
+		rbx = child
+	end
+
+	-- Let's check the route map!
+	if rbx == nil then
+		rbx = self._routeMap:get(fileRoute)
+	end
+
+	rbx = self:reconcile(rbx, item)
+
+	reparent(rbx, parent)
 end
 
 return Reconciler

plugin/src/RouteMap.lua

@@ -0,0 +1,123 @@
+--[[
+	A map from Route objects (given by the server) to Roblox instances (created
+	by the plugin).
+]]
+
+local function hashRoute(route)
+	return table.concat(route, "/")
+end
+
+local RouteMap = {}
+RouteMap.__index = RouteMap
+
+function RouteMap.new()
+	local self = {
+		_map = {},
+		_reverseMap = {},
+		_connectionsByRbx = {},
+	}
+
+	setmetatable(self, RouteMap)
+
+	return self
+end
+
+function RouteMap:insert(route, rbx)
+	local hashed = hashRoute(route)
+
+	-- Make sure that each route and instance are only present in RouteMap once.
+	self:removeByRoute(route)
+	self:removeByRbx(rbx)
+
+	self._map[hashed] = rbx
+	self._reverseMap[rbx] = hashed
+	self._connectionsByRbx[rbx] = rbx.AncestryChanged:Connect(function(_, parent)
+		if parent == nil then
+			self:removeByRbx(rbx)
+		end
+	end)
+end
+
+function RouteMap:get(route)
+	return self._map[hashRoute(route)]
+end
+
+function RouteMap:removeByRoute(route)
+	local hashedRoute = hashRoute(route)
+	local rbx = self._map[hashedRoute]
+
+	if rbx ~= nil then
+		self:_removeInternal(rbx, hashedRoute)
+	end
+end
+
+function RouteMap:removeByRbx(rbx)
+	local hashedRoute = self._reverseMap[rbx]
+
+	if hashedRoute ~= nil then
+		self:_removeInternal(rbx, hashedRoute)
+	end
+end
+
+--[[
+	Correcly removes the given Roblox Instance/Route pair from the RouteMap.
+]]
+function RouteMap:_removeInternal(rbx, hashedRoute)
+	self._map[hashedRoute] = nil
+	self._reverseMap[rbx] = nil
+	self._connectionsByRbx[rbx]:Disconnect()
+	self._connectionsByRbx[rbx] = nil
+
+	self:_removeRbxDescendants(rbx)
+end
+
+--[[
+	Ensure that there are no descendants of the given Roblox Instance still
+	present in the map, guaranteeing that it has been cleaned out.
+]]
+function RouteMap:_removeRbxDescendants(parentRbx)
+	for rbx in pairs(self._reverseMap) do
+		if rbx:IsDescendantOf(parentRbx) then
+			self:removeByRbx(rbx)
+		end
+	end
+end
+
+--[[
+	Remove all items from the map and disconnect all connections, cleaning up
+	the RouteMap.
+]]
+function RouteMap:destruct()
+	self._map = {}
+	self._reverseMap = {}
+
+	for _, connection in pairs(self._connectionsByRbx) do
+		connection:Disconnect()
+	end
+
+	self._connectionsByRbx = {}
+end
+
+function RouteMap:visualize()
+	-- Log all of our keys so that the visualization has a stable order.
+	local keys = {}
+
+	for key in pairs(self._map) do
+		table.insert(keys, key)
+	end
+
+	table.sort(keys)
+
+	local buffer = {}
+	for _, key in ipairs(keys) do
+		local visualized = ("- %s: %s"):format(
+			key,
+			self._map[key]:GetFullName()
+		)
+		table.insert(buffer, visualized)
+	end
+
+	return table.concat(buffer, "\n")
+end
+
+return RouteMap

plugin/src/Server.lua

@@ -1,69 +0,0 @@
-local HttpService = game:GetService("HttpService")
-
-local Server = {}
-Server.__index = Server
-
---[[
-	Create a new Server using the given HTTP implementation and replacer.
-
-	If the context becomes invalid, `replacer` will be invoked with a new
-	context that should be suitable to replace this one.
-
-	Attempting to invoke methods on an invalid conext will throw errors!
-]]
-function Server.connect(http)
-	local context = {
-		http = http,
-		serverId = nil,
-		currentTime = 0,
-	}
-
-	setmetatable(context, Server)
-
-	return context:_start()
-end
-
-function Server:_start()
-	return self:getInfo()
-		:andThen(function(response)
-			self.serverId = response.serverId
-			self.currentTime = response.currentTime
-
-			return self
-		end)
-end
-
-function Server:getInfo()
-	return self.http:get("/")
-		:andThen(function(response)
-			response = response:json()
-
-			return response
-		end)
-end
-
-function Server:read(paths)
-	local body = HttpService:JSONEncode(paths)
-
-	return self.http:post("/read", body)
-		:andThen(function(response)
-			response = response:json()
-
-			return response.items
-		end)
-end
-
-function Server:getChanges()
-	local url = ("/changes/%f"):format(self.currentTime)
-
-	return self.http:get(url)
-		:andThen(function(response)
-			response = response:json()
-
-			self.currentTime = response.currentTime
-
-			return response.changes
-		end)
-end
-
-return Server

plugin/src/Version.lua

@@ -0,0 +1,40 @@
+local function compare(a, b)
+	if a > b then
+		return 1
+	elseif a < b then
+		return -1
+	end
+
+	return 0
+end
+
+local Version = {}
+
+--[[
+	Compares two versions of the form {major, minor, revision}.
+
+	If a is newer than b, 1.
+	If a is older than b, -1.
+	If a and b are the same, 0.
+]]
+function Version.compare(a, b)
+	local major = compare(a[1], b[1])
+	local minor = compare(a[2] or 0, b[2] or 0)
+	local revision = compare(a[3] or 0, b[3] or 0)
+
+	if major ~= 0 then
+		return major
+	end
+
+	if minor ~= 0 then
+		return minor
+	end
+
+	return revision
+end
+
+function Version.display(version)
+	return table.concat(version, ".")
+end
+
+return Version

plugin/src/Version.spec.lua

@@ -0,0 +1,28 @@
+return function()
+	local Version = require(script.Parent.Version)
+
+	it("should compare equal versions", function()
+		expect(Version.compare({1, 2, 3}, {1, 2, 3})).to.equal(0)
+		expect(Version.compare({0, 4, 0}, {0, 4})).to.equal(0)
+		expect(Version.compare({0, 0, 123}, {0, 0, 123})).to.equal(0)
+		expect(Version.compare({26}, {26})).to.equal(0)
+		expect(Version.compare({26, 42}, {26, 42})).to.equal(0)
+		expect(Version.compare({1, 0, 0}, {1})).to.equal(0)
+	end)
+
+	it("should compare newer, older versions", function()
+		expect(Version.compare({1}, {0})).to.equal(1)
+		expect(Version.compare({1, 1}, {1, 0})).to.equal(1)
+	end)
+
+	it("should compare different major versions", function()
+		expect(Version.compare({1, 3, 2}, {2, 2, 1})).to.equal(-1)
+		expect(Version.compare({1, 2}, {2, 1})).to.equal(-1)
+		expect(Version.compare({1}, {2})).to.equal(-1)
+	end)
+
+	it("should compare different minor versions", function()
+		expect(Version.compare({1, 2, 3}, {1, 3, 2})).to.equal(-1)
+		expect(Version.compare({50, 1}, {50, 2})).to.equal(-1)
+	end)
+end

plugin/src/runTests.lua

@@ -0,0 +1,4 @@
+return function()
+	local TestEZ = require(script.Parent.Parent.TestEZ)
+	TestEZ.TestBootstrap:run(script.Parent)
+end

plugin/tests/runTests.server.lua

@@ -0,0 +1,2 @@
+local TestEZ = require(game.ReplicatedStorage.TestEZ)
+TestEZ.TestBootstrap:run(game.ReplicatedStorage.Rojo.plugin)

rojo.json

@@ -1,10 +0,0 @@
-{
-  "name": "rojo",
-  "servePort": 8000,
-  "partitions": {
-    "plugin": {
-      "path": "plugin/src",
-      "target": "ReplicatedStorage.Rojo Plugin"
-    }
-  }
-}

server/.editorconfig

@@ -0,0 +1,5 @@
+[*.rs]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true

server/.gitignore

@@ -0,0 +1,2 @@
+/target/
+**/*.rs.bk

server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "0.2.0"
+version = "0.4.11"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "A tool to create robust Roblox projects"
 license = "MIT"
@@ -12,9 +12,11 @@ path = "src/bin.rs"
 
 [dependencies]
 clap = "2.27.1"
-rouille = "1.0"
+rouille = "2.1.0"
 serde = "1.0"
 serde_derive = "1.0"
 serde_json = "1.0"
 notify = "4.0.0"
 rand = "0.3"
+regex = "0.2"
+lazy_static = "1.0"

server/src/bin.rs

@@ -0,0 +1,97 @@
+#[macro_use] extern crate serde_derive;
+#[macro_use] extern crate rouille;
+#[macro_use] extern crate clap;
+#[macro_use] extern crate lazy_static;
+extern crate notify;
+extern crate rand;
+extern crate serde;
+extern crate serde_json;
+extern crate regex;
+
+pub mod web;
+pub mod core;
+pub mod project;
+pub mod pathext;
+pub mod vfs;
+pub mod rbx;
+pub mod plugin;
+pub mod plugins;
+pub mod commands;
+
+use std::path::{Path, PathBuf};
+use std::process;
+
+use pathext::canonicalish;
+
+fn main() {
+    let matches = clap_app!(rojo =>
+        (version: env!("CARGO_PKG_VERSION"))
+        (author: env!("CARGO_PKG_AUTHORS"))
+        (about: env!("CARGO_PKG_DESCRIPTION"))
+
+        (@subcommand init =>
+            (about: "Creates a new Rojo project")
+            (@arg PATH: "Path to the place to create the project. Defaults to the current directory.")
+        )
+
+        (@subcommand serve =>
+            (about: "Serves the project's files for use with the Rojo Studio plugin.")
+            (@arg PROJECT: "Path to the project to serve. Defaults to the current directory.")
+            (@arg port: --port +takes_value "The port to listen on. Defaults to 8000.")
+        )
+
+        (@subcommand pack =>
+            (about: "Packs the project into a GUI installer bundle. NOT YET IMPLEMENTED!")
+            (@arg PROJECT: "Path to the project to pack. Defaults to the current directory.")
+        )
+
+        (@arg verbose: --verbose "Enable extended logging.")
+    ).get_matches();
+
+    let verbose = match matches.occurrences_of("verbose") {
+        0 => false,
+        _ => true,
+    };
+
+    match matches.subcommand() {
+        ("init", sub_matches) => {
+            let sub_matches = sub_matches.unwrap();
+            let project_path = Path::new(sub_matches.value_of("PATH").unwrap_or("."));
+            let full_path = canonicalish(project_path);
+
+            commands::init(&full_path);
+        },
+        ("serve", sub_matches) => {
+            let sub_matches = sub_matches.unwrap();
+
+            let project_path = match sub_matches.value_of("PROJECT") {
+                Some(v) => canonicalish(PathBuf::from(v)),
+                None => std::env::current_dir().unwrap(),
+            };
+
+            let port = {
+                match sub_matches.value_of("port") {
+                    Some(source) => match source.parse::<u64>() {
+                        Ok(value) => Some(value),
+                        Err(_) => {
+                            eprintln!("Invalid port '{}'", source);
+                            process::exit(1);
+                        },
+                    },
+                    None => None,
+                }
+            };
+
+            commands::serve(&project_path, verbose, port);
+        },
+        ("pack", _) => {
+            eprintln!("'rojo pack' is not yet implemented!");
+            process::exit(1);
+        },
+        _ => {
+            eprintln!("Please specify a subcommand!");
+            eprintln!("Try 'rojo help' for information.");
+            process::exit(1);
+        },
+    }
+}

server/src/commands/init.rs

@@ -0,0 +1,16 @@
+use std::path::PathBuf;
+use std::process;
+
+use project::Project;
+
+pub fn init(project_path: &PathBuf) {
+    match Project::init(project_path) {
+        Ok(_) => {
+            println!("Created new empty project at {}", project_path.display());
+        },
+        Err(e) => {
+            eprintln!("Failed to create new project.\n{}", e);
+            process::exit(1);
+        },
+    }
+}

server/src/commands/mod.rs

@@ -0,0 +1,5 @@
+mod serve;
+mod init;
+
+pub use self::serve::*;
+pub use self::init::*;

server/src/commands/serve.rs

@@ -0,0 +1,98 @@
+use std::path::{Path, PathBuf};
+use std::process;
+use std::sync::{Arc, Mutex};
+use std::thread;
+
+use rand;
+
+use project::{Project, ProjectLoadError};
+use plugin::{PluginChain};
+use plugins::{DefaultPlugin, JsonModelPlugin, ScriptPlugin};
+use vfs::{VfsSession, VfsWatcher};
+use web;
+
+pub fn serve(project_path: &PathBuf, verbose: bool, port: Option<u64>) {
+    let server_id = rand::random::<u64>();
+
+    let project = match Project::load(project_path) {
+        Ok(project) => {
+            println!("Using project \"{}\" from {}", project.name, project_path.display());
+            project
+        },
+        Err(err) => {
+            match err {
+                ProjectLoadError::InvalidJson(serde_err) => {
+                    eprintln!("Project contained invalid JSON!");
+                    eprintln!("{}", project_path.display());
+                    eprintln!("Error: {}", serde_err);
+
+                    process::exit(1);
+                },
+                ProjectLoadError::FailedToOpen | ProjectLoadError::FailedToRead => {
+                    eprintln!("Found project file, but failed to read it!");
+                    eprintln!("Check the permissions of the project file at {}", project_path.display());
+
+                    process::exit(1);
+                },
+                ProjectLoadError::DidNotExist => {
+                    eprintln!("Found no project file! Create one using 'rojo init'");
+                    eprintln!("Checked for a project at {}", project_path.display());
+
+                    process::exit(1);
+                },
+            }
+        },
+    };
+
+    if project.partitions.len() == 0 {
+        println!("");
+        println!("This project has no partitions and will not do anything when served!");
+        println!("This is usually a mistake -- edit rojo.json!");
+        println!("");
+    }
+
+    lazy_static! {
+        static ref PLUGIN_CHAIN: PluginChain = PluginChain::new(vec![
+            Box::new(ScriptPlugin::new()),
+            Box::new(JsonModelPlugin::new()),
+            Box::new(DefaultPlugin::new()),
+        ]);
+    }
+
+    let vfs = {
+        let mut vfs = VfsSession::new(&PLUGIN_CHAIN);
+
+        for (name, project_partition) in &project.partitions {
+            let path = {
+                let given_path = Path::new(&project_partition.path);
+
+                if given_path.is_absolute() {
+                    given_path.to_path_buf()
+                } else {
+                    project_path.join(given_path)
+                }
+            };
+
+            vfs.insert_partition(name, path);
+        }
+
+        Arc::new(Mutex::new(vfs))
+    };
+
+    {
+        let vfs = vfs.clone();
+        thread::spawn(move || {
+            VfsWatcher::new(vfs).start();
+        });
+    }
+
+    let web_config = web::WebConfig {
+        verbose,
+        port: port.unwrap_or(project.serve_port),
+        server_id,
+    };
+
+    println!("Server listening on port {}", web_config.port);
+
+    web::start(web_config, project.clone(), &PLUGIN_CHAIN, vfs.clone());
+}

server/src/core.rs

@@ -0,0 +1 @@
+pub type Route = Vec<String>;

server/src/pathext.rs

@@ -31,9 +31,26 @@ fn test_path_to_route() {
         assert_eq!(path_to_route(root, value), result);
     }
 
-    t(Path::new("/a/b/c"), Path::new("/a/b/c/d"), Some(vec!["d".to_string()]));
+    t(
+        Path::new("/a/b/c"),
+        Path::new("/a/b/c/d"),
+        Some(vec!["d".to_string()]),
+    );
     t(Path::new("/a/b"), Path::new("a"), None);
-    t(Path::new("C:\\foo"), Path::new("C:\\foo\\bar\\baz"), Some(vec!["bar".to_string(), "baz".to_string()]));
+}
+
+#[test]
+#[cfg(target_os = "windows")]
+fn test_path_to_route_windows() {
+    fn t(root: &Path, value: &Path, result: Option<Vec<String>>) {
+        assert_eq!(path_to_route(root, value), result);
+    }
+
+    t(
+        Path::new("C:\\foo"),
+        Path::new("C:\\foo\\bar\\baz"),
+        Some(vec!["bar".to_string(), "baz".to_string()]),
+    );
 }
 
 /// Turns the path into an absolute one, using the current working directory if

server/src/plugin.rs

@@ -0,0 +1,60 @@
+use rbx::RbxInstance;
+use vfs::VfsItem;
+use core::Route;
+
+pub enum TransformFileResult {
+    Value(Option<RbxInstance>),
+    Pass,
+
+    // TODO: Error case
+}
+
+pub enum FileChangeResult {
+    MarkChanged(Option<Vec<Route>>),
+    Pass,
+}
+
+pub trait Plugin {
+    /// Invoked when a file is read from the filesystem and needs to be turned
+    /// into a Roblox instance.
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult;
+
+    /// Invoked when a file changes on the filesystem. The result defines what
+    /// routes are marked as needing to be refreshed.
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult;
+}
+
+/// A set of plugins that are composed in order.
+pub struct PluginChain {
+    plugins: Vec<Box<Plugin + Send + Sync>>,
+}
+
+impl PluginChain {
+    pub fn new(plugins: Vec<Box<Plugin + Send + Sync>>) -> PluginChain {
+        PluginChain {
+            plugins,
+        }
+    }
+
+    pub fn transform_file(&self, vfs_item: &VfsItem) -> Option<RbxInstance> {
+        for plugin in &self.plugins {
+            match plugin.transform_file(self, vfs_item) {
+                TransformFileResult::Value(rbx_item) => return rbx_item,
+                TransformFileResult::Pass => {},
+            }
+        }
+
+        None
+    }
+
+    pub fn handle_file_change(&self, route: &Route) -> Option<Vec<Route>> {
+        for plugin in &self.plugins {
+            match plugin.handle_file_change(route) {
+                FileChangeResult::MarkChanged(changes) => return changes,
+                FileChangeResult::Pass => {},
+            }
+        }
+
+        None
+    }
+}

server/src/plugins/default_plugin.rs

@@ -0,0 +1,63 @@
+use std::collections::HashMap;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
+use rbx::{RbxInstance, RbxValue};
+use vfs::VfsItem;
+
+/// A plugin with simple transforms:
+/// * Directories become Folder instances
+/// * Files become StringValue objects with 'Value' as their contents
+pub struct DefaultPlugin;
+
+impl DefaultPlugin {
+    pub fn new() -> DefaultPlugin {
+        DefaultPlugin
+    }
+}
+
+impl Plugin for DefaultPlugin {
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let mut properties = HashMap::new();
+
+                properties.insert("Value".to_string(), RbxValue::String {
+                    value: contents.clone(),
+                });
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: vfs_item.name().clone(),
+                    class_name: "StringValue".to_string(),
+                    children: Vec::new(),
+                    properties,
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+            &VfsItem::Dir { ref children, .. } => {
+                let mut rbx_children = Vec::new();
+
+                for (_, child_item) in children {
+                    match plugins.transform_file(child_item) {
+                        Some(rbx_item) => {
+                            rbx_children.push(rbx_item);
+                        },
+                        _ => {},
+                    }
+                }
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: vfs_item.name().clone(),
+                    class_name: "*".to_string(),
+                    children: rbx_children,
+                    properties: HashMap::new(),
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+        }
+    }
+
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult {
+        FileChangeResult::MarkChanged(Some(vec![route.clone()]))
+    }
+}

server/src/plugins/json_model_plugin.rs

@@ -0,0 +1,99 @@
+use regex::Regex;
+use serde_json;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
+use rbx::RbxInstance;
+use vfs::VfsItem;
+
+lazy_static! {
+    static ref JSON_MODEL_PATTERN: Regex = Regex::new(r"^(.*?)\.model\.json$").unwrap();
+}
+
+static JSON_MODEL_INIT: &'static str = "init.model.json";
+
+pub struct JsonModelPlugin;
+
+impl JsonModelPlugin {
+    pub fn new() -> JsonModelPlugin {
+        JsonModelPlugin
+    }
+}
+
+impl Plugin for JsonModelPlugin {
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let rbx_name = match JSON_MODEL_PATTERN.captures(vfs_item.name()) {
+                    Some(captures) => captures.get(1).unwrap().as_str().to_string(),
+                    None => return TransformFileResult::Pass,
+                };
+
+                let mut rbx_item: RbxInstance = match serde_json::from_str(contents) {
+                    Ok(v) => v,
+                    Err(e) => {
+                        eprintln!("Unable to parse JSON Model File named {}: {}", vfs_item.name(), e);
+
+                        return TransformFileResult::Pass; // This should be an error in the future!
+                    },
+                };
+
+                rbx_item.route = Some(vfs_item.route().to_vec());
+                rbx_item.name = rbx_name;
+
+                TransformFileResult::Value(Some(rbx_item))
+            },
+            &VfsItem::Dir { ref children, .. } => {
+                let init_item = match children.get(JSON_MODEL_INIT) {
+                    Some(v) => v,
+                    None => return TransformFileResult::Pass,
+                };
+
+                let mut rbx_item = match self.transform_file(plugins, init_item) {
+                    TransformFileResult::Value(Some(item)) => item,
+                    TransformFileResult::Value(None) | TransformFileResult::Pass => {
+                        eprintln!("Inconsistency detected in JsonModelPlugin!");
+                        return TransformFileResult::Pass;
+                    },
+                };
+
+                rbx_item.name.clear();
+                rbx_item.name.push_str(vfs_item.name());
+                rbx_item.route = Some(vfs_item.route().to_vec());
+
+                for (child_name, child_item) in children {
+                    if child_name == init_item.name() {
+                        continue;
+                    }
+
+                    match plugins.transform_file(child_item) {
+                        Some(child_rbx_item) => {
+                            rbx_item.children.push(child_rbx_item);
+                        },
+                        _ => {},
+                    }
+                }
+
+                TransformFileResult::Value(Some(rbx_item))
+            },
+        }
+    }
+
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult {
+        let leaf = match route.last() {
+            Some(v) => v,
+            None => return FileChangeResult::Pass,
+        };
+
+        let is_init = leaf == JSON_MODEL_INIT;
+
+        if is_init {
+            let mut changed = route.clone();
+            changed.pop();
+
+            FileChangeResult::MarkChanged(Some(vec![changed]))
+        } else {
+            FileChangeResult::Pass
+        }
+    }
+}

server/src/plugins/mod.rs

@@ -0,0 +1,7 @@
+mod default_plugin;
+mod script_plugin;
+mod json_model_plugin;
+
+pub use self::default_plugin::*;
+pub use self::script_plugin::*;
+pub use self::json_model_plugin::*;

server/src/plugins/script_plugin.rs

@@ -0,0 +1,121 @@
+use std::collections::HashMap;
+
+use regex::Regex;
+
+use core::Route;
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
+use rbx::{RbxInstance, RbxValue};
+use vfs::VfsItem;
+
+lazy_static! {
+    static ref SERVER_PATTERN: Regex = Regex::new(r"^(.*?)\.server\.lua$").unwrap();
+    static ref CLIENT_PATTERN: Regex = Regex::new(r"^(.*?)\.client\.lua$").unwrap();
+    static ref MODULE_PATTERN: Regex = Regex::new(r"^(.*?)\.lua$").unwrap();
+}
+
+static SERVER_INIT: &'static str = "init.server.lua";
+static CLIENT_INIT: &'static str = "init.client.lua";
+static MODULE_INIT: &'static str = "init.lua";
+
+pub struct ScriptPlugin;
+
+impl ScriptPlugin {
+    pub fn new() -> ScriptPlugin {
+        ScriptPlugin
+    }
+}
+
+impl Plugin for ScriptPlugin {
+    fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult {
+        match vfs_item {
+            &VfsItem::File { ref contents, .. } => {
+                let name = vfs_item.name();
+
+                let (class_name, rbx_name) = {
+                    if let Some(captures) = SERVER_PATTERN.captures(name) {
+                        ("Script".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else if let Some(captures) = CLIENT_PATTERN.captures(name) {
+                        ("LocalScript".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else if let Some(captures) = MODULE_PATTERN.captures(name) {
+                        ("ModuleScript".to_string(), captures.get(1).unwrap().as_str().to_string())
+                    } else {
+                        return TransformFileResult::Pass;
+                    }
+                };
+
+                let mut properties = HashMap::new();
+
+                properties.insert("Source".to_string(), RbxValue::String {
+                    value: contents.clone(),
+                });
+
+                TransformFileResult::Value(Some(RbxInstance {
+                    name: rbx_name,
+                    class_name: class_name,
+                    children: Vec::new(),
+                    properties,
+                    route: Some(vfs_item.route().to_vec()),
+                }))
+            },
+            &VfsItem::Dir { ref children, .. } => {
+                let init_item = {
+                    let maybe_item = children.get(SERVER_INIT)
+                        .or(children.get(CLIENT_INIT))
+                        .or(children.get(MODULE_INIT));
+
+                    match maybe_item {
+                        Some(v) => v,
+                        None => return TransformFileResult::Pass,
+                    }
+                };
+
+                let mut rbx_item = match self.transform_file(plugins, init_item) {
+                    TransformFileResult::Value(Some(item)) => item,
+                    _ => {
+                        eprintln!("Inconsistency detected in ScriptPlugin!");
+                        return TransformFileResult::Pass;
+                    },
+                };
+
+                rbx_item.name.clear();
+                rbx_item.name.push_str(vfs_item.name());
+                rbx_item.route = Some(vfs_item.route().to_vec());
+
+                for (child_name, child_item) in children {
+                    if child_name == init_item.name() {
+                        continue;
+                    }
+
+                    match plugins.transform_file(child_item) {
+                        Some(child_rbx_item) => {
+                            rbx_item.children.push(child_rbx_item);
+                        },
+                        _ => {},
+                    }
+                }
+
+                TransformFileResult::Value(Some(rbx_item))
+            },
+        }
+    }
+
+    fn handle_file_change(&self, route: &Route) -> FileChangeResult {
+        let leaf = match route.last() {
+            Some(v) => v,
+            None => return FileChangeResult::Pass,
+        };
+
+        let is_init = leaf == SERVER_INIT
+            || leaf == CLIENT_INIT
+            || leaf == MODULE_INIT;
+
+        if is_init {
+            let mut changed = route.clone();
+            changed.pop();
+
+            FileChangeResult::MarkChanged(Some(vec![changed]))
+        } else {
+            FileChangeResult::Pass
+        }
+    }
+}

server/src/project.rs

@@ -13,7 +13,7 @@ pub enum ProjectLoadError {
     DidNotExist,
     FailedToOpen,
     FailedToRead,
-    Invalid,
+    InvalidJson(serde_json::Error),
 }
 
 #[derive(Debug)]
@@ -44,10 +44,19 @@ impl fmt::Display for ProjectInitError {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct ProjectPartition {
+    /// A slash-separated path to a file or folder, relative to the project's
+    /// directory.
     pub path: String,
+
+    /// A dot-separated route to a Roblox instance, relative to game.
     pub target: String,
 }
 
+/// Represents a project configured by a user for use with Rojo. Holds anything
+/// that can be configured with `rojo.json`.
+///
+/// In the future, this object will hold dependency information and other handy
+/// configurables
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(default, rename_all = "camelCase")]
 pub struct Project {
@@ -57,6 +66,7 @@ pub struct Project {
 }
 
 impl Project {
+    /// Creates a new empty Project object with the given name.
     pub fn new<T: Into<String>>(name: T) -> Project {
         Project {
             name: name.into(),
@@ -64,10 +74,12 @@ impl Project {
         }
     }
 
+    /// Initializes a new project inside the given folder path.
     pub fn init<T: AsRef<Path>>(location: T) -> Result<Project, ProjectInitError> {
         let location = location.as_ref();
         let package_path = location.join(PROJECT_FILENAME);
 
+        // We abort if the project file already exists.
         match fs::metadata(&package_path) {
             Ok(_) => return Err(ProjectInitError::AlreadyExists),
             Err(_) => {},
@@ -78,11 +90,14 @@ impl Project {
             Err(_) => return Err(ProjectInitError::FailedToCreate),
         };
 
+        // Try to give the project a meaningful name.
+        // If we can't, we'll just fall back to a default.
         let name = match location.file_name() {
             Some(v) => v.to_string_lossy().into_owned(),
             None => "new-project".to_string(),
         };
 
+        // Configure the project with all of the values we know so far.
         let project = Project::new(name);
         let serialized = serde_json::to_string_pretty(&project).unwrap();
 
@@ -94,6 +109,8 @@ impl Project {
         Ok(project)
     }
 
+    /// Attempts to load a project from the file named PROJECT_FILENAME from the
+    /// given folder.
     pub fn load<T: AsRef<Path>>(location: T) -> Result<Project, ProjectLoadError> {
         let package_path = location.as_ref().join(Path::new(PROJECT_FILENAME));
 
@@ -116,10 +133,11 @@ impl Project {
 
         match serde_json::from_str(&contents) {
             Ok(v) => Ok(v),
-            Err(_) => return Err(ProjectLoadError::Invalid),
+            Err(e) => return Err(ProjectLoadError::InvalidJson(e)),
         }
     }
 
+    /// Saves the given project file to the given folder with the appropriate name.
     pub fn save<T: AsRef<Path>>(&self, location: T) -> Result<(), ProjectSaveError> {
         let package_path = location.as_ref().join(Path::new(PROJECT_FILENAME));
 
@@ -139,7 +157,7 @@ impl Project {
 impl Default for Project {
     fn default() -> Project {
         Project {
-            name: "some-project".to_string(),
+            name: "new-project".to_string(),
             serve_port: 8000,
             partitions: HashMap::new(),
         }

server/src/rbx.rs

@@ -0,0 +1,38 @@
+use std::collections::HashMap;
+
+/// Represents data about a Roblox instance
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub struct RbxInstance {
+    pub name: String,
+    pub class_name: String,
+
+    #[serde(default = "Vec::new")]
+    pub children: Vec<RbxInstance>,
+
+    #[serde(default = "HashMap::new")]
+    pub properties: HashMap<String, RbxValue>,
+
+    /// The route that this instance was generated from, if there was one.
+    pub route: Option<Vec<String>>,
+}
+
+/// Any kind value that can be used by Roblox
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "PascalCase", tag = "Type")]
+pub enum RbxValue {
+    #[serde(rename_all = "PascalCase")]
+    String {
+        value: String,
+    },
+    #[serde(rename_all = "PascalCase")]
+    Bool {
+        value: bool,
+    },
+    #[serde(rename_all = "PascalCase")]
+    Number {
+        value: f64,
+    },
+
+    // TODO: Compound types like Vector3
+}

server/src/vfs/mod.rs

@@ -0,0 +1,7 @@
+mod vfs_session;
+mod vfs_item;
+mod vfs_watcher;
+
+pub use self::vfs_session::*;
+pub use self::vfs_item::*;
+pub use self::vfs_watcher::*;

server/src/vfs/vfs_item.rs

@@ -0,0 +1,36 @@
+use std::collections::HashMap;
+
+/// A VfsItem represents either a file or directory as it came from the filesystem.
+///
+/// The interface here is intentionally simplified to make it easier to traverse
+/// files that have been read into memory.
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase", tag = "type")]
+pub enum VfsItem {
+    File {
+        route: Vec<String>,
+        file_name: String,
+        contents: String,
+    },
+    Dir {
+        route: Vec<String>,
+        file_name: String,
+        children: HashMap<String, VfsItem>,
+    },
+}
+
+impl VfsItem {
+    pub fn name(&self) -> &String {
+        match self {
+            &VfsItem::File { ref file_name , .. } => file_name,
+            &VfsItem::Dir { ref file_name , .. } => file_name,
+        }
+    }
+
+    pub fn route(&self) -> &[String] {
+        match self {
+            &VfsItem::File { ref route, .. } => route,
+            &VfsItem::Dir { ref route, .. } => route,
+        }
+    }
+}

server/src/vfs/vfs_session.rs

@@ -1,30 +1,30 @@
-use std::borrow::Borrow;
 use std::collections::HashMap;
 use std::fs::{self, File};
 use std::io::Read;
 use std::path::{Path, PathBuf};
 use std::time::Instant;
 
-use core::Config;
+use plugin::PluginChain;
+use vfs::VfsItem;
 
 /// Represents a virtual layer over multiple parts of the filesystem.
 ///
 /// Paths in this system are represented as slices of strings, and are always
 /// relative to a partition, which is an absolute path into the real filesystem.
-pub struct Vfs {
+pub struct VfsSession {
     /// Contains all of the partitions mounted by the Vfs.
     ///
     /// These must be absolute paths!
-    pub partitions: HashMap<String, PathBuf>,
-
-    /// When the Vfs was initialized; used for change tracking.
-    pub start_time: Instant,
+    partitions: HashMap<String, PathBuf>,
 
     /// A chronologically-sorted list of routes that changed since the Vfs was
     /// created, along with a timestamp denoting when.
-    pub change_history: Vec<VfsChange>,
+    change_history: Vec<VfsChange>,
 
-    config: Config,
+    /// When the Vfs was initialized; used for change tracking.
+    start_time: Instant,
+
+    plugin_chain: &'static PluginChain,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
@@ -34,26 +34,31 @@ pub struct VfsChange {
     route: Vec<String>,
 }
 
-#[derive(Debug, Serialize, Deserialize)]
-#[serde(rename_all = "camelCase", tag = "type")]
-pub enum VfsItem {
-    File { contents: String },
-    Dir { children: HashMap<String, VfsItem> },
-}
-
-impl Vfs {
-    pub fn new(config: Config) -> Vfs {
-        Vfs {
+impl VfsSession {
+    pub fn new(plugin_chain: &'static PluginChain) -> VfsSession {
+        VfsSession {
             partitions: HashMap::new(),
             start_time: Instant::now(),
             change_history: Vec::new(),
-            config,
+            plugin_chain,
         }
     }
 
-    fn route_to_path<R: Borrow<str>>(&self, route: &[R]) -> Option<PathBuf> {
+    pub fn get_partitions(&self) -> &HashMap<String, PathBuf> {
+        &self.partitions
+    }
+
+    pub fn insert_partition<P: Into<PathBuf>>(&mut self, name: &str, path: P) {
+        let path = path.into();
+
+        assert!(path.is_absolute());
+
+        self.partitions.insert(name.to_string(), path.into());
+    }
+
+    fn route_to_path(&self, route: &[String]) -> Option<PathBuf> {
         let (partition_name, rest) = match route.split_first() {
-            Some((first, rest)) => (first.borrow(), rest),
+            Some((first, rest)) => (first, rest),
             None => return None,
         };
 
@@ -62,7 +67,12 @@ impl Vfs {
             None => return None,
         };
 
-        let full_path = {
+        // It's possible that the partition points to a file if `rest` is empty.
+        // Joining "" onto a path will put a trailing slash on, which causes
+        // file reads to fail.
+        let full_path = if rest.is_empty() {
+            partition.clone()
+        } else {
             let joined = rest.join("/");
             let relative = Path::new(&joined);
 
@@ -72,7 +82,8 @@ impl Vfs {
         Some(full_path)
     }
 
-    fn read_dir<P: AsRef<Path>>(&self, path: P) -> Result<VfsItem, ()> {
+    fn read_dir<P: AsRef<Path>>(&self, route: &[String], path: P) -> Result<VfsItem, ()> {
+        let path = path.as_ref();
         let reader = match fs::read_dir(path) {
             Ok(v) => v,
             Err(_) => return Err(()),
@@ -87,23 +98,30 @@ impl Vfs {
             };
 
             let path = entry.path();
+            let name = path.file_name().unwrap().to_string_lossy().into_owned();
 
-            match self.read_path(&path) {
+            let mut child_route = route.iter().cloned().collect::<Vec<_>>();
+            child_route.push(name.clone());
+
+            match self.read_path(&child_route, &path) {
                 Ok(child_item) => {
-                    let name = path.file_name().unwrap().to_string_lossy().into_owned();
-
                     children.insert(name, child_item);
                 },
                 Err(_) => {},
             }
         }
 
+        let file_name = path.file_name().unwrap().to_string_lossy().into_owned();
+
         Ok(VfsItem::Dir {
+            route: route.iter().cloned().collect::<Vec<_>>(),
+            file_name,
             children,
         })
     }
 
-    fn read_file<P: AsRef<Path>>(&self, path: P) -> Result<VfsItem, ()> {
+    fn read_file<P: AsRef<Path>>(&self, route: &[String], path: P) -> Result<VfsItem, ()> {
+        let path = path.as_ref();
         let mut file = match File::open(path) {
             Ok(v) => v,
             Err(_) => return Err(()),
@@ -116,12 +134,16 @@ impl Vfs {
             Err(_) => return Err(()),
         }
 
+        let file_name = path.file_name().unwrap().to_string_lossy().into_owned();
+
         Ok(VfsItem::File {
+            route: route.iter().cloned().collect::<Vec<_>>(),
+            file_name,
             contents,
         })
     }
 
-    fn read_path<P: AsRef<Path>>(&self, path: P) -> Result<VfsItem, ()> {
+    fn read_path<P: AsRef<Path>>(&self, route: &[String], path: P) -> Result<VfsItem, ()> {
         let path = path.as_ref();
 
         let metadata = match fs::metadata(path) {
@@ -130,31 +152,38 @@ impl Vfs {
         };
 
         if metadata.is_dir() {
-            self.read_dir(path)
+            self.read_dir(route, path)
         } else if metadata.is_file() {
-            self.read_file(path)
+            self.read_file(route, path)
         } else {
             Err(())
         }
     }
 
+    /// Get the current time, used for logging timestamps for file changes.
     pub fn current_time(&self) -> f64 {
         let elapsed = self.start_time.elapsed();
 
         elapsed.as_secs() as f64 + elapsed.subsec_nanos() as f64 * 1e-9
     }
 
+    /// Register a new change to the filesystem at the given timestamp and VFS
+    /// route.
     pub fn add_change(&mut self, timestamp: f64, route: Vec<String>) {
-        if self.config.verbose {
-            println!("Added change {:?}", route);
+        match self.plugin_chain.handle_file_change(&route) {
+            Some(routes) => {
+                for route in routes {
+                    self.change_history.push(VfsChange {
+                        timestamp,
+                        route,
+                    });
+                }
+            },
+            None => {}
         }
-
-        self.change_history.push(VfsChange {
-            timestamp,
-            route,
-        });
     }
 
+    /// Collect a list of changes that occured since the given timestamp.
     pub fn changes_since(&self, timestamp: f64) -> &[VfsChange] {
         let mut marker: Option<usize> = None;
 
@@ -173,18 +202,19 @@ impl Vfs {
         }
     }
 
-    pub fn read<R: Borrow<str>>(&self, route: &[R]) -> Result<VfsItem, ()> {
+    /// Read an item from the filesystem using the given VFS route.
+    pub fn read(&self, route: &[String]) -> Result<VfsItem, ()> {
         match self.route_to_path(route) {
-            Some(path) => self.read_path(&path),
+            Some(path) => self.read_path(route, &path),
             None => Err(()),
         }
     }
 
-    pub fn write<R: Borrow<str>>(&self, _route: &[R], _item: VfsItem) -> Result<(), ()> {
+    pub fn write(&self, _route: &[String], _item: VfsItem) -> Result<(), ()> {
         unimplemented!()
     }
 
-    pub fn delete<R: Borrow<str>>(&self, _route: &[R]) -> Result<(), ()> {
+    pub fn delete(&self, _route: &[String]) -> Result<(), ()> {
         unimplemented!()
     }
 }

server/src/vfs/vfs_watcher.rs

@@ -0,0 +1,108 @@
+use std::path::PathBuf;
+use std::sync::{mpsc, Arc, Mutex};
+use std::thread;
+use std::time::Duration;
+
+use notify::{DebouncedEvent, RecommendedWatcher, RecursiveMode, Watcher};
+
+use pathext::path_to_route;
+use vfs::VfsSession;
+
+/// An object that registers watchers on the real filesystem and relays those
+/// changes to the virtual filesystem layer.
+pub struct VfsWatcher {
+    vfs: Arc<Mutex<VfsSession>>,
+}
+
+impl VfsWatcher {
+    pub fn new(vfs: Arc<Mutex<VfsSession>>) -> VfsWatcher {
+        VfsWatcher {
+            vfs,
+        }
+    }
+
+    fn start_watcher(
+        vfs: Arc<Mutex<VfsSession>>,
+        rx: mpsc::Receiver<DebouncedEvent>,
+        partition_name: String,
+        root_path: PathBuf,
+    ) {
+        loop {
+            let event = rx.recv().unwrap();
+
+            let mut vfs = vfs.lock().unwrap();
+            let current_time = vfs.current_time();
+
+            match event {
+                DebouncedEvent::Write(ref change_path) |
+                DebouncedEvent::Create(ref change_path) |
+                DebouncedEvent::Remove(ref change_path) => {
+                    if let Some(mut route) = path_to_route(&root_path, change_path) {
+                        route.insert(0, partition_name.clone());
+
+                        vfs.add_change(current_time, route);
+                    } else {
+                        eprintln!("Failed to get route from {}", change_path.display());
+                    }
+                },
+                DebouncedEvent::Rename(ref from_change, ref to_change) => {
+                    if let Some(mut route) = path_to_route(&root_path, from_change) {
+                        route.insert(0, partition_name.clone());
+
+                        vfs.add_change(current_time, route);
+                    } else {
+                        eprintln!("Failed to get route from {}", from_change.display());
+                    }
+
+                    if let Some(mut route) = path_to_route(&root_path, to_change) {
+                        route.insert(0, partition_name.clone());
+
+                        vfs.add_change(current_time, route);
+                    } else {
+                        eprintln!("Failed to get route from {}", to_change.display());
+                    }
+                },
+                _ => {},
+            }
+        }
+    }
+
+    pub fn start(self) {
+        let mut watchers = Vec::new();
+
+        // Create an extra scope so that `vfs` gets dropped and unlocked
+        {
+            let vfs = self.vfs.lock().unwrap();
+
+            for (ref partition_name, ref root_path) in vfs.get_partitions() {
+                let (tx, rx) = mpsc::channel();
+
+                let mut watcher: RecommendedWatcher = Watcher::new(tx, Duration::from_millis(200))
+                    .expect("Unable to create watcher! This is a bug in Rojo.");
+
+                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());
+                    },
+                }
+
+                watchers.push(watcher);
+
+                {
+                    let partition_name = partition_name.to_string();
+                    let root_path = root_path.to_path_buf();
+                    let vfs = self.vfs.clone();
+
+                    thread::spawn(move || {
+                        Self::start_watcher(vfs, rx, partition_name, root_path);
+                    });
+                }
+            }
+        }
+
+        loop {
+            thread::park();
+        }
+    }
+}

server/src/web.rs

@@ -0,0 +1,225 @@
+use std::io::Read;
+use std::sync::{Arc, Mutex};
+
+use rouille;
+use serde;
+use serde_json;
+
+use project::Project;
+use vfs::{VfsSession, VfsChange};
+use rbx::RbxInstance;
+use plugin::PluginChain;
+
+static MAX_BODY_SIZE: usize = 25 * 1024 * 1024; // 25 MiB
+
+/// The set of configuration the web server needs to start.
+pub struct WebConfig {
+    pub port: u64,
+    pub verbose: bool,
+    pub server_id: u64,
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct ServerInfo<'a> {
+    server_version: &'static str,
+    protocol_version: u64,
+    server_id: &'a str,
+    project: &'a Project,
+    current_time: f64,
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct ReadResult<'a> {
+    items: Vec<Option<RbxInstance>>,
+    server_id: &'a str,
+    current_time: f64,
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct ChangesResult<'a> {
+    changes: &'a [VfsChange],
+    server_id: &'a str,
+    current_time: f64,
+}
+
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct WriteSpecifier {
+    route: String,
+    item: RbxInstance,
+}
+
+fn json<T: serde::Serialize>(value: T) -> rouille::Response {
+    let data = serde_json::to_string(&value).unwrap();
+    rouille::Response::from_data("application/json", data)
+}
+
+/// Pulls text that may be JSON out of a Rouille Request object.
+///
+/// Doesn't do any actual parsing -- all this method does is verify the content
+/// type of the request and read the request's body.
+fn read_json_text(request: &rouille::Request) -> Option<String> {
+    // Bail out if the request body isn't marked as JSON
+    match request.header("Content-Type") {
+        Some(header) => if !header.starts_with("application/json") {
+            return None;
+        },
+        None => return None,
+    }
+
+    let body = match request.data() {
+        Some(v) => v,
+        None => return None,
+    };
+
+    // Allocate a buffer and read up to MAX_BODY_SIZE+1 bytes into it.
+    let mut out = Vec::new();
+    match body.take(MAX_BODY_SIZE.saturating_add(1) as u64).read_to_end(&mut out) {
+        Ok(_) => {},
+        Err(_) => return None,
+    }
+
+    // If the body was too big (MAX_BODY_SIZE+1), we abort instead of trying to
+    // process it.
+    if out.len() > MAX_BODY_SIZE {
+        return None;
+    }
+
+    let parsed = match String::from_utf8(out) {
+        Ok(v) => v,
+        Err(_) => return None,
+    };
+
+    Some(parsed)
+}
+
+/// Reads the body out of a Rouille Request and attempts to turn it into JSON.
+fn read_json<T>(request: &rouille::Request) -> Option<T>
+where
+    T: serde::de::DeserializeOwned,
+{
+    let body = match read_json_text(&request) {
+        Some(v) => v,
+        None => return None,
+    };
+
+    let parsed = match serde_json::from_str(&body) {
+        Ok(v) => v,
+        Err(_) => return None,
+    };
+
+    // TODO: Change return type to some sort of Result
+
+    Some(parsed)
+}
+
+/// Start the Rojo web server and park our current thread.
+pub fn start(config: WebConfig, project: Project, plugin_chain: &'static PluginChain, vfs: Arc<Mutex<VfsSession>>) {
+    let address = format!("localhost:{}", config.port);
+
+    let server_id = config.server_id.to_string();
+
+    rouille::start_server(address, move |request| {
+        router!(request,
+            (GET) (/) => {
+                // Get a summary of information about the server.
+
+                let current_time = {
+                    let vfs = vfs.lock().unwrap();
+
+                    vfs.current_time()
+                };
+
+                json(ServerInfo {
+                    server_version: env!("CARGO_PKG_VERSION"),
+                    protocol_version: 1,
+                    server_id: &server_id,
+                    project: &project,
+                    current_time,
+                })
+            },
+
+            (GET) (/changes/{ last_time: f64 }) => {
+                // Get the list of changes since the given time.
+
+                let vfs = vfs.lock().unwrap();
+                let current_time = vfs.current_time();
+                let changes = vfs.changes_since(last_time);
+
+                json(ChangesResult {
+                    changes,
+                    server_id: &server_id,
+                    current_time,
+                })
+            },
+
+            (POST) (/read) => {
+                // Read some instances from the server according to a JSON
+                // format body.
+
+                let read_request: Vec<Vec<String>> = match read_json(&request) {
+                    Some(v) => v,
+                    None => return rouille::Response::empty_400(),
+                };
+
+                // Read the files off of the filesystem that the client
+                // requested.
+                let (items, current_time) = {
+                    let vfs = vfs.lock().unwrap();
+
+                    let current_time = vfs.current_time();
+
+                    let mut items = Vec::new();
+
+                    for route in &read_request {
+                        match vfs.read(&route) {
+                            Ok(v) => items.push(Some(v)),
+                            Err(_) => items.push(None),
+                        }
+                    }
+
+                    (items, current_time)
+                };
+
+                // Transform all of our VfsItem objects into Roblox instances
+                // the client can use.
+                let rbx_items = items
+                    .iter()
+                    .map(|item| {
+                        match *item {
+                            Some(ref item) => plugin_chain.transform_file(item),
+                            None => None,
+                        }
+                    })
+                    .collect::<Vec<_>>();
+
+                if config.verbose {
+                    println!("Got read request: {:?}", read_request);
+                    println!("Responding with:\n\t{:?}", rbx_items);
+                }
+
+                json(ReadResult {
+                    server_id: &server_id,
+                    items: rbx_items,
+                    current_time,
+                })
+            },
+
+            (POST) (/write) => {
+                // Not yet implemented.
+
+                let _write_request: Vec<WriteSpecifier> = match read_json(&request) {
+                    Some(v) => v,
+                    None => return rouille::Response::empty_400(),
+                };
+
+                rouille::Response::empty_404()
+            },
+
+            _ => rouille::Response::empty_404()
+        )
+    });
+}

src/bin.rs

@@ -1,184 +0,0 @@
-#[macro_use]
-extern crate serde_derive;
-
-#[macro_use]
-extern crate rouille;
-
-#[macro_use]
-extern crate clap;
-
-extern crate notify;
-extern crate rand;
-extern crate serde;
-extern crate serde_json;
-
-pub mod web;
-pub mod core;
-pub mod project;
-pub mod pathext;
-pub mod vfs;
-pub mod vfs_watch;
-
-use std::path::{Path, PathBuf};
-use std::sync::{Arc, Mutex};
-use std::thread;
-
-use core::Config;
-use pathext::canonicalish;
-use project::Project;
-use vfs::Vfs;
-use vfs_watch::VfsWatcher;
-
-fn main() {
-    let matches = clap_app!(rojo =>
-        (version: env!("CARGO_PKG_VERSION"))
-        (author: env!("CARGO_PKG_AUTHORS"))
-        (about: env!("CARGO_PKG_DESCRIPTION"))
-
-        (@subcommand init =>
-            (about: "Creates a new Rojo project")
-            (@arg PATH: "Path to the place to create the project. Defaults to the current directory.")
-        )
-
-        (@subcommand serve =>
-            (about: "Serves the project's files for use with the Rojo Studio plugin.")
-            (@arg PROJECT: "Path to the project to serve. Defaults to the current directory.")
-            (@arg port: --port +takes_value "The port to listen on. Defaults to 8000.")
-        )
-
-        (@subcommand pack =>
-            (about: "Packs the project into a GUI installer bundle. NOT YET IMPLEMENTED!")
-            (@arg PROJECT: "Path to the project to pack. Defaults to the current directory.")
-        )
-
-        (@arg verbose: --verbose "Enable extended logging.")
-    ).get_matches();
-
-    let verbose = match matches.occurrences_of("verbose") {
-        0 => false,
-        _ => true,
-    };
-
-    let server_id = rand::random::<u64>();
-
-    if verbose {
-        println!("Server ID: {}", server_id);
-    }
-
-    match matches.subcommand() {
-        ("init", sub_matches) => {
-            let sub_matches = sub_matches.unwrap();
-            let project_path = Path::new(sub_matches.value_of("PATH").unwrap_or("."));
-            let full_path = canonicalish(project_path);
-
-            match Project::init(&full_path) {
-                Ok(_) => {
-                    println!("Created new empty project at {}", full_path.display());
-                },
-                Err(e) => {
-                    eprintln!("Failed to create new project.\n{}", e);
-                    std::process::exit(1);
-                },
-            }
-        },
-        ("serve", sub_matches) => {
-            let sub_matches = sub_matches.unwrap();
-
-            let project_path = match sub_matches.value_of("PROJECT") {
-                Some(v) => PathBuf::from(v),
-                None => std::env::current_dir().unwrap(),
-            };
-
-            if verbose {
-                println!("Attempting to locate project at {}", project_path.display());
-            }
-
-            let project = match Project::load(&project_path) {
-                Ok(v) => {
-                    println!("Using project from {}", project_path.display());
-                    v
-                },
-                Err(_) => {
-                    println!("Using default project...");
-                    Project::default()
-                },
-            };
-
-            let port = {
-                match sub_matches.value_of("port") {
-                    Some(source) => match source.parse::<u64>() {
-                        Ok(value) => value,
-                        Err(_) => {
-                            eprintln!("Invalid port '{}'", source);
-                            std::process::exit(1);
-                        },
-                    },
-                    None => project.serve_port,
-                }
-            };
-
-            let config = Config {
-                port,
-                verbose,
-                server_id,
-            };
-
-            if verbose {
-                println!("Loading VFS...");
-            }
-
-            let vfs = {
-                let mut vfs = Vfs::new(config.clone());
-
-                for (name, project_partition) in &project.partitions {
-                    let path = {
-                        let given_path = Path::new(&project_partition.path);
-
-                        if given_path.is_absolute() {
-                            given_path.to_path_buf()
-                        } else {
-                            project_path.join(given_path)
-                        }
-                    };
-
-                    if verbose {
-                        println!(
-                            "Partition '{}': {} @ {}",
-                            name,
-                            project_partition.target,
-                            project_partition.path
-                        );
-                    }
-
-                    vfs.partitions.insert(name.clone(), path);
-                }
-
-                Arc::new(Mutex::new(vfs))
-            };
-
-            {
-                let vfs = vfs.clone();
-                let config = config.clone();
-
-                thread::spawn(move || {
-                    VfsWatcher::new(config, vfs).start();
-                });
-            }
-
-            web::start(config.clone(), project.clone(), vfs.clone());
-
-            println!("Server listening on port {}", port);
-
-            loop {}
-        },
-        ("pack", _) => {
-            eprintln!("'rojo pack' is not yet implemented!");
-            std::process::exit(1);
-        },
-        _ => {
-            eprintln!("Please specify a subcommand!");
-            eprintln!("Try 'rojo help' for information.");
-            std::process::exit(1);
-        },
-    }
-}

src/core.rs

@@ -1,6 +0,0 @@
-#[derive(Debug, Clone)]
-pub struct Config {
-    pub port: u64,
-    pub verbose: bool,
-    pub server_id: u64,
-}

src/vfs_watch.rs

@@ -1,97 +0,0 @@
-use std::sync::{mpsc, Arc, Mutex};
-use std::thread;
-use std::time::Duration;
-
-use notify::{DebouncedEvent, RecommendedWatcher, RecursiveMode, Watcher};
-
-use vfs::Vfs;
-use pathext::path_to_route;
-use core::Config;
-
-pub struct VfsWatcher {
-    vfs: Arc<Mutex<Vfs>>,
-    watchers: Vec<RecommendedWatcher>,
-    config: Config,
-}
-
-impl VfsWatcher {
-    pub fn new(config: Config, vfs: Arc<Mutex<Vfs>>) -> VfsWatcher {
-        VfsWatcher {
-            vfs,
-            watchers: Vec::new(),
-            config,
-        }
-    }
-
-    pub fn start(mut self) {
-        {
-            let outer_vfs = self.vfs.lock().unwrap();
-
-            for (partition_name, root_path) in &outer_vfs.partitions {
-                let (tx, rx) = mpsc::channel();
-                let partition_name = partition_name.clone();
-                let root_path = root_path.clone();
-
-                let mut watcher: RecommendedWatcher = Watcher::new(tx, Duration::from_secs(1))
-                    .expect("Unable to create watcher!");
-
-                watcher
-                    .watch(&root_path, RecursiveMode::Recursive)
-                    .expect("Unable to watch path!");
-
-                self.watchers.push(watcher);
-
-                {
-                    let vfs = self.vfs.clone();
-                    let config = self.config.clone();
-
-                    thread::spawn(move || {
-                        loop {
-                            let event = rx.recv().unwrap();
-                            let mut vfs = vfs.lock().unwrap();
-                            let current_time = vfs.current_time();
-
-                            if config.verbose {
-                                println!("FS event {:?}", event);
-                            }
-
-                            match event {
-                                DebouncedEvent::Write(ref change_path) |
-                                DebouncedEvent::Create(ref change_path) |
-                                DebouncedEvent::Remove(ref change_path) => {
-                                    if let Some(mut route) = path_to_route(&root_path, change_path) {
-                                        route.insert(0, partition_name.clone());
-
-                                        vfs.add_change(current_time, route);
-                                    } else {
-                                        println!("Failed to get route from {}", change_path.display());
-                                    }
-                                },
-                                DebouncedEvent::Rename(ref from_change, ref to_change) => {
-                                    if let Some(mut route) = path_to_route(&root_path, from_change) {
-                                        route.insert(0, partition_name.clone());
-
-                                        vfs.add_change(current_time, route);
-                                    } else {
-                                        println!("Failed to get route from {}", from_change.display());
-                                    }
-
-                                    if let Some(mut route) = path_to_route(&root_path, to_change) {
-                                        route.insert(0, partition_name.clone());
-
-                                        vfs.add_change(current_time, route);
-                                    } else {
-                                        println!("Failed to get route from {}", to_change.display());
-                                    }
-                                },
-                                _ => {},
-                            }
-                        }
-                    });
-                }
-            }
-        }
-
-        loop {}
-    }
-}

src/web.rs

@@ -1,170 +0,0 @@
-use std::io::Read;
-use std::sync::{Arc, Mutex};
-use std::thread;
-
-use rouille;
-use serde;
-use serde_json;
-
-use core::Config;
-use project::Project;
-use vfs::{Vfs, VfsItem, VfsChange};
-
-static MAX_BODY_SIZE: usize = 25 * 1024 * 1025; // 25 MiB
-
-#[derive(Debug, Serialize)]
-#[serde(rename_all = "camelCase")]
-struct ServerInfo<'a> {
-    server_version: &'static str,
-    protocol_version: u64,
-    server_id: &'a str,
-    project: &'a Project,
-    current_time: f64,
-}
-
-#[derive(Debug, Serialize)]
-#[serde(rename_all = "camelCase")]
-struct ReadResult<'a> {
-    items: Vec<Option<VfsItem>>,
-    server_id: &'a str,
-    current_time: f64,
-}
-
-#[derive(Debug, Serialize)]
-#[serde(rename_all = "camelCase")]
-struct ChangesResult<'a> {
-    changes: &'a [VfsChange],
-    server_id: &'a str,
-    current_time: f64,
-}
-
-fn json<T: serde::Serialize>(value: T) -> rouille::Response {
-    let data = serde_json::to_string(&value).unwrap();
-    rouille::Response::from_data("application/json", data)
-}
-
-fn read_json_text(request: &rouille::Request) -> Option<String> {
-    match request.header("Content-Type") {
-        Some(header) => if !header.starts_with("application/json") {
-            return None;
-        },
-        None => return None,
-    }
-
-    let body = match request.data() {
-        Some(v) => v,
-        None => return None,
-    };
-
-    let mut out = Vec::new();
-    match body.take(MAX_BODY_SIZE.saturating_add(1) as u64)
-        .read_to_end(&mut out)
-    {
-        Ok(_) => {},
-        Err(_) => return None,
-    }
-
-    if out.len() > MAX_BODY_SIZE {
-        return None;
-    }
-
-    let parsed = match String::from_utf8(out) {
-        Ok(v) => v,
-        Err(_) => return None,
-    };
-
-    Some(parsed)
-}
-
-fn read_json<T>(request: &rouille::Request) -> Option<T>
-where
-    T: serde::de::DeserializeOwned,
-{
-    let body = match read_json_text(&request) {
-        Some(v) => v,
-        None => return None,
-    };
-
-    let parsed = match serde_json::from_str(&body) {
-        Ok(v) => v,
-        Err(_) => return None,
-    };
-
-    Some(parsed)
-}
-
-pub fn start(config: Config, project: Project, vfs: Arc<Mutex<Vfs>>) {
-    let address = format!("localhost:{}", config.port);
-
-    let server_id = config.server_id.to_string();
-
-    thread::spawn(move || {
-        rouille::start_server(address, move |request| {
-            router!(request,
-				(GET) (/) => {
-                    let current_time = {
-                        let vfs = vfs.lock().unwrap();
-
-                        vfs.current_time()
-                    };
-
-					json(ServerInfo {
-                        server_version: env!("CARGO_PKG_VERSION"),
-                        protocol_version: 0,
-                        server_id: &server_id,
-                        project: &project,
-                        current_time,
-                    })
-				},
-
-                (GET) (/changes/{ last_time: f64 }) => {
-                    let vfs = vfs.lock().unwrap();
-                    let current_time = vfs.current_time();
-                    let changes = vfs.changes_since(last_time);
-
-                    json(ChangesResult {
-                        changes,
-                        server_id: &server_id,
-                        current_time,
-                    })
-                },
-
-				(POST) (/read) => {
-                    let read_request: Vec<Vec<String>> = match read_json(&request) {
-                        Some(v) => v,
-                        None => return rouille::Response::empty_400(),
-                    };
-
-                    let (items, current_time) = {
-                        let vfs = vfs.lock().unwrap();
-
-                        let current_time = vfs.current_time();
-
-                        let mut items = Vec::new();
-
-                        for route in &read_request {
-                            match vfs.read(&route) {
-                                Ok(v) => items.push(Some(v)),
-                                Err(_) => items.push(None),
-                            }
-                        }
-
-                        (items, current_time)
-                    };
-
-                    json(ReadResult {
-                        server_id: &server_id,
-                        items,
-                        current_time,
-                    })
-				},
-
-                (POST) (/write) => {
-                    rouille::Response::empty_404()
-                },
-
-				_ => rouille::Response::empty_404()
-			)
-        });
-    });
-}

test-folder/meh/init.lua

@@ -1 +0,0 @@
--- meh/init.lua

test-project/rojo.json

@@ -0,0 +1,14 @@
+{
+  "name": "test-project",
+  "servePort": 8001,
+  "partitions": {
+    "src": {
+      "path": "src",
+      "target": "ReplicatedFirst"
+    },
+    "extra": {
+      "path": "extra-script.lua",
+      "target": "ReplicatedStorage.ExtraScript"
+    }
+  }
+}

test-project/src/SomeTool/SomeTool.client.lua

@@ -0,0 +1 @@
+print("Hello, world, from my tool!")

test-project/src/SomeTool/init.model.json

@@ -0,0 +1,4 @@
+{
+  "Name": "SomeTool",
+  "ClassName": "Tool"
+}

test-project/src/a/b.lua

@@ -0,0 +1 @@
+print("HEY!")

test-project/src/hello.model.json

@@ -0,0 +1,20 @@
+{
+  "Name": "hello",
+  "ClassName": "Model",
+  "Children": [
+    {
+      "Name": "Some Part",
+      "ClassName": "Part"
+    },
+    {
+      "Name": "Some StringValue",
+      "ClassName": "StringValue",
+      "Properties": {
+        "Value": {
+          "Type": "String",
+          "Value": "Hello, world!"
+        }
+      }
+    }
+  ]
+}