Generate Teal types definitions for the Awesome WM based on the API documentation 📄

Go to file

Aire-One e43ca1d3fc Merge pull request 'chore: format dockerfile' (#81 ) from fix/tests-teal into master Reviewed-on: #81		2023-05-01 16:36:41 +02:00
.vscode	test(config): fix busted config to run teal code	2023-05-01 16:28:37 +02:00
.woodpecker	chore: format dockerfile	2023-05-01 16:26:42 +02:00
rockspecs	chore: clean rockspec	2023-04-17 00:37:22 +02:00
spec	test: move to `busted-tl`	2023-04-24 00:14:32 +02:00
src/awesomewm.d.tl	test: move to `busted-tl`	2023-04-24 00:14:32 +02:00
types	build(types): luassert	2023-04-17 00:08:35 +02:00
.busted	test(config): fix busted config to run teal code	2023-05-01 16:28:37 +02:00
.editorconfig	wip: try some stuff	2023-04-17 00:08:35 +02:00
.gitignore	test: move to `busted-tl`	2023-04-24 00:14:32 +02:00
.luacheckrc	initial	2022-06-26 17:43:18 +02:00
README.MD	chore: update README	2023-04-24 00:14:49 +02:00
debug.lua	initial	2022-06-26 17:43:18 +02:00
justfile	ci: fix busted-tl_just	2023-04-24 02:10:10 +02:00
set_paths.lua	run(justfile): run recipe run sources with Teal	2022-10-11 18:41:03 +02:00
set_paths.tl	run: `set_path.tl` build -> src	2022-10-22 15:02:47 +02:00
stylua.toml	initial	2022-06-26 17:43:18 +02:00
tlconfig.lua	test: move to `busted-tl`	2023-04-24 00:14:32 +02:00

AwesomeWM.d.tl

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

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.

# 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.