feat: optimize name handling for leaf scripts with invalid names

Prefer slugified filenames + adjacent meta files for scripts without children instead of forcing directory creation
This commit is contained in:
2025-12-18 04:43:10 +01:00
parent 73dab330b5
commit 60d150f4c6
3 changed files with 21 additions and 13 deletions

View File

@@ -7,8 +7,7 @@ Writing default.project.json
Writing src/Camera.rbxm
Writing src/Terrain.rbxm
Writing src/_Folder/init.meta.json
Writing src/_Script/init.meta.json
Writing src/_Script/init.server.luau
Writing src/_Script.meta.json
Writing src/_Script.server.luau
Writing src
Writing src/_Folder
Writing src/_Script

View File

@@ -360,16 +360,25 @@ pub fn get_best_middleware(snapshot: &SyncbackSnapshot) -> Middleware {
}
}
// If the instance name is invalid for the filesystem, use directory middleware
// to allow preserving the name in meta.json
// If the name is invalid but the instance has no descendants and isn't a
// folder/config/tool, prefer slugified files over creating a directory.
// Only promote to directory when there are children (or dir-like classes).
if crate::syncback::file_names::validate_file_name(&inst.name).is_err() {
middleware = match middleware {
Middleware::ServerScript => Middleware::ServerScriptDir,
Middleware::ClientScript => Middleware::ClientScriptDir,
Middleware::ModuleScript => Middleware::ModuleScriptDir,
Middleware::Csv => Middleware::CsvDir,
Middleware::JsonModel | Middleware::Text => Middleware::Dir,
_ => middleware,
Middleware::ServerScript | Middleware::ClientScript | Middleware::ModuleScript
if inst.children().is_empty() =>
{
middleware
}
Middleware::JsonModel | Middleware::Text if inst.children().is_empty() => middleware,
_ => match middleware {
Middleware::ServerScript => Middleware::ServerScriptDir,
Middleware::ClientScript => Middleware::ClientScriptDir,
Middleware::ModuleScript => Middleware::ModuleScriptDir,
Middleware::Csv => Middleware::CsvDir,
Middleware::JsonModel | Middleware::Text => Middleware::Dir,
_ => middleware,
},
}
}

View File

@@ -87,8 +87,8 @@ syncback_tests! {
// 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
slugified_name => ["src/_Script/init.meta.json", "src/_Script/init.server.luau", "src/_Folder/init.meta.json"],
// 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"],
}