chore: configure lua-local debugger for Teal 🧙

.busted

@@ -1,3 +1,7 @@
+if os.getenv "LOCAL_LUA_DEBUGGER_VSCODE" == "1" then
+   require("lldebugger").start()
+end
+
 require("tl").loader()
 
 local version <const> = _VERSION:match "%d+%.%d+"
@@ -10,11 +14,14 @@ local function lua_module_paths(module_base_path)
 end
 
 return {
-   default = {
+   _all = {
       lpath = lua_module_paths("lua_modules/share/lua/" .. version)
          .. lua_module_paths "types"
          .. lua_module_paths "./src/awesomewm.d.tl",
       cpath = "lua_modules/lib/lua/" .. version .. "/?.so;",
       loaders = { "teal" },
    },
+   coverage = {
+      coverage = true,
+   },
 }

.vscode/launch.json

@@ -8,7 +8,18 @@
       "program": {
         "command": "just"
       },
-      "args": ["debug"]
+      "args": ["run"],
+      "scriptFiles": ["${workspaceFolder}/**/*.tl"]
+    },
+    {
+      "name": "Debug specs",
+      "type": "lua-local",
+      "request": "launch",
+      "program": {
+        "command": "just"
+      },
+      "args": ["test"],
+      "scriptFiles": ["${workspaceFolder}/**/*.tl"]
     }
   ]
 }

.vscode/settings.json

@@ -1,10 +1,8 @@
 {
-  "editor.formatOnSave": true,
-  "editor.formatOnPaste": true,
   "[markdown]": {
-    "editor.wordWrap": "on",
+    "editor.acceptSuggestionOnEnter": "off",
     "editor.renderWhitespace": "all",
-    "editor.acceptSuggestionOnEnter": "off"
+    "editor.wordWrap": "on"
   },
   "cSpell.words": [
     "aire-one",
@@ -43,9 +41,12 @@
     "woodpeckerci",
     "writefunction"
   ],
+  "debug.allowBreakpointsEverywhere": true,
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
   "files.associations": {
+    ".busted": "lua",
     ".luacheckrc": "lua",
-    "*.rockspec": "lua",
-    ".busted": "lua"
+    "*.rockspec": "lua"
   }
 }

justfile

@@ -49,11 +49,3 @@ validate:
 
 test:
   busted
-
-# TODO : how to run a debugger on Teal code?
-debug:
-  {{ lua }} debug.lua build/awesomewm.d.tl/init.lua
-debug-gen:
-  cyan gen --output set_paths.lua --gen-compat "off" set_paths.tl
-  sed -i 's/"src\/awesomewm.d.tl"/"build\/awesomewm.d.tl"/g' set_paths.lua
-  stylua set_paths.lua

src/awesomewm.d.tl/init.tl

@@ -1,3 +1,7 @@
+if os.getenv("LOCAL_LUA_DEBUGGER_VSCODE") == "1" then
+   require("lldebugger").start()
+end
+
 local crawler = require "crawler"
 local filesystem = require "filesystem"
 local generator = require "generator"

types/lldebugger.d.tl

@@ -0,0 +1,5 @@
+local record Lldebugger
+   start: function()
+end
+
+return Lldebugger