GitHub Actions

.cspell.json

@@ -0,0 +1,18 @@
+{
+  "words": [
+    "Aire-One",
+    "capi",
+    "constructorfct",
+    "fatalwarnings",
+    "fullscreen",
+    "hasitem",
+    "JohnnyMorganz",
+    "ldoc",
+    "luacheck",
+    "luadoc",
+    "lunarmodules",
+    "mousebindings",
+    "staticfct",
+    "stylua"
+  ]
+}

.editorconfig

@@ -11,5 +11,5 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.json]
+[*.{json,yaml}]
 indent_size = 2

.github/workflows/doc.yaml

@@ -0,0 +1,38 @@
+name: Build doc
+
+on:
+  push:
+    branches:
+      - $default-branch
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: lunarmodules/[email protected]
+      - uses: actions/upload-pages-artifact@v3
+        id: deployment
+        with:
+          path: doc/
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deployment

.github/workflows/lint.yaml

@@ -0,0 +1,43 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - $default-branch
+  pull_request:
+
+jobs:
+  luacheck:
+    needs: []
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: lunarmodules/luacheck@v1
+
+  stylua:
+    needs: []
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: v0.20.0
+          args: --check .
+
+  ldoc:
+    needs: []
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: lunarmodules/[email protected]
+        with:
+          args: --fatalwarnings .
+
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@v6
+        with:
+          incremental_files_only: false

README.md

@@ -4,3 +4,18 @@ A declarative API to connect signals for the AwesomeWM.
 
 It completes the native `gears.signal` module to make signal connection easier
 to manage.
+
+## Documentation
+
+API references for the latest release are available at <https://aire-one.github.io/awesome-slot/index.html>.
+
+It is also possible to manually build the documentation locally using ldoc. The
+documentation content is part of the source code, and all configurations needed
+are provided by the `config.ld` file. To generate documentation, you need to
+run :
+
+```sh
+ldoc .
+```
+
+The documentation site will be generated in the `doc` directory.

src/awesome-slot/init.lua

@@ -108,7 +108,7 @@ end
 -- @tparam string params.signal The signal the slot connects to.
 -- @tparam function params.slot The callback function to connect to the signal.
 -- @tparam table params.slot_params The parameters to pass to the callback
---   function. (The signal will invok the callback function with this table as
+--   function. (The signal will invoke the callback function with this table as
 --   parameter)
 -- @tparam[opt=false] boolean params.connect Connect the slot now.
 -- @treturn Slot The created Slot instance.
@@ -201,5 +201,3 @@ function awesome_slot.mt:__call(...) -- luacheck: ignore unused argument self
 end
 
 return setmetatable(awesome_slot, awesome_slot.mt)
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

src/awesome-slot/slots/client.lua

@@ -1,21 +1,19 @@
 local client_slots = {}
 
 function client_slots.append_mousebindings(params)
-   local amouse = require "awful.mouse"
+   local mouse = require "awful.mouse"
 
    for _, bindings in pairs(params.mousebindings) do
-      amouse.append_client_mousebindings(bindings)
+      mouse.append_client_mousebindings(bindings)
    end
 end
 
 function client_slots.append_keybindings(params)
-   local akeyboard = require "awful.keyboard"
+   local keyboard = require "awful.keyboard"
 
    for _, bindings in pairs(params.keybindings) do
-      akeyboard.append_client_keybindings(bindings)
+      keyboard.append_client_keybindings(bindings)
    end
 end
 
 return client_slots
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

src/awesome-slot/slots/init.lua

@@ -1,10 +1,8 @@
-local aslot_slots = {}
+local slots = {}
 
-aslot_slots.client = require "awesome-slot.slots.client"
-aslot_slots.ruled = require "awesome-slot.slots.ruled"
-aslot_slots.screen = require "awesome-slot.slots.screen"
-aslot_slots.tag = require "awesome-slot.slots.tag"
+slots.client = require "awesome-slot.slots.client"
+slots.ruled = require "awesome-slot.slots.ruled"
+slots.screen = require "awesome-slot.slots.screen"
+slots.tag = require "awesome-slot.slots.tag"
 
-return aslot_slots
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
+return slots

src/awesome-slot/slots/ruled.lua

@@ -1,21 +1,19 @@
 local ruled_slots = {}
 
 function ruled_slots.append_client_rules(params)
-   local rclient = require "ruled.client"
+   local client = require "ruled.client"
 
    for _, rule in pairs(params.rules) do
-      rclient.append_rule(rule)
+      client.append_rule(rule)
    end
 end
 
 function ruled_slots.append_notification_rules(params)
-   local rnotification = require "ruled.notification"
+   local notification = require "ruled.notification"
 
    for _, rule in pairs(params.rules) do
-      rnotification.append_rule(rule)
+      notification.append_rule(rule)
    end
 end
 
 return ruled_slots
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

src/awesome-slot/slots/screen.lua

@@ -2,24 +2,22 @@ local screen_slots = {}
 
 function screen_slots.wallpaper(screen, params)
    local beautiful = require "beautiful"
-   local gwallpaper = require "gears.wallpaper"
+   local wallpaper = require "gears.wallpaper"
 
    params = params or {
       wallpaper = beautiful.wallpaper,
    }
 
-   local wallpaper = params.wallpaper
+   local w = params.wallpaper
 
-   if wallpaper then
+   if w then
       -- If wallpaper is a function, call it with the screen
-      if type(wallpaper) == "function" then
-         wallpaper = wallpaper(screen)
+      if type(w) == "function" then
+         w = w(screen)
       end
 
-      gwallpaper.maximized(wallpaper, screen, true)
+      wallpaper.maximized(w, screen, true)
    end
 end
 
 return screen_slots
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

src/awesome-slot/slots/tag.lua

@@ -1,11 +1,9 @@
 local tag_slots = {}
 
 function tag_slots.default_layouts(params)
-   local alayout = require "awful.layout"
+   local layout = require "awful.layout"
 
-   alayout.append_default_layouts(params.layouts)
+   layout.append_default_layouts(params.layouts)
 end
 
 return tag_slots
-
--- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80