Make the name field in projects optional

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Rojo Changelog
 
 ## Unreleased Changes
+* Made the `name` field optional on project files when they are not the top-level project ([#870])
+ 	Files named `default.project.json` inherit the name of the folder they're in and all other projects
+    are named as expect (e.g. `foo.project.json` becomes an Instance named `foo`)
+
+    There is no change in behavior if `name` is set.
 * Fixed incorrect results when serving model pivots ([#868])
 * Rojo now converts any line endings to LF, preventing spurious diffs when syncing Lua files on Windows ([#854])
 * Fixed Rojo plugin failing to connect when project contains certain unreadable properties ([#848])
@@ -63,6 +68,7 @@
 [#848]: https://github.com/rojo-rbx/rojo/pull/848
 [#854]: https://github.com/rojo-rbx/rojo/pull/854
 [#868]: https://github.com/rojo-rbx/rojo/pull/868
+[#870]: https://github.com/rojo-rbx/rojo/pull/870
 
 
 ## [7.4.0] - January 16, 2024

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

@@ -0,0 +1,22 @@
+---
+source: tests/tests/build.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">top-level</string>
+    </Properties>
+    <Item class="Folder" referent="1">
+      <Properties>
+        <string name="Name">second-level</string>
+      </Properties>
+      <Item class="IntValue" referent="2">
+        <Properties>
+          <string name="Name">third-level</string>
+          <int64 name="Value">1337</int64>
+        </Properties>
+      </Item>
+    </Item>
+  </Item>
+</roblox>

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

@@ -0,0 +1,22 @@
+---
+source: tests/tests/build.rs
+expression: contents
+---
+<roblox version="4">
+  <Item class="Folder" referent="0">
+    <Properties>
+      <string name="Name">no_name_project</string>
+    </Properties>
+    <Item class="Folder" referent="1">
+      <Properties>
+        <string name="Name">second-level</string>
+      </Properties>
+      <Item class="BoolValue" referent="2">
+        <Properties>
+          <string name="Name">bool_value</string>
+          <bool name="Value">true</bool>
+        </Properties>
+      </Item>
+    </Item>
+  </Item>
+</roblox>

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

@@ -0,0 +1,9 @@
+{
+  "name": "top-level",
+  "tree": {
+    "$className": "Folder",
+    "second-level": {
+      "$path": "src"
+    }
+  }
+}

rojo-test/build-tests/no_name_default_project/src/third-level/default.project.json

@@ -0,0 +1,8 @@
+{
+  "tree": {
+    "$className": "IntValue",
+    "$properties": {
+      "Value": 1337
+    }
+  }
+}

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

@@ -0,0 +1,9 @@
+{
+  "name": "no_name_project",
+  "tree": {
+    "$className": "Folder",
+    "second-level": {
+      "$path": "src"
+    }
+  }
+}

rojo-test/build-tests/no_name_project/src/bool_value.project.json

@@ -0,0 +1,8 @@
+{
+  "tree": {
+    "$className": "BoolValue",
+    "$properties": {
+      "Value": true
+    }
+  }
+}

rojo-test/serve-test-snapshots/end_to_end__tests__serve__no_name_default_project_all.snap

@@ -0,0 +1,39 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: top-level
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children:
+      - id-4
+    ClassName: Folder
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: second-level
+    Parent: id-2
+    Properties: {}
+  id-4:
+    Children: []
+    ClassName: IntValue
+    Id: id-4
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: third-level
+    Parent: id-3
+    Properties:
+      Value:
+        Int64: 1337
+messageCursor: 0
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__no_name_default_project_info.snap

@@ -0,0 +1,14 @@
+---
+source: tests/tests/serve.rs
+assertion_line: 316
+expression: redactions.redacted_yaml(info)
+---
+expectedPlaceIds: ~
+gameId: ~
+placeId: ~
+projectName: top-level
+protocolVersion: 4
+rootInstanceId: id-2
+serverVersion: "[server-version]"
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__no_name_project_all.snap

@@ -0,0 +1,40 @@
+---
+source: tests/tests/serve.rs
+assertion_line: 338
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: no_name_project
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children:
+      - id-4
+    ClassName: Folder
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: second-level
+    Parent: id-2
+    Properties: {}
+  id-4:
+    Children: []
+    ClassName: BoolValue
+    Id: id-4
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: bool_value
+    Parent: id-3
+    Properties:
+      Value:
+        Bool: true
+messageCursor: 0
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__no_name_project_info.snap

@@ -0,0 +1,14 @@
+---
+source: tests/tests/serve.rs
+assertion_line: 335
+expression: redactions.redacted_yaml(info)
+---
+expectedPlaceIds: ~
+gameId: ~
+placeId: ~
+projectName: no_name_project
+protocolVersion: 4
+rootInstanceId: id-2
+serverVersion: "[server-version]"
+sessionId: id-1
+

rojo-test/serve-tests/no_name_default_project/default.project.json

@@ -0,0 +1,9 @@
+{
+  "name": "top-level",
+  "tree": {
+    "$className": "Folder",
+    "second-level": {
+      "$path": "src"
+    }
+  }
+}

rojo-test/serve-tests/no_name_default_project/src/third-level/default.project.json

@@ -0,0 +1,8 @@
+{
+  "tree": {
+    "$className": "IntValue",
+    "$properties": {
+      "Value": 1337
+    }
+  }
+}

rojo-test/serve-tests/no_name_project/default.project.json

@@ -0,0 +1,9 @@
+{
+  "name": "no_name_project",
+  "tree": {
+    "$className": "Folder",
+    "second-level": {
+      "$path": "src"
+    }
+  }
+}

rojo-test/serve-tests/no_name_project/src/bool_value.project.json

@@ -0,0 +1,8 @@
+{
+  "tree": {
+    "$className": "BoolValue",
+    "$properties": {
+      "Value": true
+    }
+  }
+}

src/project.rs

@@ -39,7 +39,7 @@ enum Error {
 #[serde(deny_unknown_fields, rename_all = "camelCase")]
 pub struct Project {
     /// The name of the top-level instance described by the project.
-    pub name: String,
+    pub name: Option<String>,
 
     /// The tree of instances described by this project. Projects always
     /// describe at least one instance.

src/serve_session.rs

@@ -118,6 +118,9 @@ impl ServeSession {
                 });
             }
         };
+        if root_project.name.is_none() {
+            return Err(ServeSessionError::NoProjectName);
+        }
 
         let mut tree = RojoTree::new(InstanceSnapshot::new());
 
@@ -190,7 +193,10 @@ impl ServeSession {
     }
 
     pub fn project_name(&self) -> &str {
-        &self.root_project.name
+        self.root_project
+            .name
+            .as_ref()
+            .expect("all top-level projects must have their name set")
     }
 
     pub fn project_port(&self) -> Option<u16> {
@@ -231,6 +237,9 @@ pub enum ServeSessionError {
     )]
     NoProjectFound { path: PathBuf },
 
+    #[error("Rojo requires the top-level project file to have the 'name' field set.")]
+    NoProjectName,
+
     #[error(transparent)]
     Io {
         #[from]

src/snapshot_middleware/mod.rs

@@ -66,7 +66,13 @@ pub fn snapshot_from_vfs(
             for rule in default_sync_rules() {
                 if rule.matches(&init_path) {
                     return match rule.middleware {
-                        Middleware::Project => snapshot_project(context, vfs, &init_path),
+                        Middleware::Project => {
+                            let name = init_path
+                                .parent()
+                                .and_then(Path::file_name)
+                                .and_then(|s| s.to_str()).expect("default.project.json should be inside a folder with a unicode name");
+                            snapshot_project(context, vfs, &init_path, name)
+                        }
 
                         Middleware::ModuleScript => {
                             snapshot_lua_init(context, vfs, &init_path, ScriptType::Module)
@@ -218,9 +224,7 @@ impl Middleware {
             Self::ServerScript => snapshot_lua(context, vfs, path, name, ScriptType::Server),
             Self::ClientScript => snapshot_lua(context, vfs, path, name, ScriptType::Client),
             Self::ModuleScript => snapshot_lua(context, vfs, path, name, ScriptType::Module),
-            // At the moment, snapshot_project does not use `name` so we
-            // don't provide it.
-            Self::Project => snapshot_project(context, vfs, path),
+            Self::Project => snapshot_project(context, vfs, path, name),
             Self::Rbxm => snapshot_rbxm(context, vfs, path, name),
             Self::Rbxmx => snapshot_rbxmx(context, vfs, path, name),
             Self::Toml => snapshot_toml(context, vfs, path, name),
@@ -280,8 +284,7 @@ fn default_sync_rules() -> &'static [SyncRule] {
             sync_rule!("*.client.lua", ClientScript, ".client.lua"),
             sync_rule!("*.client.luau", ClientScript, ".client.luau"),
             sync_rule!("*.{lua,luau}", ModuleScript),
-            // Project middleware doesn't use the file name.
-            sync_rule!("*.project.json", Project),
+            sync_rule!("*.project.json", Project, ".project.json"),
             sync_rule!("*.model.json", JsonModel, ".model.json"),
             sync_rule!("*.json", Json, ".json", "*.meta.json"),
             sync_rule!("*.toml", Toml),