fivem-lua-lint-action

KO | EN

gitlite — search

#python #hacktoberfest #nlp #java #javascript #html #web #python3 #react #natural-language-processing #rust #flask

fivem-lua-lint-action

★ 24 Open GitHub ↗

A GitHub action for linting FiveM / Cfx Lua scripts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# fivem-lua-lint-action

This GitHub Action runs `luacheck` on your Lua codebase against known FiveM natives for any GitHub repository!

> Note: The FiveM Lua backtick syntax is **NOT** supported, please use `GetHashKey()` instead.

---

## Using

To use this in your GitHub repository, create the following file:

> **.github/workflows/lint.yml**

This will automatically run `luacheck` for both commits and pull requests!

---

## JUnit Reporting (Getting Fancy)

If you would like to display fancy results in the GitHub action job, you can try the following configuration,
which outputs a JUnit results file:

![Fancy JUnit Reporting in GitHub Actions Example](https://raw.githubusercontent.com/GoatG33k/fivem-lua-lint-action/master/.github/docs/fancy_example.png)

> **.github/workflows/lint.yml**

```yml
name: CI
on: [push, pull_request]
jobs:
  lint:
    name: Lint Lua Scripts
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Lint
        uses: GoatG33k/fivem-lua-lint-action@v1
        with:
          capture: "junit.xml"
          args: "-t --formatter JUnit"
      - name: Publish Test Report
        uses: mikepenz/action-junit-report@v2
        with:
          report_paths: "**/junit.xml"
          fail_on_failure: 0
```

fivem-lua-lint-action

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README