Add a CI linter test for static code checks

Author: Musholic

.github/workflows/test.yml

@@ -6,9 +6,55 @@ on:
     branches: [ dev ]
   workflow_dispatch:
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    container: ghcr.io/musholic/lastepochplanner-tests:latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download LuaLS Addons
+        run: |
+          git clone --depth 1 https://github.com/LuaLS/LLS-Addons.git .lls-addons
+          cd .lls-addons
+          git submodule update --init --depth 1 addons/busted
+          git submodule update --init --depth 1 addons/luassert
+          git submodule update --init --depth 1 addons/luafilesystem
+
+      - name: Patch .luarc.json for CI + clean up
+        run: |
+          sed -i 's|${addons}|.lls-addons/addons|g' .luarc.json
+          # Delete the Lua 5.3 specific file so it doesn't break LuaJIT parsing
+          rm -f runtime/lua/sha1/lua53_ops.lua
+          # Delete the ModCache which slows down type checking
+          rm -f src/Data/ModCache.lua
+      - name: Type Check Code Base
+        run: lua-language-server --check . --check_format=json --logpath=.
+      - name: Annotate GitHub PR from check.json
+        if: always()
+        run: |
+          LOG_FILE="check.json"
+          if [ -f "$LOG_FILE" ]; then
+            cat $LOG_FILE | jq -r --arg ws "$GITHUB_WORKSPACE" '
+              to_entries[] |
+              # 1. Strip "file://..." prefix and convert to relative path
+              (.key | sub("file://"; "") | ltrimstr($ws) | ltrimstr("/")) as $file |
+
+              # 2. Iterate over issues
+              .value[] |
+              # 3. Map LSP severity (1:Error, 2:Warning) to GH format
+              (if .severity == 1 then "error" else "warning" end) as $sev |
+
+              # 4. Convert 0-indexed LSP (line 55, char 0) to 1-indexed GH (line 56, col 1)
+              # GitHub requires line and col. Optional: endLine, endColumn
+              "::\($sev) file=\($file),line=\(.range.start.line + 1),col=\(.range.start.character + 1),endLine=\(.range.end.line + 1),endColumn=\(.range.end.character + 1)::\($file): \(.message) (code: \(.code))"
+            '
+          else
+            echo "::warning::check.json not found, skipping annotations."
+          fi
   run_tests:
     runs-on: ubuntu-latest
-    container: ghcr.io/pathofbuildingcommunity/pathofbuilding-tests:latest
+    container: ghcr.io/musholic/lastepochplanner-tests:latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -19,7 +65,7 @@ jobs:
         run: cd src; luacov-coveralls --repo-token=${{ secrets.github_token }} -e TestData -e Data -e runtime
   check_modcache:
     runs-on: ubuntu-latest
-    container: ghcr.io/pathofbuildingcommunity/pathofbuilding-tests:latest
+    container: ghcr.io/musholic/lastepochplanner-tests:latest
     steps:
       - name: Install git dependency
         run: apk add git

.luarc.json

@@ -0,0 +1,37 @@
+{
+  "runtime": {
+    "version": "LuaJIT"
+  },
+  "workspace": {
+    "library": [
+            "runtime/lua",
+            "${addons}/busted/module/library",
+            "${addons}/luassert/module/library",
+            "${addons}/luafilesystem/module/library"
+        ],
+    "ignoreDir": ["runtime", "src/Export"]
+  },
+  "diagnostics": {
+    "globals": ["UpdateProgress"],
+    "severity": {
+      "need-check-nil": "Information",
+      "param-type-mismatch": "Information",
+      "undefined-field": "Information",
+      "undefined-doc-class": "Information",
+      "undefined-doc-name": "Information",
+      "missing-return": "Information",
+      "inject-field": "Information",
+      "assign-type-mismatch": "Information",
+      "cast-local-type": "Information"
+    },
+    "disable": ["lowercase-global"]
+  },
+  "hint": {
+    "enable": true
+  },
+  "Lua.format.defaultConfig": {
+    "indent_style": "tab",
+    "indent_size": "4"
+  },
+  "workspace.checkThirdParty": false
+}

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.18 AS base
+FROM alpine:3.22 AS base
 # Common dependencies
 RUN apk add --no-cache cmake readline-dev build-base tar
 
@@ -18,13 +18,16 @@ RUN git clone https://github.com/LuaJIT/LuaJIT && cd LuaJIT && git checkout 871d
 RUN cd LuaJIT && make
 
 FROM buildbase AS emmyluadebugger
-RUN git clone --depth 1 --branch 1.7.1 https://github.com/EmmyLua/EmmyLuaDebugger
+RUN git clone --depth 1 --branch 1.8.7 https://github.com/EmmyLua/EmmyLuaDebugger
 RUN cd EmmyLuaDebugger && mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release ../ && make
 
 FROM base
 # Luarocks packages dependencies
 RUN apk add --no-cache curl unzip openssl
 
+# Install other dependencies useful for the CI
+RUN apk add --no-cache libxml2-utils git lua-language-server jq
+
 RUN --mount=type=cache,from=buildBase,source=/opt,target=/opt make -C /opt/lua-5.1.5/ install
 RUN --mount=type=cache,from=luarocks,source=/opt,target=/opt make -C /opt/luarocks-3.7.0/ install
 

src/Classes/CalcsTab.lua

@@ -192,7 +192,7 @@ Effective DPS: Curses and enemy properties (such as resistances and status condi
 	self.powerBuilderInitialized = nil
 end)
 
-function CalcsTabClass:Load(xml, dbFileName)
+function CalcsTabClass:Load(xml, fileName)
 	for _, node in ipairs(xml) do
 		if type(node) == "table" then
 			if node.elem == "Input" then

src/HeadlessWrapper.lua

@@ -77,7 +77,7 @@ function GetAsyncCount()
 end
 
 -- Search Handles
-function NewFileSearch() end
+function NewFileSearch(path, dirOnly) end
 
 -- General Functions
 function SetWindowTitle(title) end
@@ -110,7 +110,7 @@ function GetUserPath()
 	return ""
 end
 function MakeDir(path) end
-function RemoveDir(path) end
+function RemoveDir(path, recursive) end
 function SetWorkDir(path) end
 function GetWorkDir()
 	return ""

src/Modules/Common.lua

@@ -653,7 +653,7 @@ end
 
 --- Rounds down a number to the nearest <dec> decimal places
 ---@param val number
----@param dec number
+---@param dec number?
 ---@return number
 function floor(val, dec)
 	if dec then
@@ -1049,4 +1049,4 @@ function GetVirtualScreenSize()
 		height = math.floor(height / scale)
 	end
 	return width, height
-end
+end

src/globals.meta.lua

@@ -0,0 +1,3 @@
+---@meta
+
+lfs = require("lfs")