style: format Lua files

[scarf005]

Purpose of change

Using formatter improves readability and diff output.

Describe the solution

use https://github.com/RubixDev/dprint-plugin-stylua to format Lua files.

Why dprint?

• compatibility: being written in WASM, plugins are cross-platform and works on browser.
• low friction: deno uses dprint internally, so it's easy to migrate in the future.
• unification: in the future, we'd be able to format JSON, markdown, typescript, Lua, C++ files with
  • dprint VSCode extension
  • deno task dprint fmt

Alternatives

migrate formatting ecosystem to use dprint with its configuration set to match with deno.

Additional Context

followup task for #3165

[chaosvolt]

I'm really not qualified to review this since zero LUA experience but Scarf kept pestering me to do so in the discord, so uh. This looks like a relevant error in the check failure log:

Log:

(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> lua_runtime_error
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:121
(~[slow] ~[.],starting_items)=> ...............................................................................
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:134: FAILED:
(~[slow] ~[.],starting_items)=>   REQUIRE_THROWS_MATCHES( run_lua_test_script( lua, "runtime_error.lua" ), std::runtime_error, Catch::Message( expected ) )
(~[slow] ~[.],starting_items)=> with expansion:
(~[slow] ~[.],starting_items)=>   Script runtime error in tests/lua/runtime_error.lua: tests/lua/runtime_error.
(~[slow] ~[.],starting_items)=>   lua:2: attempt to index a nil value (global 'table_with_typo')
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	tests/lua/runtime_error.lua:2: in main chunk exception message matches
(~[slow] ~[.],starting_items)=>   "Script runtime error in tests/lua/runtime_error.lua: tests/lua/
(~[slow] ~[.],starting_items)=>   runtime_error.lua:3: attempt to index a nil value (global 'table_with_typo')
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	tests/lua/runtime_error.lua:3: in main chunk"
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> lua_called_error_on_lua_side
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:141
(~[slow] ~[.],starting_items)=> ...............................................................................
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:155: FAILED:
(~[slow] ~[.],starting_items)=>   REQUIRE_THROWS_MATCHES( run_lua_test_script( lua, "called_error_on_lua_side.lua" ), std::runtime_error, Catch::Message( expected ) )
(~[slow] ~[.],starting_items)=> with expansion:
(~[slow] ~[.],starting_items)=>   Script runtime error in tests/lua/called_error_on_lua_side.lua: tests/lua/
(~[slow] ~[.],starting_items)=>   called_error_on_lua_side.lua:2: Error called on Lua side!
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	[C]: in function 'base.error'
(~[slow] ~[.],starting_items)=>   	tests/lua/called_error_on_lua_side.lua:2: in main chunk exception message
(~[slow] ~[.],starting_items)=>   matches "Script runtime error in tests/lua/called_error_on_lua_side.lua:
(~[slow] ~[.],starting_items)=>   tests/lua/called_error_on_lua_side.lua:3: Error called on Lua side!
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	[C]: in function 'base.error'
(~[slow] ~[.],starting_items)=>   	tests/lua/called_error_on_lua_side.lua:3: in main chunk"
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> lua_called_error_on_cpp_side
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:167
(~[slow] ~[.],starting_items)=> ...............................................................................
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:183: FAILED:
(~[slow] ~[.],starting_items)=>   REQUIRE_THROWS_MATCHES( run_lua_test_script( lua, "called_error_on_cpp_side.lua" ), std::runtime_error, Catch::Message( expected ) )
(~[slow] ~[.],starting_items)=> with expansion:
(~[slow] ~[.],starting_items)=>   Script runtime error in tests/lua/called_error_on_cpp_side.lua: tests/lua/
(~[slow] ~[.],starting_items)=>   called_error_on_cpp_side.lua:2: Error called on Cpp side!
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	[C]: in function 'base.cpp_call_error'
(~[slow] ~[.],starting_items)=>   	tests/lua/called_error_on_cpp_side.lua:2: in main chunk exception message
(~[slow] ~[.],starting_items)=>   matches "Script runtime error in tests/lua/called_error_on_cpp_side.lua:
(~[slow] ~[.],starting_items)=>   tests/lua/called_error_on_cpp_side.lua:3: Error called on Cpp side!
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	[C]: in function 'base.cpp_call_error'
(~[slow] ~[.],starting_items)=>   	tests/lua/called_error_on_cpp_side.lua:3: in main chunk"
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> [sol2] An exception occurred: Exception thrown on Cpp side!
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> lua_called_cpp_func_throws
(~[slow] ~[.],starting_items)=> -------------------------------------------------------------------------------
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:196
(~[slow] ~[.],starting_items)=> ...............................................................................
(~[slow] ~[.],starting_items)=> 
(~[slow] ~[.],starting_items)=> /home/runner/work/Cataclysm-BN/Cataclysm-BN/tests/catalua_test.cpp:212: FAILED:
(~[slow] ~[.],starting_items)=>   REQUIRE_THROWS_MATCHES( run_lua_test_script( lua, "called_cpp_func_throws.lua" ), std::runtime_error, Catch::Message( expected ) )
(~[slow] ~[.],starting_items)=> with expansion:
(~[slow] ~[.],starting_items)=>   Script runtime error in tests/lua/called_cpp_func_throws.lua: Exception
(~[slow] ~[.],starting_items)=>   thrown on Cpp side!
(~[slow] ~[.],starting_items)=>   stack traceback:
(~[slow] ~[.],starting_items)=>   	[C]: in function 'base.cpp_throw_exception'
(~[slow] ~[.],starting_items)=>   	tests/lua/called_cpp_func_throws.lua:2: in main chunk exception message

[scarf005]

...right, because the code is formatted the errors are also formatted, so i need to change the tests as well.

[scarf005]

alright, local tests pass this time.

[chaosvolt]

In that case, yeet.