grilme99/flow

🌊 A Flexbox layouting engine for Lua.

flow's Issues

Add example project

Flow needs an example project to showcase usage. Maybe replicating the demo found on Yoga's website?

Some tests are flaky

Three of the test fixtures are flaky and require manual fixing after generating tests. This is a bug in upstream Yoga, but I'd like to find a solution because manually fixing test assertions is certainly not ideal.

It could be worth investigating how test generation is done in Taffy.

Internal classes don't type check properly

Classes in the yoga-sys package are written in a way that Luau doesn't type check properly (self is any). These should be updated to type the self parameter explicitly.

This is the cause of this issue. Explicitly typing the self parameter will catch type errors in CI.

Sync to Yoga 2.0

Meta released Yoga 2.0 part-way through the development of Flow. Once the new version of Yoga is battle-tested in environments outside of Meta (it has yet to be widely adopted in React Native), it would be great to sync Flow back up to the latest Yoga. This will deviate us from Typeflex, and we'll then be wholly based on Yoga itself.

Documentation

API usage is relatively straightforward, but adding documentation would still be helpful for new users. Yoga has next to no API documentation either, so other than tests, there's no point of reference for API usage.

Decouple from Roblox

Flow doesn't need to be tied to Roblox! It uses no engine APIs, and several different Lua environments could benefit from this package.

Decoupling from Roblox is currently blocked by this Darklua issue. Once Darklua can handle all Luau features, it will be possible for us to migrate to path-based requires and drop any dependency on Roblox-specific APIs or constructs.

Decoupling from Roblox would also allow us to run benchmarks and unit tests in Lune, dropping the need to use Roblox Studio to test.

CI broken by Luau LSP

Something has changed in Luau LSP recently that is breaking CI here.