Reorder writeModelFile / writePlaceFile parameters (#81)

* Reorder writeModelFile / writePlaceFile parameters * Update changelog Co-authored-by: [email protected] <[email protected]>
rojo-rbx · Aug 4, 2022 · 0b73947 · 0b73947
1 parent 1b73ef2
commit 0b73947
Showing 12 changed files with 15 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Remodel Changelog
 
 ## Unreleased Changes
+* **Breaking:** Reordered parameters of `remodel.writeModelFile` and `remodel.writePlaceFile` to accept path first, then content ([#81](https://github.com/rojo-rbx/remodel/pull/81)).
 
 ## 0.10.0 (2022-06-13)
 * Switched from `rlua` to `mlua`, which should improve Lua performance slightly. ([#73])

diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ local Models = game.ReplicatedStorage.Models
 
 for _, model in ipairs(Models:GetChildren()) do
 	-- Save out each child as an rbxmx model
-	remodel.writeModelFile(model, "models/" .. model.Name .. ".rbxmx")
+	remodel.writeModelFile("models/" .. model.Name .. ".rbxmx", model)
 end
 ```
 
@@ -123,7 +123,7 @@ Throws on error.
 
 ### `remodel.writePlaceFile`
 ```
-remodel.writePlaceFile(instance: DataModel, path: string)
+remodel.writePlaceFile(path: string, instance: DataModel)
 ```
 
 Saves an `rbxlx` file out of the given `DataModel` instance.
@@ -134,7 +134,7 @@ Throws on error.
 
 ### `remodel.writeModelFile`
 ```
-remodel.writeModelFile(instance: Instance, path: string)
+remodel.writeModelFile(path: string, instance: Instance)
 ```
 
 Saves an `rbxmx` or `rbxm` (0.4.0+) file out of the given `Instance`.

diff --git a/examples/01-load-and-save.lua b/examples/01-load-and-save.lua
@@ -9,4 +9,4 @@ local stringValue = root:FindFirstChild("String")
 print("Found string value: ", stringValue.Name)
 
 -- We can save models back to disk with remodel.writeModelFile
-remodel.writeModelFile(stringValue, "temp/just-a-stringvalue.rbxmx")
+remodel.writeModelFile("temp/just-a-stringvalue.rbxmx", stringValue)
diff --git a/examples/02-extract-models.lua b/examples/02-extract-models.lua
@@ -13,7 +13,7 @@ local Models = game.ReplicatedStorage.Models
 remodel.createDirAll("temp/models")
 
 for _, model in ipairs(Models:GetChildren()) do
-	remodel.writeModelFile(model, "temp/models/" .. model.Name .. ".rbxmx")
+	remodel.writeModelFile("temp/models/" .. model.Name .. ".rbxmx", model)
 end
 
 -- And that's it!
diff --git a/examples/04-move-terrain.lua b/examples/04-move-terrain.lua
@@ -6,4 +6,4 @@ local outputGame = remodel.readPlaceFile("output-place.rbxlx");
 outputGame.Workspace.Terrain:Destroy()
 inputGame.Workspace.Terrain.Parent = outputGame.Workspace
 
-remodel.writePlaceFile(outputGame, "output-place-updated.rbxlx")
+remodel.writePlaceFile("output-place-updated.rbxlx", outputGame)
diff --git a/src/remodel_api/remodel.rs b/src/remodel_api/remodel.rs
@@ -496,7 +496,7 @@ impl UserData for Remodel {
 
         methods.add_function(
             "writePlaceFile",
-            |_context, (instance, lua_path): (LuaInstance, String)| {
+            |_context, (lua_path, instance): (String, LuaInstance)| {
                 let path = Path::new(&lua_path);
 
                 match path.extension().and_then(OsStr::to_str) {
@@ -512,7 +512,7 @@ impl UserData for Remodel {
 
         methods.add_function(
             "writeModelFile",
-            |_context, (instance, lua_path): (LuaInstance, String)| {
+            |_context, (lua_path, instance): (String, LuaInstance)| {
                 let path = Path::new(&lua_path);
 
                 match path.extension().and_then(OsStr::to_str) {

diff --git a/test-scripts/rojo.lua b/test-scripts/rojo.lua
@@ -13,4 +13,4 @@ local project = {
 
 local tree = rojo.buildProject(project)
 
-remodel.writeModelFile(tree, "temp/rojo-output.rbxmx")
+remodel.writeModelFile("temp/rojo-output.rbxmx", tree)
diff --git a/test-scripts/set-parent-nil.lua b/test-scripts/set-parent-nil.lua
@@ -10,7 +10,7 @@ stringValue.Parent = nil
 assert(stringValue.Parent == nil)
 assert(root:FindFirstChild("String") == nil)
 
-remodel.writeModelFile(stringValue, "temp/written-from-nil.rbxmx")
+remodel.writeModelFile("temp/written-from-nil.rbxmx", stringValue)
 
 local reloaded = remodel.readModelFile("temp/written-from-nil.rbxmx")[1]
 

diff --git a/test-scripts/write-model-binary.lua b/test-scripts/write-model-binary.lua
@@ -4,7 +4,7 @@ assert(root.Name == "Example Model")
 local module = root:FindFirstChild("SomeModule")
 assert(module.ClassName == "ModuleScript")
 
-remodel.writeModelFile(module, "temp/just-module.rbxm")
+remodel.writeModelFile("temp/just-module.rbxm", module)
 
 local module2 = remodel.readModelFile("temp/just-module.rbxm")[1]
 assert(module2.ClassName == "ModuleScript")

diff --git a/test-scripts/write-model.lua b/test-scripts/write-model.lua
@@ -3,7 +3,7 @@ assert(root.Name == "Root")
 
 local stringValue = root:FindFirstChild("String")
 
-remodel.writeModelFile(stringValue, "temp/just-stringvalue.rbxmx")
+remodel.writeModelFile("temp/just-stringvalue.rbxmx", stringValue)
 
 local stringValue2 = remodel.readModelFile("temp/just-stringvalue.rbxmx")[1]
 assert(stringValue2.Name == "String")
diff --git a/test-scripts/write-place-binary.lua b/test-scripts/write-place-binary.lua
@@ -1,7 +1,7 @@
 local game = remodel.readPlaceFile("test-models/place-with-models-binary.rbxl")
 assert(game.Workspace.Camera ~= nil)
 
-remodel.writePlaceFile(game, "temp/new-place-binary.rbxl")
+remodel.writePlaceFile("temp/new-place-binary.rbxl", game)
 
 local game2 = remodel.readPlaceFile("temp/new-place-binary.rbxl")
 assert(game2.Workspace.Camera ~= nil)
diff --git a/test-scripts/write-place.lua b/test-scripts/write-place.lua
@@ -1,7 +1,7 @@
 local game = remodel.readPlaceFile("test-models/place-with-models.rbxlx")
 assert(game.Workspace.Camera ~= nil)
 
-remodel.writePlaceFile(game, "temp/new-place.rbxlx")
+remodel.writePlaceFile("temp/new-place.rbxlx", game)
 
 local game2 = remodel.readPlaceFile("temp/new-place.rbxlx")
 assert(game2.Workspace.Camera ~= nil)
Original file line number	Diff line number	Diff line change
		@@ -13,4 +13,4 @@ local project = {

		local tree = rojo.buildProject(project)

		remodel.writeModelFile(tree, "temp/rojo-output.rbxmx")
		remodel.writeModelFile("temp/rojo-output.rbxmx", tree)