Fmt/Lint Github Workflows #6278
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include lux and add the busted and luassert test dependencies. Lux seems like it is set to become the de facto package manager for lua and it is also not luarocks.
Add the busted unit testing framework with example specs, installation docs, and legal licensing. Includes luassert for assertion DSL. Key features: - Builder pattern for mock construction with fluent interfaces - Spring repository wrapper for dependency injection. Includes helpers like WithAlliance, AddTeamResources, and mod option support. Allows loading global dependent code in test closures. - Team builder for configuring team properties - Global state isolation with WithGlobalsDefined helper Busted needs to load project dirs in `.busted`. This is necessary because lx expects a `src/` folder matching lua package structure.
Add separate format and lint github workflows to automatically format and fail PRs with non-stylistic type errors. Also add git hook instructions to the README (recommended to devs)
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds automatic formatting and type checking to BAR. It is downstream of Unit Test Bootstrapping.
When to Merge
This is a PR for after Lux becomes required.
Before Merge
Merge this at the end of a weekly merge session.
Before merging, check out the branch and run
lx fmt, then do some cursory testing.