Feature: lint helper pre push script - #1273
Open
javierbrk wants to merge 2 commits into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I recently tried to update an old pull request but the CI rejected mi script because of linting errors. To make this easier for everyone, this PR adds documentation and points to a helper script to run the CI linting jobs locally before pushing.
I evaluated the possibility of just running the tools directly from the console, but running the actual CI job locally is much more accurate and guarantees we are testing against the same environment.
The CI workflow executes three specific scripts:
Lua Linting (tools/ci/lint/lua.sh): Uses luacheck to analyze Lua code for syntax errors, unused variables, and warnings.
Shell Linting (tools/ci/lint/sh.sh): Uses shellcheck to find bugs, edge cases, and bad practices in shell scripts.
Formatting (tools/ci/lint/format.sh): Enforces consistent code style using shfmt.