factorio-clusterio/.github/workflows/lua-lint.yml

name: Lua Lint

on:
  push:
  pull_request:

env:
  EMMYLUA_CHECK_VERSION: "0.25.1"

jobs:
  changes:
    uses: ./.github/workflows/ci-changes.yml

  lint:
    needs: changes
    if: ${{ !cancelled() && needs.changes.outputs.lua_lint != 'false' }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: lts/*
      - name: Generate Factorio typedefs
        run: |
          npm install --prefix "$RUNNER_TEMP/fmtk" factoriomod-debug
          "$RUNNER_TEMP/fmtk/node_modules/.bin/fmtk" luals-addon "$RUNNER_TEMP"
      - name: Install emmylua_check
        run: |
          curl -fsSL "https://github.com/EmmyLuaLs/emmylua-analyzer-rust/releases/download/${EMMYLUA_CHECK_VERSION}/emmylua_check-linux-x64.tar.gz" \
            | tar -xz -C "$RUNNER_TEMP"
      - name: Run Lint Report
        shell: bash
        run: |
          # The typedefs are generated per run, so their path is passed via a second config
          jq -n --arg lib "$RUNNER_TEMP/factorio/library" \
            '{ workspace: { library: [ $lib ] } }' \
            > "$RUNNER_TEMP/ci.emmyrc.json"

          # Exits non zero on error severity, so the gate below is used instead
          "$RUNNER_TEMP/emmylua_check" . --config ".emmyrc.json,$RUNNER_TEMP/ci.emmyrc.json" \
            --output-format json --output check.json || true

          # Credit to https://github.com/Krealle/luals-check-action/blob/main/action.yml
          # Although some minor fixes were needed

          # Format and print the messages (would be nice to format as a table, but that's too complex for jq)
          jq -r --arg root "$PWD/" \
            '.[] | (.file | ltrimstr($root)) as $file | .diagnostics[] |
              {
                file: $file,
                code: .code,
                line: .range.start.line,
                message: (.message | split("\n")
                  | map(if startswith("- ") then .[2:] else . end)
                  | join("\n")),
                severity: (if .severity <= 1 then "ERR" else "WARN" end)
              } |
              "**[\(.severity)] \(.code):** \(.file)#L\(.line + 1)<br><code>\(.message)</code>"' \
            check.json > "$GITHUB_STEP_SUMMARY"

          echo ""

          # Github Annotations (limited to 10)
          jq -r --arg root "$PWD/" \
            '.[] | (.file | ltrimstr($root)) as $file | .diagnostics[] |
              {
                file: $file,
                title: .code,
                line: .range.start.line,
                endLine: .range.end.line,
                col: .range.start.character,
                endColumn: .range.end.character,
                message: (.message | gsub("\n"; "%0A"; "m")),
                level: (if .severity <= 1 then "error" else "warning" end)
              } |
              "::\(.level) file=\(.file),line=\(.line + 1),endLine=\(.endLine + 1),col=\(.col + 1),endColumn=\(.endColumn + 1),title=\(.title)::\(.message) (\(.title))"' \
            check.json

          # An entry is emitted for every file checked, including clean ones, so
          # the gate counts diagnostics and asserts the workspace was actually read
          if [[ $(jq 'length' check.json) -lt 20 ]] ; then
            echo "::error::Only $(jq 'length' check.json) files were checked, expected the whole workspace"
            exit 1
          elif [[ $(jq '[.[].diagnostics[]] | length' check.json) -gt 0 ]] ; then
            exit 1
          else
            echo "✅ All checks succeeded!" | tee "$GITHUB_STEP_SUMMARY"
          fi