Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add workflow to format Lua files in pull requests #4769

Closed
wants to merge 2 commits into from

Conversation

omarcopires
Copy link
Contributor

@omarcopires omarcopires commented Jul 24, 2024

Description
This pull request adds a workflow to the project that automatically formats Lua files in pull requests. The goal is to ensure that all Lua files are formatted according to established guidelines, promoting consistency and improving code readability.

What was done

  • Added a formatting workflow for Lua files.
  • Configured to run automatically on pull requests.
  • The workflow uses [formatting tool] to apply the standard formatting.

How to test

  • Create a pull request with Lua files that are not correctly formatted.
  • Verify that the formatting workflow runs automatically.
  • Ensure that Lua files are formatted according to the established guidelines.

Notes

  • Ensure that the formatting tool is correctly configured in your local environment to avoid discrepancies.
  • Formatting will be applied automatically to code before merging into the main branch.

@omarcopires
Copy link
Contributor Author

just to maintain a standard in the lua code as well, considering that the source already has a defined standard.
I don't have the necessary knowledge to change the format or any other modification to the workflow, so I left the pull request free for administrators to make changes if necessary!

8251, 8252, 8254, 8255, 8256, 8276, 8277, 8279, 8281, 8284, 8285, 8286, 8323,
8567, 8585, 8595, 8596, 8972, 9606, 9625, 13190, 14461, 19519, 21536, 23713,
26020
294,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noooooooooo, one id per line is ugly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There must be other formatting styles that can be applied, I have no doubt! (I agree that this is very ugly).

@omarcopires omarcopires changed the title add lua format files feat: add workflow to format Lua files in pull requests Jul 24, 2024
@ranisalt
Copy link
Member

I don't like the idea of manipulating others' pull requests because it causes surprise that your PR was modified by a third party. Also, people are generally awful at using Github 😅

I'd rather add a pre-commit hook that formats changed Lua files so they are pushed as formatted, and then we just check formatting in a workflow

@omarcopires omarcopires deleted the lua-format branch July 26, 2024 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants