Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One 6ee57456b9 chore(ci): disable woodpecker lint
The woodpecker-cli version used has moved, and the current woodpecker
server installed is too old to have configuration that passes the newer
lint rules.

We'll need to first update the woodpecker server, then port the config,
and finally enable back this lint step.
2023-09-04 00:28:50 +02:00
.vscode chore: update the `Debug spec` command 2023-08-01 23:38:06 +02:00
.woodpecker chore(ci): disable woodpecker lint 2023-09-04 00:28:50 +02:00
bin chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
spec feat(printer): teal_type_definition should use the `require type` notation 2023-08-01 23:40:49 +02:00
src/awesomewm-d-tl chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
types chore: configure lua-local debugger for Teal 🧙 2023-05-05 00:04:25 +02:00
.busted chore: configure lua-local debugger for Teal 🧙 2023-05-05 00:04:25 +02:00
.editorconfig chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
.gitignore chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
.luacheckrc initial 2022-06-26 17:43:18 +02:00
.luacov chore: configure coverage 2023-05-08 23:12:49 +02:00
LICENSE.md chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
README.md chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
awesomewm-d-tl-dev-1.rockspec chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
debug.lua initial 2022-06-26 17:43:18 +02:00
justfile chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
set_paths.tl chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00
stylua.toml initial 2022-06-26 17:43:18 +02:00
tlconfig.lua chore: rockspec, structure and entry point 2023-09-03 18:38:11 +02:00

README.md

AwesomeWM.d.tl

A project to generate Teal types definitions for the Awesome WM based on the API documentation.

status-badge

Dependencies

Project dependencies

  • Lua5.4
  • Luarocks
  • Just (optional, you can check the commands in the justfile and manually run them)

Note that additional dependencies are installed as rocks with Luarocks.

Development dependencies

Run the project

# Install rocks
just install

# Run the main script
just run

Custom settings for the project can be changed in the src/awesomewm.d.tl/properties.lua file.