chore: linting and formatting (#23)

* chore: add linting

* refactor: improve formatting

* fix: add stylua to mise

* fix: diagnostic issues

* chore: add lint check to ci

* fix: don't ignore .lua_ls

Author: dkarter

.github/workflows/test.yml

@@ -21,6 +21,20 @@ jobs:
       - name: Check formatting
         run: mise run fmt:check
 
+  lint:
+    name: Run Lua Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v6.0.2
+
+      - name: Set up tools via mise
+        uses: jdx/mise-action@v4.0.1
+
+      - name: Run Lua lint
+        run: mise run lua:lint
+
   test:
     name: Run Tests
     runs-on: ubuntu-latest

.gitignore

@@ -0,0 +1,36 @@
+---@meta
+
+---@alias BustedCallback fun()
+
+---@param name string
+---@param callback BustedCallback
+function describe(name, callback) end
+
+---@param name string
+---@param callback BustedCallback
+function it(name, callback) end
+
+---@param name string
+---@param callback BustedCallback
+function active_it(name, callback) end
+
+---@param callback BustedCallback
+function before_each(callback) end
+
+---@param callback BustedCallback
+function after_each(callback) end
+
+---@param name string
+---@param callback? BustedCallback
+function pending(name, callback) end
+
+---@class LuassertChain
+---@field same fun(expected: any, actual: any, message?: string)
+---@field equals fun(expected: any, actual: any, message?: string)
+---@field is_true fun(value: any, message?: string)
+
+---@class Luassert: LuassertChain
+---@field are LuassertChain
+
+---@type Luassert|function
+assert = assert

.lua_ls/busted.lua

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
+  "runtime.version": "LuaJIT",
+  "diagnostics.globals": [
+    "vim"
+  ],
+  "workspace.library": [
+    ".lua_ls"
+  ],
+  "workspace.checkThirdParty": false,
+  "workspace.ignoreDir": [
+    ".git"
+  ]
+}

.luarc.json

@@ -3,10 +3,20 @@
   },
   "markdown": {
   },
-  "toml": {
-  },
   "yaml": {
   },
+  "exec": {
+    "commands": [
+      {
+        "command": "stylua --allow-hidden --respect-ignores --stdin-filepath {{file_path}} -",
+        "exts": [".lua"]
+      },
+      {
+        "command": "taplo format -",
+        "exts": [".toml"]
+      }
+    ]
+  },
   "excludes": [
     "CHANGELOG.md",
     "**/*-lock.json"
@@ -20,10 +30,9 @@
     "**/*.toml"
   ],
   "plugins": [
-    "https://plugins.dprint.dev/RubixDev/stylua-v0.2.1.wasm",
     "https://plugins.dprint.dev/json-0.21.3.wasm",
     "https://plugins.dprint.dev/markdown-0.22.1.wasm",
-    "https://plugins.dprint.dev/toml-0.7.0.wasm",
-    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.6.0.wasm"
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.6.0.wasm",
+    "https://plugins.dprint.dev/exec-0.6.0.json@a054130d458f124f9b5c91484833828950723a5af3f8ff2bd1523bd47b83b364"
   ]
 }