Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One 1d06f17edf
ci/woodpecker/pr/docker-build Pipeline was successful Details
ci/woodpecker/pr/lint Pipeline was successful Details
ci/woodpecker/pr/build Pipeline was successful Details
ci/woodpecker/pr/test Pipeline was successful Details
ci(test): install dependencies only once
2023-09-18 12:34:37 +02:00
.vscode fixup! chore: remove special characters from module name 2023-09-18 12:08:21 +02:00
.woodpecker ci(test): install dependencies only once 2023-09-18 12:34:37 +02:00
bin fixup! chore: remove special characters from module name 2023-09-18 12:08:21 +02:00
spec chore: remove special characters from module name 2023-09-18 12:04:36 +02:00
src/awesomewmdtl chore: remove special characters from module name 2023-09-18 12:04:36 +02:00
types chore: configure lua-local debugger for Teal 🧙 2023-05-05 00:04:25 +02:00
.busted chore: fix busted config 2023-09-04 00:29:18 +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
awesomewmdtl-dev-1.rockspec chore: configure tests in luarocks 2023-09-18 12:22:05 +02:00
debug.lua initial 2022-06-26 17:43:18 +02:00
justfile chore: configure tests in luarocks 2023-09-18 12:22:05 +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.