Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.87 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.87 KB
Raw

GLua Linter

GitHub action to lint GLua scripts. Uses GLuaFixer internally.

Example workflow file

# This is an example for a workflow file.
# Place this file in .github/workflows/glua_linter.yml

on: [push, pull_request]

jobs:
  lua_lint:
    runs-on: ubuntu-latest # The action only works on Ubuntu.
    name: GLua Linter # Name this whatever you want.
    steps:
      - name: Checkout # This step is required to clone the repository.
        id: checkout
        uses: actions/checkout@v2
      - name: Linting
        id: action-glua-lint
        # You can change v1.1.4 to a newer version or 'master.' Changing it to 'master' may cause unexpected behavior.
        uses: TASSIA710/[email protected]
        with:
          directory: / # This is the directory to scan. If '/' is selected, it will scan the entire repository.

Configuration

Basically just look at this. All lint_* options are supported. Prettyprint options aren't supported because this is a Linter and not a Prettyprinter.

Fail on Warning:
You can also configure the action to fail if even a single warning occurs. This is useful if you want to enforce consistent styles. To do so add the failOnWarning: true option to the workflow file. If you choose to omit this option, it will default to being disabled.
(Contribution by rafraser)