Upload plugin as part of release workflow (#1227)

Closes #1178.

.dir-locals.el

@@ -0,0 +1,2 @@
+((nil . ((eglot-luau-rojo-project-path . "plugin.project.json")
+         (eglot-luau-rojo-sourcemap-enabled . 't))))

.editorconfig

@@ -24,3 +24,6 @@ insert_final_newline = true
 
 [*.lua]
 indent_style = tab
+
+[*.luau]
+indent_style = tab

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# stylua formatting
+0f8e1625d572a5fe0f7b5c08653ff92cc837d346

.gitattributes

@@ -0,0 +1 @@
+*.lua linguist-language=Luau

.github/FUNDING.yml

@@ -1 +0,0 @@
-patreon: lpghatguy

.github/workflows/changelog.yml

@@ -0,0 +1,23 @@
+name: Changelog Check
+
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Check Actions
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Changelog check
+      uses: Zomzog/changelog-checker@v1.3.0
+      with:
+        fileName: CHANGELOG.md
+        noChangelogLabel: skip changelog
+        checkNotification: Simple
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -12,23 +12,28 @@ on:
 jobs:
   build:
     name: Build and Test
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
-        rust_version: [stable, 1.55.0]
+        os: [ubuntu-22.04, windows-latest, macos-latest, windows-11-arm, ubuntu-22.04-arm]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: true
 
     - name: Install Rust
-      uses: actions-rs/toolchain@v1
+      uses: dtolnay/rust-toolchain@stable
+
+    - name: Restore Rust Cache
+      uses: actions/cache/restore@v4
       with:
-        toolchain: ${{ matrix.rust_version }}
+        path: |
-        override: true
+          ~/.cargo/registry
-        profile: minimal
+          ~/.cargo/git
+          target
+        key: ${{ matrix.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
     - name: Build
       run: cargo build --locked --verbose
@@ -36,24 +41,93 @@ jobs:
     - name: Test
       run: cargo test --locked --verbose
 
-  lint:
+    - name: Save Rust Cache
-    name: Rustfmt and Clippy
+      uses: actions/cache/save@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ matrix.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+  msrv:
+    name: Check MSRV
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         submodules: true
 
     - name: Install Rust
-      uses: actions-rs/toolchain@v1
+      uses: dtolnay/rust-toolchain@1.88.0
+
+    - name: Restore Rust Cache
+      uses: actions/cache/restore@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: Build
+      run: cargo build --locked --verbose
+
+    - name: Save Rust Cache
+      uses: actions/cache/save@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+  lint:
+    name: Rustfmt, Clippy, Stylua, & Selene
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Install Rust
+      uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: stable
-        override: true
         components: rustfmt, clippy
 
+    - name: Restore Rust Cache
+      uses: actions/cache/restore@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: Setup Rokit
+      uses: CompeyDev/setup-rokit@v0.1.2
+      with:
+        version: 'v1.1.0'
+
+    - name: Stylua
+      run: stylua --check plugin/src
+
+    - name: Selene
+      run: selene plugin/src
+
     - name: Rustfmt
       run: cargo fmt -- --check
 
     - name: Clippy
       run: cargo clippy
+
+    - name: Save Rust Cache
+      uses: actions/cache/save@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}

.github/workflows/release.yml

@@ -8,78 +8,81 @@ jobs:
   create-release:
     name: Create Release
     runs-on: ubuntu-latest
-    outputs:
-      upload_url: ${{ steps.create_release.outputs.upload_url }}
     steps:
+      - uses: actions/checkout@v4
       - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
+        run: |
-          tag_name: ${{ github.ref }}
+          gh release create ${{ github.ref_name }} --draft --verify-tag --title ${{ github.ref_name }}
-          release_name: ${{ github.ref }}
-          draft: true
-          prerelease: false
 
   build-plugin:
     needs: ["create-release"]
     name: Build Roblox Studio Plugin
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: Setup Foreman
+      - name: Setup Rokit
-        uses: Roblox/setup-foreman@v1
+        uses: CompeyDev/setup-rokit@v0.1.2
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          version: 'v1.1.0'
 
       - name: Build Plugin
-        run: rojo build plugin --output Rojo.rbxm
+        run: rojo build plugin.project.json --output Rojo.rbxm
 
       - name: Upload Plugin to Release
-        uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
+        run: |
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
+          gh release upload ${{ github.ref_name }} Rojo.rbxm
-          asset_path: Rojo.rbxm
-          asset_name: Rojo.rbxm
-          asset_content_type: application/octet-stream
 
       - name: Upload Plugin to Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Rojo.rbxm
           path: Rojo.rbxm
       
+      - name: Upload Plugin to Roblox
+        env:
+          RBX_API_KEY: ${{ secrets.PLUGIN_UPLOAD_TOKEN }}
+          RBX_UNIVERSE_ID: ${{ vars.PLUGIN_CI_PLACE_ID }}
+          RBX_PLACE_ID: ${{ vars.PLUGIN_CI_UNIVERSE_ID }}
+        run: lune run upload-plugin Rojo.rbxm
+
   build:
     needs: ["create-release"]
     strategy:
       fail-fast: false
       matrix:
         # https://doc.rust-lang.org/rustc/platform-support.html
-        #
-        # FIXME: After the Rojo VS Code extension updates, add architecture
-        # names to each of these releases. We'll rename win64 to windows and add
-        # -x86_64 to each release.
         include:
           - host: linux
-            os: ubuntu-latest
+            os: ubuntu-22.04
             target: x86_64-unknown-linux-gnu
-            label: linux
+            label: linux-x86_64
+
+          - host: linux
+            os: ubuntu-22.04-arm
+            target: aarch64-unknown-linux-gnu
+            label: linux-aarch64
 
           - host: windows
             os: windows-latest
             target: x86_64-pc-windows-msvc
-            label: win64
+            label: windows-x86_64
+
+          - host: windows
+            os: windows-11-arm
+            target: aarch64-pc-windows-msvc
+            label: windows-aarch64
 
           - host: macos
             os: macos-latest
             target: x86_64-apple-darwin
-            label: macos
+            label: macos-x86_64
 
           - host: macos
             os: macos-latest
@@ -91,63 +94,64 @@ jobs:
     env:
       BIN: rojo
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: Get Version from Tag
-        shell: bash
-        # https://github.community/t/how-to-get-just-the-tag-name/16241/7#M1027
-        run: |
-          echo "PROJECT_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
-          echo "Version is: ${{ env.PROJECT_VERSION }}"
-
       - name: Install Rust
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
+          targets: ${{ matrix.target }}
-          target: ${{ matrix.target }}
+
-          override: true
+      - name: Restore Rust Cache
-          profile: minimal
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ matrix.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Build Release
-        run: cargo build --release --locked --verbose
+        run: cargo build --release --locked --verbose --target ${{ matrix.target }}
-        env:
-          # Build into a known directory so we can find our build artifact more
-          # easily.
-          CARGO_TARGET_DIR: output
 
-          # On platforms that use OpenSSL, ensure it is statically linked to
+      - name: Save Rust Cache
-          # make binaries more portable.
+        uses: actions/cache/save@v4
-          OPENSSL_STATIC: 1
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ matrix.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
-      - name: Create Release Archive
+      - name: Generate Artifact Name
         shell: bash
+        env:
+          TAG_NAME: ${{ github.ref_name }}
+        run: |
+          echo "ARTIFACT_NAME=$BIN-${TAG_NAME#v}-${{ matrix.label }}.zip" >> "$GITHUB_ENV"
+
+      - name: Create Archive and Upload to Release
+        shell: bash
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           mkdir staging
 
           if [ "${{ matrix.host }}" = "windows" ]; then
-            cp "output/release/$BIN.exe" staging/
+            cp "target/${{ matrix.target }}/release/$BIN.exe" staging/
             cd staging
-            7z a ../release.zip *
+            7z a ../$ARTIFACT_NAME *
           else
-            cp "output/release/$BIN" staging/
+            cp "target/${{ matrix.target }}/release/$BIN" staging/
             cd staging
-            zip ../release.zip *
+            zip ../$ARTIFACT_NAME *
           fi
 
-      - name: Upload Archive to Release
+          gh release upload ${{ github.ref_name }} ../$ARTIFACT_NAME
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: release.zip
-          asset_name: ${{ env.BIN }}-${{ env.PROJECT_VERSION }}-${{ matrix.label }}.zip
-          asset_content_type: application/octet-stream
 
       - name: Upload Archive to Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.BIN }}-${{ env.PROJECT_VERSION }}-${{ matrix.label }}.zip
+          path: ${{ env.ARTIFACT_NAME }}
-          path: release.zip
+          name: ${{ env.ARTIFACT_NAME }}

.gitignore

@@ -10,8 +10,8 @@
 /*.rbxl
 /*.rbxlx
 
-# Test places for the Roblox Studio Plugin
+# Sourcemap for the Rojo plugin (for better intellisense)
-/plugin/*.rbxlx
+/sourcemap.json
 
 # Roblox Studio holds 'lock' files on places
 *.rbxl.lock
@@ -20,5 +20,9 @@
 # Snapshot files from the 'insta' Rust crate
 **/*.snap.new
 
-# Selene generates a roblox.toml file that should not be checked in.
+# Macos file system junk
-/roblox.toml
+._*
+.DS_STORE
+
+# JetBrains IDEs
+/.idea/

.gitmodules

@@ -1,15 +1,24 @@
-[submodule "plugin/modules/roact"]
+[submodule "plugin/Packages/Roact"]
-	path = plugin/modules/roact
+	path = plugin/Packages/Roact
-	url = https://github.com/Roblox/roact.git
+	url = https://github.com/roblox/roact.git
-[submodule "plugin/modules/testez"]
+[submodule "plugin/Packages/Flipper"]
-	path = plugin/modules/testez
+	path = plugin/Packages/Flipper
-	url = https://github.com/Roblox/testez.git
+	url = https://github.com/reselim/flipper.git
-[submodule "plugin/modules/promise"]
+[submodule "plugin/Packages/Promise"]
-	path = plugin/modules/promise
+	path = plugin/Packages/Promise
-	url = https://github.com/LPGhatguy/roblox-lua-promise.git
+	url = https://github.com/evaera/roblox-lua-promise.git
-[submodule "plugin/modules/t"]
+[submodule "plugin/Packages/t"]
-	path = plugin/modules/t
+	path = plugin/Packages/t
 	url = https://github.com/osyrisrblx/t.git
-[submodule "plugin/modules/flipper"]
+[submodule "plugin/Packages/TestEZ"]
-	path = plugin/modules/flipper
+	path = plugin/Packages/TestEZ
-	url = https://github.com/Reselim/Flipper
+	url = https://github.com/roblox/testez.git
+[submodule "plugin/Packages/Highlighter"]
+	path = plugin/Packages/Highlighter
+	url = https://github.com/boatbomber/highlighter.git
+[submodule "plugin/Packages/msgpack-luau"]
+	path = plugin/Packages/msgpack-luau
+	url = https://github.com/cipharius/msgpack-luau/
+[submodule ".lune/opencloud-execute"]
+	path = .lune/opencloud-execute
+	url = https://github.com/Dekkonot/opencloud-luau-execute-lune.git

.luacheckrc

@@ -1,58 +0,0 @@
-stds.roblox = {
-	read_globals = {
-		game = {
-			other_fields = true,
-		},
-
-		-- Roblox globals
-		"script",
-
-		-- Extra functions
-		"tick", "warn", "spawn",
-		"wait", "settings", "typeof",
-
-		-- Types
-		"Vector2", "Vector3",
-		"Vector2int16", "Vector3int16",
-		"Color3",
-		"UDim", "UDim2",
-		"Rect",
-		"CFrame",
-		"Enum",
-		"Instance",
-		"DockWidgetPluginGuiInfo",
-	}
-}
-
-stds.plugin = {
-	read_globals = {
-		"plugin",
-	}
-}
-
-stds.testez = {
-	read_globals = {
-		"describe",
-		"it", "itFOCUS", "itSKIP", "itFIXME",
-		"FOCUS", "SKIP", "HACK_NO_XPCALL",
-		"expect",
-	}
-}
-
-ignore = {
-	"212", -- unused arguments
-	"421", -- shadowing local variable
-	"422", -- shadowing argument
-	"431", -- shadowing upvalue
-	"432", -- shadowing upvalue argument
-}
-
-std = "lua51+roblox"
-
-files["**/*.server.lua"] = {
-	std = "+plugin",
-}
-
-files["**/*.spec.lua"] = {
-	std = "+testez",
-}

.lune/.config.luau

@@ -0,0 +1,8 @@
+return {
+	luau = {
+		languagemode = "strict",
+		aliases = {
+			lune = "~/.lune/.typedefs/0.10.4/",
+		},
+	},
+}

.lune/scripts/plugin-upload.luau

@@ -0,0 +1,51 @@
+local args: any = ...
+assert(args, "no arguments passed to script")
+
+local input: buffer = args.BinaryInput
+
+local AssetService = game:GetService("AssetService")
+local SerializationService = game:GetService("SerializationService")
+local EncodingService = game:GetService("EncodingService")
+
+local input_hash: buffer = EncodingService:ComputeBufferHash(input, Enum.HashAlgorithm.Sha256)
+local hex_hash: { string } = table.create(buffer.len(input_hash))
+for i = 0, buffer.len(input_hash) - 1 do
+	table.insert(hex_hash, string.format("%02x", buffer.readu8(input_hash, i)))
+end
+
+print(`Deserializing plugin file (size: {buffer.len(input)} bytes, hash: {table.concat(hex_hash, "")})`)
+local plugin = SerializationService:DeserializeInstancesAsync(input)[1]
+
+local UploadDetails = require(plugin.UploadDetails) :: any
+local PLUGIN_ID = UploadDetails.assetId
+local PLUGIN_NAME = UploadDetails.name
+local PLUGIN_DESCRIPTION = UploadDetails.description
+local PLUGIN_CREATOR_ID = UploadDetails.creatorId
+local PLUGIN_CREATOR_TYPE = UploadDetails.creatorType
+
+assert(typeof(PLUGIN_ID) == "number", "UploadDetails did not contain a number field 'assetId'")
+assert(typeof(PLUGIN_NAME) == "string", "UploadDetails did not contain a string field 'name'")
+assert(typeof(PLUGIN_DESCRIPTION) == "string", "UploadDetails did not contain a string field 'description'")
+assert(typeof(PLUGIN_CREATOR_ID) == "number", "UploadDetails did not contain a number field 'creatorId'")
+assert(typeof(PLUGIN_CREATOR_TYPE) == "string", "UploadDetails did not contain a string field 'creatorType'")
+assert(
+	Enum.AssetCreatorType:FromName(PLUGIN_CREATOR_TYPE) ~= nil,
+	"UploadDetails field 'creatorType' was not a valid member of Enum.AssetCreatorType"
+)
+
+print(`Uploading to {PLUGIN_ID}`)
+print(`Plugin Name: {PLUGIN_NAME}`)
+print(`Plugin Description: {PLUGIN_DESCRIPTION}`)
+
+local result, version_or_err = AssetService:CreateAssetVersionAsync(plugin, Enum.AssetType.Plugin, PLUGIN_ID, {
+	["Name"] = PLUGIN_NAME,
+	["Description"] = PLUGIN_DESCRIPTION,
+	["CreatorId"] = PLUGIN_CREATOR_ID,
+	["CreatorType"] = Enum.AssetCreatorType:FromName(PLUGIN_CREATOR_TYPE),
+})
+
+if result ~= Enum.CreateAssetResult.Success then
+	error(`Plugin failed to upload because: {result.Name} - {version_or_err}`)
+end
+
+print(`Plugin uploaded successfully. New version is {version_or_err}.`)

.lune/upload-plugin.luau

@@ -0,0 +1,78 @@
+local fs = require("@lune/fs")
+local process = require("@lune/process")
+local stdio = require("@lune/stdio")
+
+local luau_execute = require("./opencloud-execute")
+
+local UNIVERSE_ID = process.env["RBX_UNIVERSE_ID"]
+local PLACE_ID = process.env["RBX_PLACE_ID"]
+
+local version_string = fs.readFile("plugin/Version.txt")
+local versions = { string.match(version_string, "^v?(%d+)%.(%d+)%.(%d+)(.*)$") }
+if versions[4] ~= "" then
+	print("This release is a pre-release. Skipping uploading plugin.")
+	process.exit(0)
+end
+
+local plugin_path = process.args[1]
+assert(
+	typeof(plugin_path) == "string",
+	"no plugin path provided, expected usage is `lune run upload-plugin [PATH TO RBXM]`."
+)
+
+-- For local testing
+if process.env["CI"] ~= "true" then
+	local rojo = process.exec("rojo", { "build", "plugin.project.json", "--output", plugin_path })
+	if not rojo.ok then
+		stdio.ewrite("plugin upload failed because: could not build plugin.rbxm\n\n")
+		stdio.ewrite(rojo.stderr)
+		stdio.ewrite("\n")
+		process.exit(1)
+	end
+else
+	assert(fs.isFile(plugin_path), `Plugin file did not exist at {plugin_path}`)
+end
+local plugin_content = fs.readFile(plugin_path)
+
+local engine_script = fs.readFile(".lune/scripts/plugin-upload.luau")
+
+print("Creating task to upload plugin")
+local task = luau_execute.create_task_latest(UNIVERSE_ID, PLACE_ID, engine_script, 300, false, plugin_content)
+
+print("Waiting for task to finish")
+local success = luau_execute.await_finish(task)
+if not success then
+	local error = luau_execute.get_error(task)
+	assert(error, "could not fetch error from task")
+	stdio.ewrite("plugin upload failed because: task did not finish successfully\n\n")
+	stdio.ewrite(error.code)
+	stdio.ewrite("\n")
+	stdio.ewrite(error.message)
+	stdio.ewrite("\n")
+	process.exit(1)
+end
+
+print("Output from task:\n")
+for _, log in luau_execute.get_structured_logs(task) do
+	if log.messageType == "ERROR" then
+		stdio.write(stdio.color("red"))
+		stdio.write(log.message)
+		stdio.write("\n")
+		stdio.write(stdio.color("reset"))
+	elseif log.messageType == "INFO" then
+		stdio.write(stdio.color("cyan"))
+		stdio.write(log.message)
+		stdio.write("\n")
+		stdio.write(stdio.color("reset"))
+	elseif log.messageType == "WARNING" then
+		stdio.write(stdio.color("yellow"))
+		stdio.write(log.message)
+		stdio.write("\n")
+		stdio.write(stdio.color("reset"))
+	else
+		stdio.write(stdio.color("reset"))
+		stdio.write(log.message)
+		stdio.write("\n")
+		stdio.write(stdio.color("reset"))
+	end
+end

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "JohnnyMorganz.luau-lsp",
+    "JohnnyMorganz.stylua",
+    "Kampfkarren.selene-vscode",
+    "rust-lang.rust-analyzer"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "luau-lsp.sourcemap.rojoProjectFile": "plugin.project.json",
+  "luau-lsp.sourcemap.autogenerate": true
+}

CONTRIBUTING.md

@@ -14,13 +14,31 @@ Code contributions are welcome for features and bugs that have been reported in
 You'll want these tools to work on Rojo:
 
 * Latest stable Rust compiler
+  * Rustfmt and Clippy are used for code formatting and linting.
 * Latest stable [Rojo](https://github.com/rojo-rbx/rojo)
-* [Foreman](https://github.com/Roblox/foreman)
+* [Rokit](https://github.com/rojo-rbx/rokit)
+* [Luau Language Server](https://github.com/JohnnyMorganz/luau-lsp) (Only needed if working on the Studio plugin.)
+
+When working on the Studio plugin, we recommend using this command to automatically rebuild the plugin when you save a change:
+
+*(Make sure you've enabled the Studio setting to reload plugins on file change!)*
+
+```bash
+bash scripts/watch-build-plugin.sh
+```
+
+You can also run the plugin's unit tests with the following:
+
+*(Make sure you have `run-in-roblox` installed first!)*
+
+```bash
+bash scripts/unit-test-plugin.sh
+```
 
 ## Documentation
 Documentation impacts way more people than the individual lines of code we write.
 
-If you find any problems in documentation, including typos, bad grammar, misleading phrasing, or missing content, feel free to file issues and pull requests to fix them.
+If you find any problems in the documentation, including typos, bad grammar, misleading phrasing, or missing content, feel free to file issues and pull requests to fix them.
 
 ## Bug Reports and Feature Requests
 Most of the tools around Rojo try to be clear when an issue is a bug. Even if they aren't, sometimes things don't work quite right.

Cargo.toml

@@ -1,19 +1,22 @@
 [package]
 name = "rojo"
-version = "7.1.1"
+version = "7.7.0-rc.1"
-authors = ["Lucien Greathouse <me@lpghatguy.com>"]
+rust-version = "1.88"
+authors = [
+    "Lucien Greathouse <me@lpghatguy.com>",
+    "Micah Reid <git@dekkonot.com>",
+    "Ken Loeffler <kenloef@gmail.com>",
+]
 description = "Enables professional-grade development tools for Roblox developers"
 license = "MPL-2.0"
 homepage = "https://rojo.space"
 documentation = "https://rojo.space/docs"
 repository = "https://github.com/rojo-rbx/rojo"
 readme = "README.md"
-edition = "2018"
+edition = "2021"
 build = "build.rs"
 
-exclude = [
+exclude = ["/test-projects/**"]
-    "/test-projects/**",
-]
 
 [profile.dev]
 panic = "abort"
@@ -27,11 +30,12 @@ default = []
 # Enable this feature to live-reload assets from the web UI.
 dev_live_assets = []
 
+# Run Rojo with this feature to open a Tracy session.
+# Currently uses protocol v63, last supported in Tracy 0.9.1.
+profile-with-tracy = ["profiling/profile-with-tracy"]
+
 [workspace]
-members = [
+members = ["crates/*"]
-    "rojo-insta-ext",
-    "memofs",
-]
 
 [lib]
 name = "librojo"
@@ -42,67 +46,88 @@ name = "build"
 harness = false
 
 [dependencies]
-memofs = { version = "0.2.0", path = "memofs" }
+memofs = { version = "0.3.1", path = "crates/memofs" }
 
 # These dependencies can be uncommented when working on rbx-dom simultaneously
-# rbx_binary = { path = "../rbx-dom/rbx_binary" }
+# rbx_binary = { path = "../rbx-dom/rbx_binary", features = [
+#     "unstable_text_format",
+# ] }
 # rbx_dom_weak = { path = "../rbx-dom/rbx_dom_weak" }
 # rbx_reflection = { path = "../rbx-dom/rbx_reflection" }
 # rbx_reflection_database = { path = "../rbx-dom/rbx_reflection_database" }
 # rbx_xml = { path = "../rbx-dom/rbx_xml" }
 
-rbx_binary = "0.6.4"
+rbx_binary = { version = "2.0.1", features = ["unstable_text_format"] }
-rbx_dom_weak = "2.3.0"
+rbx_dom_weak = "4.1.0"
-rbx_reflection = "4.2.0"
+rbx_reflection = "6.1.0"
-rbx_reflection_database = "0.2.2"
+rbx_reflection_database = "2.0.2"
-rbx_xml = "0.12.3"
+rbx_xml = "2.0.1"
 
-anyhow = "1.0.44"
+anyhow = "1.0.80"
-backtrace = "0.3.61"
+backtrace = "0.3.69"
 bincode = "1.3.3"
-crossbeam-channel = "0.5.1"
+crossbeam-channel = "0.5.12"
-csv = "1.1.6"
+csv = "1.3.0"
-env_logger = "0.9.0"
+env_logger = "0.9.3"
-fs-err = "2.6.0"
+fs-err = "2.11.0"
-futures = "0.3.17"
+futures = "0.3.30"
-globset = "0.4.8"
+globset = "0.4.14"
 humantime = "2.1.0"
-hyper = { version = "0.14.13", features = ["server", "tcp", "http1"] }
+hyper = { version = "0.14.28", features = ["server", "tcp", "http1"] }
+hyper-tungstenite = "0.11.0"
 jod-thread = "0.1.2"
-log = "0.4.14"
+log = "0.4.21"
-maplit = "1.0.2"
+num_cpus = "1.16.0"
-notify = "4.0.17"
+opener = "0.5.2"
-opener = "0.5.0"
+rayon = "1.9.0"
-reqwest = { version = "0.11.10", features = ["blocking", "json"] }
+reqwest = { version = "0.11.24", default-features = false, features = [
+    "blocking",
+    "json",
+    "rustls-tls",
+] }
 ritz = "0.1.0"
 roblox_install = "1.0.0"
-serde = { version = "1.0.130", features = ["derive", "rc"] }
+serde = { version = "1.0.197", features = ["derive", "rc"] }
-serde_json = "1.0.68"
+serde_json = "1.0.145"
-structopt = "0.3.23"
+jsonc-parser = { version = "0.27.0", features = ["serde"] }
-termcolor = "1.1.2"
+strum = { version = "0.27", features = ["derive"] }
-thiserror = "1.0.30"
+toml = "0.5.11"
-tokio = { version = "1.12.0", features = ["rt", "rt-multi-thread"] }
+termcolor = "1.4.1"
-uuid = { version = "1.0.0", features = ["v4", "serde"] }
+thiserror = "1.0.57"
+tokio = { version = "1.36.0", features = ["rt", "rt-multi-thread", "macros"] }
+uuid = { version = "1.7.0", features = ["v4", "serde"] }
+clap = { version = "3.2.25", features = ["derive"] }
+profiling = "1.0.15"
+yaml-rust2 = "0.10.3"
+data-encoding = "2.8.0"
+pathdiff = "0.2.3"
+
+blake3 = "1.5.0"
+float-cmp = "0.9.0"
+indexmap = { version = "2.10.0", features = ["serde"] }
+rmp-serde = "1.3.0"
+serde_bytes = "0.11.19"
 
 [target.'cfg(windows)'.dependencies]
 winreg = "0.10.1"
 
 [build-dependencies]
-memofs = { version = "0.2.0", path = "memofs" }
+memofs = { version = "0.3.0", path = "crates/memofs" }
 
-embed-resource = "1.6.4"
+embed-resource = "1.8.0"
-anyhow = "1.0.44"
+anyhow = "1.0.80"
 bincode = "1.3.3"
-fs-err = "2.6.0"
+fs-err = "2.11.0"
 maplit = "1.0.2"
+semver = "1.0.22"
 
 [dev-dependencies]
-rojo-insta-ext = { path = "rojo-insta-ext" }
+rojo-insta-ext = { path = "crates/rojo-insta-ext" }
 
-criterion = "0.3.5"
+criterion = "0.3.6"
-insta = { version = "1.8.0", features = ["redactions"] }
+insta = { version = "1.36.1", features = ["redactions", "yaml", "json"] }
-paste = "1.0.5"
+paste = "1.0.14"
-pretty_assertions = "1.2.1"
+pretty_assertions = "1.4.0"
-serde_yaml = "0.8.21"
+serde_yaml = "0.8.26"
-tempfile = "3.2.0"
+tempfile = "3.10.1"
-walkdir = "2.3.2"
+walkdir = "2.5.0"

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <a href="https://rojo.space"><img src="assets/logo-512.png" alt="Rojo" height="217" /></a>
+    <a href="https://rojo.space"><img src="assets/brand_images/logo-512.png" alt="Rojo" height="217" /></a>
 </div>
 
 <div>&nbsp;</div>
@@ -40,7 +40,7 @@ Check out our [contribution guide](CONTRIBUTING.md) for detailed instructions fo
 
 Pull requests are welcome!
 
-Rojo supports Rust 1.46.0 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
+Rojo supports Rust 1.88 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
 
 ## License
 Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.

assets/index.css

@@ -17,6 +17,10 @@ html {
   line-height: 1.4;
 }
 
+body {
+  background-color: #e7e7e7
+}
+
 img {
   max-width:100%;
   max-height:100%;

assets/project-templates/model/README.md

@@ -2,7 +2,7 @@
 Generated by [Rojo](https://github.com/rojo-rbx/rojo) {rojo_version}.
 
 ## Getting Started
-To build this library or plugin, use:
+To build this library, use:
 
 ```bash
 rojo build -o "{project_name}.rbxmx"

assets/project-templates/model/gitignore.txt

@@ -1,3 +1,5 @@
 # Roblox Studio lock files
 /*.rbxlx.lock
 /*.rbxl.lock
+
+sourcemap.json

assets/project-templates/place/default.project.json

@@ -4,7 +4,7 @@
     "$className": "DataModel",
 
     "ReplicatedStorage": {
-      "Common": {
+      "Shared": {
         "$path": "src/shared"
       }
     },

assets/project-templates/place/gitignore.txt

@@ -4,3 +4,5 @@
 # Roblox Studio lock files
 /*.rbxlx.lock
 /*.rbxl.lock
+
+sourcemap.json

assets/project-templates/place/src/client/init.client.luau

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

assets/project-templates/place/src/server/init.server.luau

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

assets/project-templates/place/src/shared/Hello.luau

@@ -0,0 +1,3 @@
+return function()
+	print("Hello, world!")
+end

assets/project-templates/plugin/README.md

@@ -0,0 +1,17 @@
+# {project_name}
+Generated by [Rojo](https://github.com/rojo-rbx/rojo) {rojo_version}.
+
+## Getting Started
+To build this plugin to your local plugins folder, use:
+
+```bash
+rojo build -p "{project_name}.rbxm"
+```
+
+You can include the `watch` flag to re-build it on save:
+
+```bash
+rojo build -p "{project_name}.rbxm" --watch
+```
+
+For more help, check out [the Rojo documentation](https://rojo.space/docs).

assets/project-templates/plugin/default.project.json

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

assets/project-templates/plugin/gitignore.txt

@@ -0,0 +1,5 @@
+# Plugin model files
+/{project_name}.rbxmx
+/{project_name}.rbxm
+
+sourcemap.json

assets/project-templates/plugin/src/init.server.luau

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

benches/build.rs

@@ -3,7 +3,7 @@ use std::path::Path;
 use criterion::{criterion_group, criterion_main, BatchSize, Criterion};
 use tempfile::{tempdir, TempDir};
 
-use librojo::cli::{build, BuildCommand};
+use librojo::cli::BuildCommand;
 
 pub fn benchmark_small_place(c: &mut Criterion) {
     bench_build_place(c, "Small Place", "test-projects/benchmark_small_place")
@@ -20,7 +20,7 @@ fn bench_build_place(c: &mut Criterion, name: &str, path: &str) {
     group.bench_function("build", |b| {
         b.iter_batched(
             || place_setup(path),
-            |(_dir, options)| build(options).unwrap(),
+            |(_dir, options)| options.run().unwrap(),
             BatchSize::SmallInput,
         )
     });
@@ -31,11 +31,12 @@ fn bench_build_place(c: &mut Criterion, name: &str, path: &str) {
 fn place_setup<P: AsRef<Path>>(input_path: P) -> (TempDir, BuildCommand) {
     let dir = tempdir().unwrap();
     let input = input_path.as_ref().to_path_buf();
-    let output = dir.path().join("output.rbxlx");
+    let output = Some(dir.path().join("output.rbxlx"));
 
     let options = BuildCommand {
         project: input,
         watch: false,
+        plugin: None,
         output,
     };
 

bin/dev-plugin.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-
-watchexec -c -w plugin "sh -c './bin/install-dev-plugin.sh'"

bin/install-dev-plugin.sh

@@ -1,13 +0,0 @@
-#!/bin/sh
-
-set -e
-
-DIR="$( mktemp -d )"
-PLUGIN_FILE="$DIR/Rojo.rbxm"
-TESTEZ_FILE="$DIR/TestEZ.rbxm"
-
-rojo build plugin -o "$PLUGIN_FILE"
-rojo build plugin/testez.project.json -o "$TESTEZ_FILE"
-remodel bin/mark-plugin-as-dev.lua "$PLUGIN_FILE" "$TESTEZ_FILE" 2>/dev/null
-
-cp "$PLUGIN_FILE" "$LOCALAPPDATA/Roblox/Plugins/Rojo.rbxm"

bin/install-release-plugin.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-
-rojo build plugin -o "$LOCALAPPDATA/Roblox/Plugins/Rojo.rbxm"

bin/mark-plugin-as-dev.lua

@@ -1,12 +0,0 @@
-local pluginPath, testezPath = ...
-
-local plugin = remodel.readModelFile(pluginPath)[1]
-local testez = remodel.readModelFile(testezPath)[1]
-
-local marker = Instance.new("Folder")
-marker.Name = "ROJO_DEV_BUILD"
-marker.Parent = plugin
-
-testez.Parent = plugin
-
-remodel.writeModelFile(plugin, pluginPath)

bin/put-plugin-in-test-place.lua

@@ -1,8 +0,0 @@
-local pluginPath, placePath = ...
-
-local plugin = remodel.readModelFile(pluginPath)[1]
-local place = remodel.readPlaceFile(placePath)
-
-plugin.Parent = place:GetService("ReplicatedStorage")
-
-remodel.writePlaceFile(place, placePath)

bin/run-all-tests.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-set -e
-
-./bin/run-cli-tests.sh
-./bin/run-plugin-tests.sh

bin/run-cli-tests.sh

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-set -e
-
-cargo test --all --locked
-cargo fmt -- --check
-
-touch src/lib.rs # Nudge Rust source to make Clippy actually check things
-cargo clippy

bin/run-plugin-tests.sh

@@ -1,16 +0,0 @@
-#!/bin/sh
-
-set -e
-
-DIR="$( mktemp -d )"
-PLUGIN_FILE="$DIR/Rojo.rbxmx"
-PLACE_FILE="$DIR/RojoTestPlace.rbxlx"
-
-rojo build plugin -o "$PLUGIN_FILE"
-rojo build plugin/place.project.json -o "$PLACE_FILE"
-
-remodel bin/put-plugin-in-test-place.lua "$PLUGIN_FILE" "$PLACE_FILE"
-
-run-in-roblox -s plugin/testBootstrap.server.lua "$PLACE_FILE"
-
-luacheck plugin/src plugin/log plugin/http

build.rs

@@ -7,6 +7,7 @@ use fs_err as fs;
 use fs_err::File;
 use maplit::hashmap;
 use memofs::VfsSnapshot;
+use semver::Version;
 
 fn snapshot_from_fs_path(path: &Path) -> io::Result<VfsSnapshot> {
     println!("cargo:rerun-if-changed={}", path.display());
@@ -19,9 +20,18 @@ fn snapshot_from_fs_path(path: &Path) -> io::Result<VfsSnapshot> {
 
             let file_name = entry.file_name().to_str().unwrap().to_owned();
 
+            if file_name.starts_with(".git") {
+                continue;
+            }
+
             // We can skip any TestEZ test files since they aren't necessary for
             // the plugin to run.
-            if file_name.ends_with(".spec.lua") {
+            if file_name.ends_with(".spec.lua") || file_name.ends_with(".spec.luau") {
+                continue;
+            }
+
+            // Ignore images in msgpack-luau because they aren't UTF-8 encoded.
+            if file_name.ends_with(".png") {
                 continue;
             }
 
@@ -40,38 +50,40 @@ fn snapshot_from_fs_path(path: &Path) -> io::Result<VfsSnapshot> {
 fn main() -> Result<(), anyhow::Error> {
     let out_dir = env::var_os("OUT_DIR").unwrap();
 
-    let root_dir = env::var_os("CARGO_MANIFEST_DIR").unwrap();
+    let root_dir = PathBuf::from(env::var_os("CARGO_MANIFEST_DIR").unwrap());
-    let plugin_root = PathBuf::from(root_dir).join("plugin");
+    let plugin_dir = root_dir.join("plugin");
+    let templates_dir = root_dir.join("assets").join("project-templates");
 
-    let plugin_modules = plugin_root.join("modules");
+    let our_version = Version::parse(env::var_os("CARGO_PKG_VERSION").unwrap().to_str().unwrap())?;
+    let plugin_version =
+        Version::parse(fs::read_to_string(plugin_dir.join("Version.txt"))?.trim())?;
 
-    let snapshot = VfsSnapshot::dir(hashmap! {
+    assert_eq!(
-        "default.project.json" => snapshot_from_fs_path(&plugin_root.join("default.project.json"))?,
+        our_version, plugin_version,
-        "fmt" => snapshot_from_fs_path(&plugin_root.join("fmt"))?,
+        "plugin version does not match Cargo version"
-        "http" => snapshot_from_fs_path(&plugin_root.join("http"))?,
+    );
-        "log" => snapshot_from_fs_path(&plugin_root.join("log"))?,
+
-        "rbx_dom_lua" => snapshot_from_fs_path(&plugin_root.join("rbx_dom_lua"))?,
+    let template_snapshot = snapshot_from_fs_path(&templates_dir)?;
-        "src" => snapshot_from_fs_path(&plugin_root.join("src"))?,
+
-        "modules" => VfsSnapshot::dir(hashmap! {
+    let plugin_snapshot = VfsSnapshot::dir(hashmap! {
-            "roact" => VfsSnapshot::dir(hashmap! {
+        "default.project.json" => snapshot_from_fs_path(&root_dir.join("plugin.project.json"))?,
-                "src" => snapshot_from_fs_path(&plugin_modules.join("roact").join("src"))?
+        "plugin" => VfsSnapshot::dir(hashmap! {
-            }),
+            "fmt" => snapshot_from_fs_path(&plugin_dir.join("fmt"))?,
-            "promise" => VfsSnapshot::dir(hashmap! {
+            "http" => snapshot_from_fs_path(&plugin_dir.join("http"))?,
-                "lib" => snapshot_from_fs_path(&plugin_modules.join("promise").join("lib"))?
+            "log" => snapshot_from_fs_path(&plugin_dir.join("log"))?,
-            }),
+            "rbx_dom_lua" => snapshot_from_fs_path(&plugin_dir.join("rbx_dom_lua"))?,
-            "t" => VfsSnapshot::dir(hashmap! {
+            "src" => snapshot_from_fs_path(&plugin_dir.join("src"))?,
-                "lib" => snapshot_from_fs_path(&plugin_modules.join("t").join("lib"))?
+            "Packages" => snapshot_from_fs_path(&plugin_dir.join("Packages"))?,
-            }),
+            "Version.txt" => snapshot_from_fs_path(&plugin_dir.join("Version.txt"))?,
-            "flipper" => VfsSnapshot::dir(hashmap! {
+            "UploadDetails.json" => snapshot_from_fs_path(&plugin_dir.join("UploadDetails.json"))?,
-                "src" => snapshot_from_fs_path(&plugin_modules.join("flipper").join("src"))?
-            }),
         }),
     });
 
-    let out_path = Path::new(&out_dir).join("plugin.bincode");
+    let template_file = File::create(Path::new(&out_dir).join("templates.bincode"))?;
-    let out_file = File::create(&out_path)?;
+    let plugin_file = File::create(Path::new(&out_dir).join("plugin.bincode"))?;
 
-    bincode::serialize_into(out_file, &snapshot)?;
+    bincode::serialize_into(plugin_file, &plugin_snapshot)?;
+    bincode::serialize_into(template_file, &template_snapshot)?;
 
     println!("cargo:rerun-if-changed=build/windows/rojo-manifest.rc");
     println!("cargo:rerun-if-changed=build/windows/rojo.manifest");

crates/memofs/CHANGELOG.md

@@ -0,0 +1,33 @@
+# memofs Changelog
+
+## Unreleased Changes
+* Added `Vfs::canonicalize`. [#1201]
+
+## 0.3.1 (2025-11-27)
+* Added `Vfs::exists`. [#1169]
+* Added `create_dir` and `create_dir_all` to allow creating directories. [#937]
+
+[#1169]: https://github.com/rojo-rbx/rojo/pull/1169
+[#937]: https://github.com/rojo-rbx/rojo/pull/937
+
+## 0.3.0 (2024-03-15)
+* Changed `StdBackend` file watching component to use minimal recursive watches. [#830]
+* Added `Vfs::read_to_string` and `Vfs::read_to_string_lf_normalized` [#854]
+
+[#830]: https://github.com/rojo-rbx/rojo/pull/830
+[#854]: https://github.com/rojo-rbx/rojo/pull/854
+
+## 0.2.0 (2021-08-23)
+* Updated to `crossbeam-channel` 0.5.1.
+
+## 0.1.3 (2020-11-19)
+* Added `set_watch_enabled` to `Vfs` and `VfsLock` to allow turning off file watching.
+
+## 0.1.2 (2020-03-29)
+* `VfsSnapshot` now implements Serde's `Serialize` and `Deserialize` traits.
+
+## 0.1.1 (2020-03-18)
+* Improved error messages using the [fs-err](https://crates.io/crates/fs-err) crate.
+
+## 0.1.0 (2020-03-10)
+* Initial release

crates/memofs/Cargo.toml

@@ -1,8 +1,12 @@
 [package]
 name = "memofs"
 description = "Virtual filesystem with configurable backends."
-version = "0.2.0"
+version = "0.3.1"
-authors = ["Lucien Greathouse <me@lpghatguy.com>"]
+authors = [
+    "Lucien Greathouse <me@lpghatguy.com>",
+    "Micah Reid <git@dekkonot.com>",
+    "Ken Loeffler <kenloef@gmail.com>",
+]
 edition = "2018"
 readme = "README.md"
 license = "MIT"
@@ -11,7 +15,10 @@ homepage = "https://github.com/rojo-rbx/rojo/tree/master/memofs"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-crossbeam-channel = "0.5.1"
+crossbeam-channel = "0.5.12"
-fs-err = "2.3.0"
+fs-err = "2.11.0"
-notify = "4.0.15"
+notify = "4.0.17"
-serde = { version = "1.0", features = ["derive"] }
+serde = { version = "1.0.197", features = ["derive"] }
+
+[dev-dependencies]
+tempfile = "3.10.1"

crates/memofs/src/in_memory_fs.rs

@@ -50,6 +50,12 @@ impl InMemoryFs {
     }
 }
 
+impl Default for InMemoryFs {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 #[derive(Debug)]
 struct InMemoryFsInner {
     entries: HashMap<PathBuf, Entry>,
@@ -151,6 +157,11 @@ impl VfsBackend for InMemoryFs {
         )
     }
 
+    fn exists(&mut self, path: &Path) -> io::Result<bool> {
+        let inner = self.inner.lock().unwrap();
+        Ok(inner.entries.contains_key(path))
+    }
+
     fn read_dir(&mut self, path: &Path) -> io::Result<ReadDir> {
         let inner = self.inner.lock().unwrap();
 
@@ -170,6 +181,21 @@ impl VfsBackend for InMemoryFs {
         }
     }
 
+    fn create_dir(&mut self, path: &Path) -> io::Result<()> {
+        let mut inner = self.inner.lock().unwrap();
+        inner.load_snapshot(path.to_path_buf(), VfsSnapshot::empty_dir())
+    }
+
+    fn create_dir_all(&mut self, path: &Path) -> io::Result<()> {
+        let mut inner = self.inner.lock().unwrap();
+        let mut path_buf = path.to_path_buf();
+        while let Some(parent) = path_buf.parent() {
+            inner.load_snapshot(parent.to_path_buf(), VfsSnapshot::empty_dir())?;
+            path_buf.pop();
+        }
+        inner.load_snapshot(path.to_path_buf(), VfsSnapshot::empty_dir())
+    }
+
     fn remove_file(&mut self, path: &Path) -> io::Result<()> {
         let mut inner = self.inner.lock().unwrap();
 
@@ -206,6 +232,33 @@ impl VfsBackend for InMemoryFs {
         }
     }
 
+    // TODO: We rely on Rojo to prepend cwd to any relative path before storing paths
+    // in MemoFS. The current implementation will error if no prepended absolute path
+    // is found. It really only normalizes paths within the provided path's context.
+    // Example: "/Users/username/project/../other/file.txt" ->
+    // "/Users/username/other/file.txt"
+    // Erroneous example: "/Users/../../other/file.txt" -> "/other/file.txt"
+    // This is not very robust. We should implement proper path normalization here or otherwise
+    // warn if we are missing context and can not fully canonicalize the path correctly.
+    fn canonicalize(&mut self, path: &Path) -> io::Result<PathBuf> {
+        let mut normalized = PathBuf::new();
+        for component in path.components() {
+            match component {
+                std::path::Component::ParentDir => {
+                    normalized.pop();
+                }
+                std::path::Component::CurDir => {}
+                _ => normalized.push(component),
+            }
+        }
+
+        let inner = self.inner.lock().unwrap();
+        match inner.entries.get(&normalized) {
+            Some(_) => Ok(normalized),
+            None => not_found(&normalized),
+        }
+    }
+
     fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
         let inner = self.inner.lock().unwrap();
 
@@ -222,23 +275,17 @@ impl VfsBackend for InMemoryFs {
 }
 
 fn must_be_file<T>(path: &Path) -> io::Result<T> {
-    Err(io::Error::new(
+    Err(io::Error::other(format!(
-        io::ErrorKind::Other,
+        "path {} was a directory, but must be a file",
-        format!(
+        path.display()
-            "path {} was a directory, but must be a file",
+    )))
-            path.display()
-        ),
-    ))
 }
 
 fn must_be_dir<T>(path: &Path) -> io::Result<T> {
-    Err(io::Error::new(
+    Err(io::Error::other(format!(
-        io::ErrorKind::Other,
+        "path {} was a file, but must be a directory",
-        format!(
+        path.display()
-            "path {} was a file, but must be a directory",
+    )))
-            path.display()
-        ),
-    ))
 }
 
 fn not_found<T>(path: &Path) -> io::Result<T> {

crates/memofs/src/lib.rs

@@ -22,9 +22,9 @@ mod noop_backend;
 mod snapshot;
 mod std_backend;
 
-use std::io;
 use std::path::{Path, PathBuf};
 use std::sync::{Arc, Mutex, MutexGuard};
+use std::{io, str};
 
 pub use in_memory_fs::InMemoryFs;
 pub use noop_backend::NoopBackend;
@@ -70,10 +70,14 @@ impl<T> IoResultExt<T> for io::Result<T> {
 pub trait VfsBackend: sealed::Sealed + Send + 'static {
     fn read(&mut self, path: &Path) -> io::Result<Vec<u8>>;
     fn write(&mut self, path: &Path, data: &[u8]) -> io::Result<()>;
+    fn exists(&mut self, path: &Path) -> io::Result<bool>;
     fn read_dir(&mut self, path: &Path) -> io::Result<ReadDir>;
+    fn create_dir(&mut self, path: &Path) -> io::Result<()>;
+    fn create_dir_all(&mut self, path: &Path) -> io::Result<()>;
     fn metadata(&mut self, path: &Path) -> io::Result<Metadata>;
     fn remove_file(&mut self, path: &Path) -> io::Result<()>;
     fn remove_dir_all(&mut self, path: &Path) -> io::Result<()>;
+    fn canonicalize(&mut self, path: &Path) -> io::Result<PathBuf>;
 
     fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent>;
     fn watch(&mut self, path: &Path) -> io::Result<()>;
@@ -155,6 +159,29 @@ impl VfsInner {
         Ok(Arc::new(contents))
     }
 
+    fn read_to_string<P: AsRef<Path>>(&mut self, path: P) -> io::Result<Arc<String>> {
+        let path = path.as_ref();
+        let contents = self.backend.read(path)?;
+
+        if self.watch_enabled {
+            self.backend.watch(path)?;
+        }
+
+        let contents_str = str::from_utf8(&contents).map_err(|_| {
+            io::Error::new(
+                io::ErrorKind::InvalidData,
+                format!("File was not valid UTF-8: {}", path.display()),
+            )
+        })?;
+
+        Ok(Arc::new(contents_str.into()))
+    }
+
+    fn exists<P: AsRef<Path>>(&mut self, path: P) -> io::Result<bool> {
+        let path = path.as_ref();
+        self.backend.exists(path)
+    }
+
     fn write<P: AsRef<Path>, C: AsRef<[u8]>>(&mut self, path: P, contents: C) -> io::Result<()> {
         let path = path.as_ref();
         let contents = contents.as_ref();
@@ -172,6 +199,16 @@ impl VfsInner {
         Ok(dir)
     }
 
+    fn create_dir<P: AsRef<Path>>(&mut self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.backend.create_dir(path)
+    }
+
+    fn create_dir_all<P: AsRef<Path>>(&mut self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.backend.create_dir_all(path)
+    }
+
     fn remove_file<P: AsRef<Path>>(&mut self, path: P) -> io::Result<()> {
         let path = path.as_ref();
         let _ = self.backend.unwatch(path);
@@ -189,16 +226,18 @@ impl VfsInner {
         self.backend.metadata(path)
     }
 
+    fn canonicalize<P: AsRef<Path>>(&mut self, path: P) -> io::Result<PathBuf> {
+        let path = path.as_ref();
+        self.backend.canonicalize(path)
+    }
+
     fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
         self.backend.event_receiver()
     }
 
     fn commit_event(&mut self, event: &VfsEvent) -> io::Result<()> {
-        match event {
+        if let VfsEvent::Remove(path) = event {
-            VfsEvent::Remove(path) => {
+            let _ = self.backend.unwatch(path);
-                let _ = self.backend.unwatch(&path);
-            }
-            _ => {}
         }
 
         Ok(())
@@ -261,6 +300,33 @@ impl Vfs {
         self.inner.lock().unwrap().read(path)
     }
 
+    /// Read a file from the VFS (or from the underlying backend if it isn't
+    /// resident) into a string.
+    ///
+    /// Roughly equivalent to [`std::fs::read_to_string`][std::fs::read_to_string].
+    ///
+    /// [std::fs::read_to_string]: https://doc.rust-lang.org/stable/std/fs/fn.read_to_string.html
+    #[inline]
+    pub fn read_to_string<P: AsRef<Path>>(&self, path: P) -> io::Result<Arc<String>> {
+        let path = path.as_ref();
+        self.inner.lock().unwrap().read_to_string(path)
+    }
+
+    /// Read a file from the VFS (or the underlying backend if it isn't
+    /// resident) into a string, and normalize its line endings to LF.
+    ///
+    /// Roughly equivalent to [`std::fs::read_to_string`][std::fs::read_to_string], but also performs
+    /// line ending normalization.
+    ///
+    /// [std::fs::read_to_string]: https://doc.rust-lang.org/stable/std/fs/fn.read_to_string.html
+    #[inline]
+    pub fn read_to_string_lf_normalized<P: AsRef<Path>>(&self, path: P) -> io::Result<Arc<String>> {
+        let path = path.as_ref();
+        let contents = self.inner.lock().unwrap().read_to_string(path)?;
+
+        Ok(contents.replace("\r\n", "\n").into())
+    }
+
     /// Write a file to the VFS and the underlying backend.
     ///
     /// Roughly equivalent to [`std::fs::write`][std::fs::write].
@@ -284,6 +350,42 @@ impl Vfs {
         self.inner.lock().unwrap().read_dir(path)
     }
 
+    /// Return whether the given path exists.
+    ///
+    /// Roughly equivalent to [`std::fs::exists`][std::fs::exists].
+    ///
+    /// [std::fs::exists]: https://doc.rust-lang.org/stable/std/fs/fn.exists.html
+    #[inline]
+    pub fn exists<P: AsRef<Path>>(&self, path: P) -> io::Result<bool> {
+        let path = path.as_ref();
+        self.inner.lock().unwrap().exists(path)
+    }
+
+    /// Creates a directory at the provided location.
+    ///
+    /// Roughly equivalent to [`std::fs::create_dir`][std::fs::create_dir].
+    /// Similiar to that function, this function will fail if the parent of the
+    /// path does not exist.
+    ///
+    /// [std::fs::create_dir]: https://doc.rust-lang.org/stable/std/fs/fn.create_dir.html
+    #[inline]
+    pub fn create_dir<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.inner.lock().unwrap().create_dir(path)
+    }
+
+    /// Creates a directory at the provided location, recursively creating
+    /// all parent components if they are missing.
+    ///
+    /// Roughly equivalent to [`std::fs::create_dir_all`][std::fs::create_dir_all].
+    ///
+    /// [std::fs::create_dir_all]: https://doc.rust-lang.org/stable/std/fs/fn.create_dir_all.html
+    #[inline]
+    pub fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.inner.lock().unwrap().create_dir_all(path)
+    }
+
     /// Remove a file.
     ///
     /// Roughly equivalent to [`std::fs::remove_file`][std::fs::remove_file].
@@ -317,6 +419,19 @@ impl Vfs {
         self.inner.lock().unwrap().metadata(path)
     }
 
+    /// Normalize a path via the underlying backend.
+    ///
+    /// Roughly equivalent to [`std::fs::canonicalize`][std::fs::canonicalize]. Relative paths are
+    /// resolved against the backend's current working directory (if applicable) and errors are
+    /// surfaced directly from the backend.
+    ///
+    /// [std::fs::canonicalize]: https://doc.rust-lang.org/stable/std/fs/fn.canonicalize.html
+    #[inline]
+    pub fn canonicalize<P: AsRef<Path>>(&self, path: P) -> io::Result<PathBuf> {
+        let path = path.as_ref();
+        self.inner.lock().unwrap().canonicalize(path)
+    }
+
     /// Retrieve a handle to the event receiver for this `Vfs`.
     #[inline]
     pub fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
@@ -386,6 +501,31 @@ impl VfsLock<'_> {
         self.inner.read_dir(path)
     }
 
+    /// Creates a directory at the provided location.
+    ///
+    /// Roughly equivalent to [`std::fs::create_dir`][std::fs::create_dir].
+    /// Similiar to that function, this function will fail if the parent of the
+    /// path does not exist.
+    ///
+    /// [std::fs::create_dir]: https://doc.rust-lang.org/stable/std/fs/fn.create_dir.html
+    #[inline]
+    pub fn create_dir<P: AsRef<Path>>(&mut self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.inner.create_dir(path)
+    }
+
+    /// Creates a directory at the provided location, recursively creating
+    /// all parent components if they are missing.
+    ///
+    /// Roughly equivalent to [`std::fs::create_dir_all`][std::fs::create_dir_all].
+    ///
+    /// [std::fs::create_dir_all]: https://doc.rust-lang.org/stable/std/fs/fn.create_dir_all.html
+    #[inline]
+    pub fn create_dir_all<P: AsRef<Path>>(&mut self, path: P) -> io::Result<()> {
+        let path = path.as_ref();
+        self.inner.create_dir_all(path)
+    }
+
     /// Remove a file.
     ///
     /// Roughly equivalent to [`std::fs::remove_file`][std::fs::remove_file].
@@ -419,6 +559,13 @@ impl VfsLock<'_> {
         self.inner.metadata(path)
     }
 
+    /// Normalize a path via the underlying backend.
+    #[inline]
+    pub fn normalize<P: AsRef<Path>>(&mut self, path: P) -> io::Result<PathBuf> {
+        let path = path.as_ref();
+        self.inner.canonicalize(path)
+    }
+
     /// Retrieve a handle to the event receiver for this `Vfs`.
     #[inline]
     pub fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
@@ -431,3 +578,83 @@ impl VfsLock<'_> {
         self.inner.commit_event(event)
     }
 }
+
+#[cfg(test)]
+mod test {
+    use crate::{InMemoryFs, StdBackend, Vfs, VfsSnapshot};
+    use std::io;
+    use std::path::PathBuf;
+
+    /// https://github.com/rojo-rbx/rojo/issues/899
+    #[test]
+    fn read_to_string_lf_normalized_keeps_trailing_newline() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("test", VfsSnapshot::file("bar\r\nfoo\r\n\r\n"))
+            .unwrap();
+
+        let vfs = Vfs::new(imfs);
+
+        assert_eq!(
+            vfs.read_to_string_lf_normalized("test").unwrap().as_str(),
+            "bar\nfoo\n\n"
+        );
+    }
+
+    /// https://github.com/rojo-rbx/rojo/issues/1200
+    #[test]
+    fn canonicalize_in_memory_success() {
+        let mut imfs = InMemoryFs::new();
+        let contents = "Lorem ipsum dolor sit amet.".to_string();
+
+        imfs.load_snapshot("/test/file.txt", VfsSnapshot::file(contents.to_string()))
+            .unwrap();
+
+        let vfs = Vfs::new(imfs);
+
+        assert_eq!(
+            vfs.canonicalize("/test/nested/../file.txt").unwrap(),
+            PathBuf::from("/test/file.txt")
+        );
+        assert_eq!(
+            vfs.read_to_string(vfs.canonicalize("/test/nested/../file.txt").unwrap())
+                .unwrap()
+                .to_string(),
+            contents.to_string()
+        );
+    }
+
+    #[test]
+    fn canonicalize_in_memory_missing_errors() {
+        let imfs = InMemoryFs::new();
+        let vfs = Vfs::new(imfs);
+
+        let err = vfs.canonicalize("test").unwrap_err();
+        assert_eq!(err.kind(), io::ErrorKind::NotFound);
+    }
+
+    #[test]
+    fn canonicalize_std_backend_success() {
+        let contents = "Lorem ipsum dolor sit amet.".to_string();
+        let dir = tempfile::tempdir().unwrap();
+        let file_path = dir.path().join("file.txt");
+        fs_err::write(&file_path, contents.to_string()).unwrap();
+
+        let vfs = Vfs::new(StdBackend::new());
+        let canonicalized = vfs.canonicalize(&file_path).unwrap();
+        assert_eq!(canonicalized, file_path.canonicalize().unwrap());
+        assert_eq!(
+            vfs.read_to_string(&canonicalized).unwrap().to_string(),
+            contents.to_string()
+        );
+    }
+
+    #[test]
+    fn canonicalize_std_backend_missing_errors() {
+        let dir = tempfile::tempdir().unwrap();
+        let file_path = dir.path().join("test");
+
+        let vfs = Vfs::new(StdBackend::new());
+        let err = vfs.canonicalize(&file_path).unwrap_err();
+        assert_eq!(err.kind(), io::ErrorKind::NotFound);
+    }
+}

crates/memofs/src/noop_backend.rs

@@ -0,0 +1,74 @@
+use std::io;
+use std::path::{Path, PathBuf};
+
+use crate::{Metadata, ReadDir, VfsBackend, VfsEvent};
+
+/// `VfsBackend` that returns an error on every operation.
+#[non_exhaustive]
+pub struct NoopBackend;
+
+impl NoopBackend {
+    pub fn new() -> Self {
+        Self
+    }
+}
+
+impl VfsBackend for NoopBackend {
+    fn read(&mut self, _path: &Path) -> io::Result<Vec<u8>> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn write(&mut self, _path: &Path, _data: &[u8]) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn exists(&mut self, _path: &Path) -> io::Result<bool> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn read_dir(&mut self, _path: &Path) -> io::Result<ReadDir> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn create_dir(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn create_dir_all(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn remove_file(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn remove_dir_all(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn metadata(&mut self, _path: &Path) -> io::Result<Metadata> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn canonicalize(&mut self, _path: &Path) -> io::Result<PathBuf> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
+        crossbeam_channel::never()
+    }
+
+    fn watch(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+
+    fn unwatch(&mut self, _path: &Path) -> io::Result<()> {
+        Err(io::Error::other("NoopBackend doesn't do anything"))
+    }
+}
+
+impl Default for NoopBackend {
+    fn default() -> Self {
+        Self::new()
+    }
+}

crates/memofs/src/std_backend.rs

@@ -1,8 +1,8 @@
-use std::io;
+use std::path::{Path, PathBuf};
-use std::path::Path;
 use std::sync::mpsc;
 use std::thread;
 use std::time::Duration;
+use std::{collections::HashSet, io};
 
 use crossbeam_channel::Receiver;
 use notify::{watcher, DebouncedEvent, RecommendedWatcher, RecursiveMode, Watcher};
@@ -13,6 +13,7 @@ use crate::{DirEntry, Metadata, ReadDir, VfsBackend, VfsEvent};
 pub struct StdBackend {
     watcher: RecommendedWatcher,
     watcher_receiver: Receiver<VfsEvent>,
+    watches: HashSet<PathBuf>,
 }
 
 impl StdBackend {
@@ -48,6 +49,7 @@ impl StdBackend {
         Self {
             watcher,
             watcher_receiver: rx,
+            watches: HashSet::new(),
         }
     }
 }
@@ -61,6 +63,10 @@ impl VfsBackend for StdBackend {
         fs_err::write(path, data)
     }
 
+    fn exists(&mut self, path: &Path) -> io::Result<bool> {
+        std::fs::exists(path)
+    }
+
     fn read_dir(&mut self, path: &Path) -> io::Result<ReadDir> {
         let entries: Result<Vec<_>, _> = fs_err::read_dir(path)?.collect();
         let mut entries = entries?;
@@ -76,6 +82,14 @@ impl VfsBackend for StdBackend {
         })
     }
 
+    fn create_dir(&mut self, path: &Path) -> io::Result<()> {
+        fs_err::create_dir(path)
+    }
+
+    fn create_dir_all(&mut self, path: &Path) -> io::Result<()> {
+        fs_err::create_dir_all(path)
+    }
+
     fn remove_file(&mut self, path: &Path) -> io::Result<()> {
         fs_err::remove_file(path)
     }
@@ -92,19 +106,37 @@ impl VfsBackend for StdBackend {
         })
     }
 
+    fn canonicalize(&mut self, path: &Path) -> io::Result<PathBuf> {
+        fs_err::canonicalize(path)
+    }
+
     fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
         self.watcher_receiver.clone()
     }
 
     fn watch(&mut self, path: &Path) -> io::Result<()> {
-        self.watcher
+        if self.watches.contains(path)
-            .watch(path, RecursiveMode::NonRecursive)
+            || path
-            .map_err(|inner| io::Error::new(io::ErrorKind::Other, inner))
+                .ancestors()
+                .any(|ancestor| self.watches.contains(ancestor))
+        {
+            Ok(())
+        } else {
+            self.watches.insert(path.to_path_buf());
+            self.watcher
+                .watch(path, RecursiveMode::Recursive)
+                .map_err(io::Error::other)
+        }
     }
 
     fn unwatch(&mut self, path: &Path) -> io::Result<()> {
-        self.watcher
+        self.watches.remove(path);
-            .unwatch(path)
+        self.watcher.unwatch(path).map_err(io::Error::other)
-            .map_err(|inner| io::Error::new(io::ErrorKind::Other, inner))
+    }
+}
+
+impl Default for StdBackend {
+    fn default() -> Self {
+        Self::new()
     }
 }

crates/rojo-insta-ext/Cargo.toml

@@ -6,5 +6,5 @@ edition = "2018"
 publish = false
 
 [dependencies]
-serde = "1.0.99"
+serde = "1.0.197"
-serde_yaml = "0.8.9"
+serde_yaml = "0.8.26"

crates/rojo-insta-ext/src/redaction_map.rs

@@ -5,19 +5,13 @@ use serde::Serialize;
 /// Enables redacting any value that serializes as a string.
 ///
 /// Used for transforming Rojo instance IDs into something deterministic.
+#[derive(Default)]
 pub struct RedactionMap {
     ids: HashMap<String, usize>,
     last_id: usize,
 }
 
 impl RedactionMap {
-    pub fn new() -> Self {
-        Self {
-            ids: HashMap::new(),
-            last_id: 0,
-        }
-    }
-
     pub fn get_redacted_value(&self, id: impl ToString) -> Option<String> {
         let id = id.to_string();
 
@@ -28,6 +22,12 @@ impl RedactionMap {
         }
     }
 
+    /// Returns the numeric ID that was assigned to the provided value,
+    /// if one exists.
+    pub fn get_id_for_value(&self, value: impl ToString) -> Option<usize> {
+        self.ids.get(&value.to_string()).cloned()
+    }
+
     pub fn intern(&mut self, id: impl ToString) {
         let last_id = &mut self.last_id;
 

foreman.toml

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

memofs/CHANGELOG.md

@@ -1,18 +0,0 @@
-# memofs Changelog
-
-## Unreleased Changes
-
-## 0.2.0 (2021-08-23)
-* Updated to `crossbeam-channel` 0.5.1.
-
-## 0.1.3 (2020-11-19)
-* Added `set_watch_enabled` to `Vfs` and `VfsLock` to allow turning off file watching.
-
-## 0.1.2 (2020-03-29)
-* `VfsSnapshot` now implements Serde's `Serialize` and `Deserialize` traits.
-
-## 0.1.1 (2020-03-18)
-* Improved error messages using the [fs-err](https://crates.io/crates/fs-err) crate.
-
-## 0.1.0 (2020-03-10)
-* Initial release

memofs/src/noop_backend.rs

@@ -1,76 +0,0 @@
-use std::io;
-use std::path::Path;
-
-use crate::{Metadata, ReadDir, VfsBackend, VfsEvent};
-
-/// `VfsBackend` that returns an error on every operation.
-#[non_exhaustive]
-pub struct NoopBackend;
-
-impl NoopBackend {
-    pub fn new() -> Self {
-        Self
-    }
-}
-
-impl VfsBackend for NoopBackend {
-    fn read(&mut self, _path: &Path) -> io::Result<Vec<u8>> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn write(&mut self, _path: &Path, _data: &[u8]) -> io::Result<()> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn read_dir(&mut self, _path: &Path) -> io::Result<ReadDir> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn remove_file(&mut self, _path: &Path) -> io::Result<()> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn remove_dir_all(&mut self, _path: &Path) -> io::Result<()> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn metadata(&mut self, _path: &Path) -> io::Result<Metadata> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn event_receiver(&self) -> crossbeam_channel::Receiver<VfsEvent> {
-        crossbeam_channel::never()
-    }
-
-    fn watch(&mut self, _path: &Path) -> io::Result<()> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-
-    fn unwatch(&mut self, _path: &Path) -> io::Result<()> {
-        Err(io::Error::new(
-            io::ErrorKind::Other,
-            "NoopBackend doesn't do anything",
-        ))
-    }
-}

plugin.project.json

@@ -0,0 +1,30 @@
+{
+  "name": "Rojo",
+  "tree": {
+    "$className": "Folder",
+    "Plugin": {
+      "$path": "plugin/src"
+    },
+    "Packages": {
+      "$path": "plugin/Packages",
+      "Log": {
+        "$path": "plugin/log"
+      },
+      "Http": {
+        "$path": "plugin/http"
+      },
+      "Fmt": {
+        "$path": "plugin/fmt"
+      },
+      "RbxDom": {
+        "$path": "plugin/rbx_dom_lua"
+      }
+    },
+    "Version": {
+      "$path": "plugin/Version.txt"
+    },
+    "UploadDetails": {
+      "$path": "plugin/UploadDetails.json"
+    }
+  }
+}

plugin/UploadDetails.json

@@ -0,0 +1,7 @@
+{
+  "assetId": 13916111004,
+  "name": "Rojo",
+  "description": "The plugin portion of Rojo, a tool to enable professional tooling for Roblox developers.",
+  "creatorId": 32644114,
+  "creatorType": "Group"
+}

plugin/Version.txt

@@ -0,0 +1 @@
+7.7.0-rc.1

plugin/default.project.json

@@ -1,33 +0,0 @@
-{
-  "name": "Rojo",
-  "tree": {
-    "$className": "Folder",
-    "Plugin": {
-      "$path": "src"
-    },
-    "Log": {
-      "$path": "log"
-    },
-    "Http": {
-      "$path": "http"
-    },
-    "Fmt": {
-      "$path": "fmt"
-    },
-    "RbxDom": {
-      "$path": "rbx_dom_lua"
-    },
-    "Roact": {
-      "$path": "modules/roact/src"
-    },
-    "Promise": {
-      "$path": "modules/promise/lib"
-    },
-    "t": {
-      "$path": "modules/t/lib"
-    },
-    "Flipper": {
-      "$path": "modules/flipper/src"
-    }
-  }
-}

plugin/fmt/init.lua

@@ -25,7 +25,7 @@
 local function defaultTableDebug(buffer, input)
 	buffer:writeRaw("{")
 
-	for key, value in pairs(input) do
+	for key, value in input do
 		buffer:write("[{:?}] = {:?}", key, value)
 
 		if next(input, key) ~= nil then
@@ -50,7 +50,7 @@ local function defaultTableDebugExtended(buffer, input)
 	buffer:writeLineRaw("{")
 	buffer:indent()
 
-	for key, value in pairs(input) do
+	for key, value in input do
 		buffer:writeLine("[{:?}] = {:#?},", key, value)
 	end
 
@@ -70,7 +70,7 @@ local function debugImpl(buffer, value, extendedForm)
 	elseif valueType == "table" then
 		local valueMeta = getmetatable(value)
 
-		if valueMeta ~= nil and  valueMeta.__fmtDebug ~= nil then
+		if valueMeta ~= nil and valueMeta.__fmtDebug ~= nil then
 			-- This type implement's the metamethod we made up to line up with
 			-- Rust's 'Debug' trait.
 

plugin/http/Error.lua

@@ -3,12 +3,12 @@ Error.__index = Error
 
 Error.Kind = {
 	HttpNotEnabled = {
-		message = "Rojo requires HTTP access, which is not enabled.\n" ..
+		message = "Rojo requires HTTP access, which is not enabled.\n"
-			"Check your game settings, located in the 'Home' tab of Studio.",
+			.. "Check your game settings, located in the 'Home' tab of Studio.",
 	},
 	ConnectFailed = {
-		message = "Couldn't connect to the Rojo server.\n" ..
+		message = "Couldn't connect to the Rojo server.\n"
-			"Make sure the server is running — use 'rojo serve' to run it!",
+			.. "Make sure the server is running — use 'rojo serve' to run it!",
 	},
 	Timeout = {
 		message = "HTTP request timed out.",
@@ -63,4 +63,13 @@ function Error.fromRobloxErrorString(message)
 	return Error.new(Error.Kind.Unknown, message)
 end
 
+function Error.fromResponse(response)
+	local lower = (response.body or ""):lower()
+	if response.code == 408 or response.code == 504 or lower:find("timed? ?out") then
+		return Error.new(Error.Kind.Timeout)
+	end
+
+	return Error.new(Error.Kind.Unknown, string.format("%s: %s", tostring(response.code), tostring(response.body)))
+end
+
 return Error

plugin/http/Response.lua

@@ -1,5 +1,7 @@
 local HttpService = game:GetService("HttpService")
 
+local msgpack = require(script.Parent.Parent.msgpack)
+
 local stringTemplate = [[
 Http.Response {
 	code: %d
@@ -31,4 +33,8 @@ function Response:json()
 	return HttpService:JSONDecode(self.body)
 end
 
+function Response:msgpack()
+	return msgpack.decode(self.body)
+end
+
 return Response

plugin/http/init.lua

@@ -1,7 +1,8 @@
 local HttpService = game:GetService("HttpService")
 
-local Promise = require(script.Parent.Promise)
 local Log = require(script.Parent.Log)
+local msgpack = require(script.Parent.msgpack)
+local Promise = require(script.Parent.Promise)
 
 local HttpError = require(script.Error)
 local HttpResponse = require(script.Response)
@@ -30,8 +31,13 @@ local function performRequest(requestParams)
 			end)
 
 			if success then
-				Log.trace("Request {} success, status code {}", requestId, response.StatusCode)
+				Log.trace("Request {} success, response {:#?}", requestId, response)
-				resolve(HttpResponse.fromRobloxResponse(response))
+				local httpResponse = HttpResponse.fromRobloxResponse(response)
+				if httpResponse:isSuccess() then
+					resolve(httpResponse)
+				else
+					reject(HttpError.fromResponse(httpResponse))
+				end
 			else
 				Log.trace("Request {} failure: {:?}", requestId, response)
 				reject(HttpError.fromRobloxErrorString(response))
@@ -63,4 +69,12 @@ function Http.jsonDecode(source)
 	return HttpService:JSONDecode(source)
 end
 
+function Http.msgpackEncode(object)
+	return msgpack.encode(object)
+end
+
+function Http.msgpackDecode(source)
+	return msgpack.decode(source)
+end
+
 return Http