[WIP] Add code format checker to CI #157
Draft
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 a GitHub action to check code formatting on every commit.
That will allow us to check if code is formatted correctly before merging into the master branch.
I'm considering this a draft PR for now for two reasons:
Since my last couple commits have included many miscellaneous auto-formatting fixes, my hope is that by checking code formatting before merging those miscellaneous fixes won't happen in the future.
How I plan for this action to work:
.lua
files using the sameluaconfig.config
at the root of this repositoryHopefully this in conjunction with the VS Code auto-formatting settings PR #156 could help make code formatting issues a thing of the past.
I do not plan on merging this PR before #156 is merged and #5 is closed. That way there's an easy fix for formatting code. It would be a real pain to go through and manually format every single character of code just to merge it into this repo.