Add comprehensive Luau compatibility layer for LuaFileSystem

[stayaway245]

No description provided.

[mentatbot]

I'm getting to work. See my steps and track my cost here.

• Wake on any new activity.
  _{I always see new activity while actively working. When paused, I'll only respond when tagged unless this box is checked.}

[mentatbot]

PR Review: Add comprehensive Luau compatibility layer for LuaFileSystem

I've reviewed this PR that adds Luau compatibility to LuaFileSystem (LFS), and I'm impressed with the thorough implementation. This is a well-designed solution that enables LuaFileSystem to work seamlessly with Luau without modifying the core LFS codebase.

Key Strengths

1. Comprehensive Compatibility Layer:

   • Provides adapter functions for key API differences between standard Lua and Luau
   • Properly handles differences in function signatures and behavior
   • Maintains the original LFS API while working with Luau under the hood

2. Build System Integration:

   • CMake config is updated to properly handle the compatibility layer
   • CI pipeline is configured to use the internal Luau headers
   • Carefully manages include paths and compilation flags

3. Practical Usage Examples:

   • Files.lua demonstrates LFS usage with the new compatibility layer
   • Shows filesystem operations working with both Lua and Luau

Technical Implementation Details

The compatibility layer is particularly well-designed, addressing key differences between Lua and Luau:

• Custom implementation of luaL_error_compat that handles the return type difference
• Mapping lua_pushcfunction to Luau's lua_pushcclosurek
• Reimplementing luaL_register for Luau's environment
• Adding proper metatable handling for Luau

Build Integration

The PR successfully integrates with the CI/CD pipeline, ensuring that builds complete successfully with the new compatibility layer. The workflow properly configures the environment to use internal Luau headers rather than external Lua.

Conclusion

This PR adds important functionality that will allow the application to leverage LuaFileSystem within the Luau environment. The compatibility layer is well-implemented and provides a clean solution without modifying the core LFS codebase.

The PR was successfully merged and appears to be working as expected, with no build failures reported in CI.