diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml new file mode 100644 index 0000000..f1dd81d --- /dev/null +++ b/.github/workflows/stylua.yml @@ -0,0 +1,11 @@ +name: StyLua +on: [push, pull_request] +jobs: + StyLua check: + - uses: actions/checkout@v3 + - uses: JohnnyMorganz/stylua-action@v3 + with: + token: ${{ secrets.GH_TOKEN }} + version: v0.8.2 # NOTE: we recommend pinning to a specific version in case of formatting changes + # CLI arguments + args: --check . diff --git a/README.md b/README.md index 2744b6c..fe70930 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,8 @@ errors: `luacheck lua` **Please use [Conventional Commits](https://www.conventionalcommits.org/) if you want to contribute. It makes everyones jobs easier.** +**This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua). Please format your code using StyLua for better readability** + Pull requests are very welcome, feel free to open an issue to work on or message [me (@jiriks74)](https://discordapp.com/users/517810049360461837) on my [Discord server](https://discord.gg/cCq3qcB4jB)!