Upload plugin as part of release workflow (#1227)

.github/workflows/release.yml

@@ -44,6 +44,13 @@ jobs:
         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"]

.gitmodules

@@ -19,3 +19,6 @@
 [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

.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

CHANGELOG.md

@@ -33,7 +33,6 @@ Making a new release? Simply add the new header with the version and date undern
 
 * `inf` and `nan` values in properties are now synced ([#1176])
 * Fixed a bug caused by having reference properties (such as `ObjectValue.Value`) that point to an Instance not included in syncback. ([#1179])
-* Implemented support for the "name" property in meta/model JSON files. ([#1187])
 * Fixed instance replacement fallback failing when too many instances needed to be replaced. ([#1192])
 * Added actors and bindable/remote event/function variants to be synced back as JSON files. ([#1199])
 * Fixed a bug where MacOS paths weren't being handled correctly. ([#1201])
@@ -43,7 +42,6 @@ Making a new release? Simply add the new header with the version and date undern
 
 [#1176]: https://github.com/rojo-rbx/rojo/pull/1176
 [#1179]: https://github.com/rojo-rbx/rojo/pull/1179
-[#1187]: https://github.com/rojo-rbx/rojo/pull/1187
 [#1192]: https://github.com/rojo-rbx/rojo/pull/1192
 [#1199]: https://github.com/rojo-rbx/rojo/pull/1199
 [#1201]: https://github.com/rojo-rbx/rojo/pull/1201

build.rs

@@ -75,6 +75,7 @@ fn main() -> Result<(), anyhow::Error> {
             "src" => snapshot_from_fs_path(&plugin_dir.join("src"))?,
             "Packages" => snapshot_from_fs_path(&plugin_dir.join("Packages"))?,
             "Version.txt" => snapshot_from_fs_path(&plugin_dir.join("Version.txt"))?,
+            "UploadDetails.json" => snapshot_from_fs_path(&plugin_dir.join("UploadDetails.json"))?,
         }),
     });
 

plugin.project.json

@@ -22,6 +22,9 @@
     },
     "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"
+}

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

@@ -0,0 +1,16 @@
+---
+source: tests/tests/build.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">json_model_legacy_name</string>
+    </Properties>
+    <Item class="Folder" referent="1">
+      <Properties>
+        <string name="Name">Expected Name</string>
+      </Properties>
+    </Item>
+  </Item>
+</roblox>

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

@@ -1,23 +0,0 @@
----
-source: tests/tests/build.rs
-assertion_line: 109
-expression: contents
----
-<roblox version="4">
-  <Item class="DataModel" referent="0">
-    <Properties>
-      <string name="Name">model_json_name_input</string>
-    </Properties>
-    <Item class="Workspace" referent="1">
-      <Properties>
-        <string name="Name">Workspace</string>
-        <bool name="NeedsPivotMigration">false</bool>
-      </Properties>
-      <Item class="StringValue" referent="2">
-        <Properties>
-          <string name="Name">/Bar</string>
-        </Properties>
-      </Item>
-    </Item>
-  </Item>
-</roblox>

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

@@ -1,20 +0,0 @@
----
-source: tests/tests/build.rs
-assertion_line: 108
-expression: contents
----
-<roblox version="4">
-  <Item class="Folder" referent="0">
-    <Properties>
-      <string name="Name">slugified_name_roundtrip</string>
-    </Properties>
-    <Item class="Script" referent="1">
-      <Properties>
-        <string name="Name">/Script</string>
-        <token name="RunContext">0</token>
-        <string name="Source"><![CDATA[print("Hello world!")
-]]></string>
-      </Properties>
-    </Item>
-  </Item>
-</roblox>

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

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

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

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

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

@@ -1,11 +0,0 @@
-{
-  "name": "model_json_name_input",
-  "tree": {
-    "$className": "DataModel",
-    "Workspace": {
-      "$className": "Workspace",
-      "$path": "src"
-    }
-  }
-}
-

rojo-test/build-tests/model_json_name_input/src/Bar.model.json

@@ -1,5 +0,0 @@
-{
-  "name": "/Bar",
-  "className": "StringValue"
-}
-

rojo-test/build-tests/slugified_name_roundtrip/_Script/init.meta.json

@@ -1,4 +0,0 @@
-{
-  "name": "/Script"
-}
-

rojo-test/build-tests/slugified_name_roundtrip/_Script/init.server.luau

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

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

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

rojo-test/build-tests/slugified_name_roundtrip/src/_Script/init.meta.json

@@ -1,3 +0,0 @@
-{
-  "name": "/Script"
-}

rojo-test/build-tests/slugified_name_roundtrip/src/_Script/init.server.luau

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

rojo-test/syncback-test-snapshots/end_to_end__rojo_test__syncback_util__model_json_name-stdout.snap

@@ -1,6 +0,0 @@
----
-source: tests/rojo_test/syncback_util.rs
-assertion_line: 101
-expression: "String::from_utf8_lossy(&output.stdout)"
----
-

rojo-test/syncback-test-snapshots/end_to_end__rojo_test__syncback_util__slugified_name-stdout.snap

@@ -1,13 +0,0 @@
----
-source: tests/rojo_test/syncback_util.rs
-assertion_line: 101
-expression: "String::from_utf8_lossy(&output.stdout)"
----
-Writing default.project.json
-Writing src/Camera.rbxm
-Writing src/Terrain.rbxm
-Writing src/_Folder/init.meta.json
-Writing src/_Script.meta.json
-Writing src/_Script.server.luau
-Writing src
-Writing src/_Folder

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__model_json_name-src__foo.model.json.snap

@@ -1,9 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/foo.model.json
----
-{
-  "name": "/Bar",
-  "className": "StringValue"
-}

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Folder.model.json.snap

@@ -1,8 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Folder.model.json
----
-{
-  "className": "Folder"
-}

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Folder__init.meta.json.snap

@@ -1,8 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Folder/init.meta.json
----
-{
-  "name": "/Folder"
-}

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Script.meta.json.snap

@@ -1,8 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Script.meta.json
----
-{
-  "name": "/Script"
-}

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Script.server.luau.snap

@@ -1,6 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Script.server.luau
----
-print("Hello world!")

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Script__init.meta.json.snap

@@ -1,8 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Script/init.meta.json
----
-{
-  "name": "/Script"
-}

rojo-test/syncback-test-snapshots/end_to_end__tests__syncback__slugified_name-src___Script__init.server.luau.snap

@@ -1,6 +0,0 @@
----
-source: tests/tests/syncback.rs
-assertion_line: 31
-expression: src/_Script/init.server.luau
----
-print("Hello world!")

rojo-test/syncback-tests/model_json_name/input-project/default.project.json

@@ -1,11 +0,0 @@
-{
-  "name": "model_json_name",
-  "tree": {
-    "$className": "DataModel",
-    "Workspace": {
-      "$className": "Workspace",
-      "$path": "src"
-    }
-  }
-}
-

rojo-test/syncback-tests/model_json_name/input-project/src/foo.model.json

@@ -1,5 +0,0 @@
-{
-  "name": "/Bar",
-  "className": "StringValue"
-}
-

rojo-test/syncback-tests/slugified_name/input-project/default.project.json

@@ -1,10 +0,0 @@
-{
-  "name": "slugified_name",
-  "tree": {
-    "$className": "DataModel",
-    "Workspace": {
-      "$className": "Workspace",
-      "$path": "src"
-    }
-  }
-}

rokit.toml

@@ -3,3 +3,4 @@ rojo = "rojo-rbx/rojo@7.5.1"
 selene = "Kampfkarren/selene@0.29.0"
 stylua = "JohnnyMorganz/stylua@2.1.0"
 run-in-roblox = "rojo-rbx/run-in-roblox@0.3.0"
+lune = "lune-org/lune@0.10.4"

src/cli/plugin.rs

@@ -98,5 +98,5 @@ fn uninstall_plugin() -> anyhow::Result<()> {
 
 #[test]
 fn plugin_initialize() {
-    assert!(initialize_plugin().is_ok())
+    let _ = initialize_plugin().unwrap();
 }

src/snapshot/metadata.rs

@@ -70,12 +70,6 @@ pub struct InstanceMetadata {
     /// A schema provided via a JSON file, if one exists. Will be `None` for
     /// all non-JSON middleware.
     pub schema: Option<String>,
-
-    /// A custom name specified via meta.json or model.json files. If present,
-    /// this name will be used for the instance while the filesystem name will
-    /// be slugified to remove illegal characters.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub specified_name: Option<String>,
 }
 
 impl InstanceMetadata {
@@ -88,7 +82,6 @@ impl InstanceMetadata {
             specified_id: None,
             middleware: None,
             schema: None,
-            specified_name: None,
         }
     }
 
@@ -137,13 +130,6 @@ impl InstanceMetadata {
     pub fn schema(self, schema: Option<String>) -> Self {
         Self { schema, ..self }
     }
-
-    pub fn specified_name(self, specified_name: Option<String>) -> Self {
-        Self {
-            specified_name,
-            ..self
-        }
-    }
 }
 
 impl Default for InstanceMetadata {

src/snapshot_middleware/json_model.rs

@@ -35,14 +35,20 @@ pub fn snapshot_json_model(
         format!("File is not a valid JSON model: {}", path.display())
     })?;
 
-    // If the JSON has a name property, preserve it in metadata for syncback
-    let specified_name = instance.name.clone();
+    if let Some(top_level_name) = &instance.name {
+        let new_name = format!("{}.model.json", top_level_name);
 
-    // Use the name from JSON if present, otherwise fall back to filename-derived name
-    if instance.name.is_none() {
-        instance.name = Some(name.to_owned());
+        log::warn!(
+            "Model at path {} had a top-level Name field. \
+            This field has been ignored since Rojo 6.0.\n\
+            Consider removing this field and renaming the file to {}.",
+            new_name,
+            path.display()
+        );
     }
 
+    instance.name = Some(name.to_owned());
+
     let id = instance.id.take().map(RojoRef::new);
     let schema = instance.schema.take();
 
@@ -56,8 +62,7 @@ pub fn snapshot_json_model(
         .relevant_paths(vec![vfs.canonicalize(path)?])
         .context(context)
         .specified_id(id)
-        .schema(schema)
-        .specified_name(specified_name);
+        .schema(schema);
 
     Ok(Some(snapshot))
 }
@@ -76,7 +81,6 @@ pub fn syncback_json_model<'sync>(
         // schemas will ever exist in one project for it to matter, but it
         // could have a performance cost.
         model.schema = old_inst.metadata().schema.clone();
-        model.name = old_inst.metadata().specified_name.clone();
     }
 
     Ok(SyncbackReturn {

src/snapshot_middleware/lua.rs

@@ -158,16 +158,8 @@ pub fn syncback_lua<'sync>(
 
         if !meta.is_empty() {
             let parent_location = snapshot.path.parent_err()?;
-            let instance_name = &snapshot.new_inst().name;
-            let slugified;
-            let meta_name = if crate::syncback::validate_file_name(instance_name).is_err() {
-                slugified = crate::syncback::slugify_name(instance_name);
-                &slugified
-            } else {
-                instance_name
-            };
             fs_snapshot.add_file(
-                parent_location.join(format!("{}.meta.json", meta_name)),
+                parent_location.join(format!("{}.meta.json", new_inst.name)),
                 serde_json::to_vec_pretty(&meta).context("cannot serialize metadata")?,
             );
         }

src/snapshot_middleware/meta_file.rs

@@ -10,10 +10,7 @@ use rbx_dom_weak::{
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    json,
-    resolution::UnresolvedValue,
-    snapshot::InstanceSnapshot,
-    syncback::{validate_file_name, SyncbackSnapshot},
+    json, resolution::UnresolvedValue, snapshot::InstanceSnapshot, syncback::SyncbackSnapshot,
     RojoRef,
 };
 
@@ -39,9 +36,6 @@ pub struct AdjacentMetadata {
     #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
     pub attributes: IndexMap<String, UnresolvedValue>,
 
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub name: Option<String>,
-
     #[serde(skip)]
     pub path: PathBuf,
 }
@@ -150,24 +144,6 @@ impl AdjacentMetadata {
             }
         }
 
-        let name = snapshot
-            .old_inst()
-            .and_then(|inst| inst.metadata().specified_name.clone())
-            .or_else(|| {
-                // If this is a new instance and its name is invalid for the filesystem,
-                // we need to specify the name in meta.json so it can be preserved
-                if snapshot.old_inst().is_none() {
-                    let instance_name = &snapshot.new_inst().name;
-                    if validate_file_name(instance_name).is_err() {
-                        Some(instance_name.clone())
-                    } else {
-                        None
-                    }
-                } else {
-                    None
-                }
-            });
-
         Ok(Some(Self {
             ignore_unknown_instances: if ignore_unknown_instances {
                 Some(true)
@@ -179,7 +155,6 @@ impl AdjacentMetadata {
             path,
             id: None,
             schema,
-            name,
         }))
     }
 
@@ -238,26 +213,11 @@ impl AdjacentMetadata {
         Ok(())
     }
 
-    fn apply_name(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
-        if self.name.is_some() && snapshot.metadata.specified_name.is_some() {
-            anyhow::bail!(
-                "cannot specify a name using {} (instance has a name from somewhere else)",
-                self.path.display()
-            );
-        }
-        if let Some(name) = &self.name {
-            snapshot.name = name.clone().into();
-        }
-        snapshot.metadata.specified_name = self.name.take();
-        Ok(())
-    }
-
     pub fn apply_all(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
         self.apply_ignore_unknown_instances(snapshot);
         self.apply_properties(snapshot)?;
         self.apply_id(snapshot)?;
         self.apply_schema(snapshot)?;
-        self.apply_name(snapshot)?;
         Ok(())
     }
 
@@ -266,13 +226,11 @@ impl AdjacentMetadata {
     ///
     /// - The number of properties and attributes is 0
     /// - `ignore_unknown_instances` is None
-    /// - `name` is None
     #[inline]
     pub fn is_empty(&self) -> bool {
         self.attributes.is_empty()
             && self.properties.is_empty()
             && self.ignore_unknown_instances.is_none()
-            && self.name.is_none()
     }
 
     // TODO: Add method to allow selectively applying parts of metadata and
@@ -304,9 +262,6 @@ pub struct DirectoryMetadata {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub class_name: Option<Ustr>,
 
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub name: Option<String>,
-
     #[serde(skip)]
     pub path: PathBuf,
 }
@@ -417,24 +372,6 @@ impl DirectoryMetadata {
             }
         }
 
-        let name = snapshot
-            .old_inst()
-            .and_then(|inst| inst.metadata().specified_name.clone())
-            .or_else(|| {
-                // If this is a new instance and its name is invalid for the filesystem,
-                // we need to specify the name in meta.json so it can be preserved
-                if snapshot.old_inst().is_none() {
-                    let instance_name = &snapshot.new_inst().name;
-                    if validate_file_name(instance_name).is_err() {
-                        Some(instance_name.clone())
-                    } else {
-                        None
-                    }
-                } else {
-                    None
-                }
-            });
-
         Ok(Some(Self {
             ignore_unknown_instances: if ignore_unknown_instances {
                 Some(true)
@@ -447,7 +384,6 @@ impl DirectoryMetadata {
             path,
             id: None,
             schema,
-            name,
         }))
     }
 
@@ -457,7 +393,6 @@ impl DirectoryMetadata {
         self.apply_properties(snapshot)?;
         self.apply_id(snapshot)?;
         self.apply_schema(snapshot)?;
-        self.apply_name(snapshot)?;
 
         Ok(())
     }
@@ -529,33 +464,17 @@ impl DirectoryMetadata {
         snapshot.metadata.schema = self.schema.take();
         Ok(())
     }
-
-    fn apply_name(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
-        if self.name.is_some() && snapshot.metadata.specified_name.is_some() {
-            anyhow::bail!(
-                "cannot specify a name using {} (instance has a name from somewhere else)",
-                self.path.display()
-            );
-        }
-        if let Some(name) = &self.name {
-            snapshot.name = name.clone().into();
-        }
-        snapshot.metadata.specified_name = self.name.take();
-        Ok(())
-    }
     /// Returns whether the metadata is 'empty', meaning it doesn't have anything
     /// worth persisting in it. Specifically:
     ///
     /// - The number of properties and attributes is 0
     /// - `ignore_unknown_instances` is None
     /// - `class_name` is either None or not Some("Folder")
-    /// - `name` is None
     #[inline]
     pub fn is_empty(&self) -> bool {
         self.attributes.is_empty()
             && self.properties.is_empty()
             && self.ignore_unknown_instances.is_none()
-            && self.name.is_none()
             && if let Some(class) = &self.class_name {
                 class == "Folder"
             } else {

src/syncback/file_names.rs

@@ -8,11 +8,11 @@ use rbx_dom_weak::Instance;
 
 use crate::{snapshot::InstanceWithMeta, snapshot_middleware::Middleware};
 
-pub fn name_for_inst<'a>(
+pub fn name_for_inst<'old>(
     middleware: Middleware,
-    new_inst: &'a Instance,
-    old_inst: Option<InstanceWithMeta<'a>>,
-) -> anyhow::Result<Cow<'a, str>> {
+    new_inst: &Instance,
+    old_inst: Option<InstanceWithMeta<'old>>,
+) -> anyhow::Result<Cow<'old, str>> {
     if let Some(old_inst) = old_inst {
         if let Some(source) = old_inst.metadata().relevant_paths.first() {
             source
@@ -35,24 +35,14 @@ pub fn name_for_inst<'a>(
             | Middleware::CsvDir
             | Middleware::ServerScriptDir
             | Middleware::ClientScriptDir
-            | Middleware::ModuleScriptDir => {
-                if validate_file_name(&new_inst.name).is_err() {
-                    Cow::Owned(slugify_name(&new_inst.name))
-                } else {
-                    Cow::Borrowed(&new_inst.name)
-                }
-            }
+            | Middleware::ModuleScriptDir => Cow::Owned(new_inst.name.clone()),
             _ => {
                 let extension = extension_for_middleware(middleware);
-                let slugified;
-                let final_name = if validate_file_name(&new_inst.name).is_err() {
-                    slugified = slugify_name(&new_inst.name);
-                    &slugified
-                } else {
-                    &new_inst.name
-                };
-
-                Cow::Owned(format!("{final_name}.{extension}"))
+                let name = &new_inst.name;
+                validate_file_name(name).with_context(|| {
+                    format!("name '{name}' is not legal to write to the file system")
+                })?;
+                Cow::Owned(format!("{name}.{extension}"))
             }
         })
     }
@@ -104,39 +94,6 @@ const INVALID_WINDOWS_NAMES: [&str; 22] = [
 /// in a file's name.
 const FORBIDDEN_CHARS: [char; 9] = ['<', '>', ':', '"', '/', '|', '?', '*', '\\'];
 
-/// Slugifies a name by replacing forbidden characters with underscores
-/// and ensuring the result is a valid file name
-pub fn slugify_name(name: &str) -> String {
-    let mut result = String::with_capacity(name.len());
-
-    for ch in name.chars() {
-        if FORBIDDEN_CHARS.contains(&ch) {
-            result.push('_');
-        } else {
-            result.push(ch);
-        }
-    }
-
-    // Handle Windows reserved names by appending an underscore
-    let result_lower = result.to_lowercase();
-    for forbidden in INVALID_WINDOWS_NAMES {
-        if result_lower == forbidden.to_lowercase() {
-            result.push('_');
-            break;
-        }
-    }
-
-    while result.ends_with(' ') || result.ends_with('.') {
-        result.pop();
-    }
-
-    if result.is_empty() || result.chars().all(|c| c == '_') {
-        result = "instance".to_string();
-    }
-
-    result
-}
-
 /// Validates a provided file name to ensure it's allowed on the file system. An
 /// error is returned if the name isn't allowed, indicating why.
 /// This takes into account rules for Windows, MacOS, and Linux.

src/syncback/mod.rs

@@ -28,7 +28,7 @@ use crate::{
     Project,
 };
 
-pub use file_names::{extension_for_middleware, name_for_inst, slugify_name, validate_file_name};
+pub use file_names::{extension_for_middleware, name_for_inst, validate_file_name};
 pub use fs_snapshot::FsSnapshot;
 pub use hash::*;
 pub use property_filter::{filter_properties, filter_properties_preallocated};

tests/tests/build.rs

@@ -41,6 +41,7 @@ gen_build_tests! {
     issue_546,
     json_as_lua,
     json_model_in_folder,
+    json_model_legacy_name,
     module_in_folder,
     module_init,
     nested_runcontext,
@@ -54,8 +55,6 @@ gen_build_tests! {
     script_meta_disabled,
     server_in_folder,
     server_init,
-    slugified_name_roundtrip,
-    model_json_name_input,
     txt,
     txt_in_folder,
     unresolved_values,

tests/tests/syncback.rs

@@ -86,9 +86,4 @@ syncback_tests! {
     sync_rules => ["src/module.modulescript", "src/text.text"],
     // Ensures that the `syncUnscriptable` setting works
     unscriptable_properties => ["default.project.json"],
-    // Ensures that instances with names containing illegal characters get slugified filenames
-    // and preserve their original names in meta.json without forcing directories for leaf scripts
-    slugified_name => ["src/_Script.meta.json", "src/_Script.server.luau", "src/_Folder/init.meta.json"],
-    // Ensures that .model.json files preserve the name property
-    model_json_name => ["src/foo.model.json"],
 }