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

Go to file

Aire-One 6cfee3f49f ci/woodpecker/push/lint Pipeline was successful Details ci/woodpecker/pr/lint Pipeline was successful Details ci/woodpecker/push/build Pipeline was successful Details ci/woodpecker/pr/build Pipeline was successful Details fix(scraper): get_doc_from_page wrong message		2022-10-04 20:40:28 +02:00
.vscode	feat(crawler): manage `file://` protocol	2022-09-11 03:17:40 +02:00
.woodpecker	ci(build): comment out `run` and `verify` steps	2022-10-02 21:16:00 +02:00
rockspecs	feat(rockspec): remove htmlparser dependency	2022-09-29 19:20:40 +02:00
src/awesomewm.d.tl	fix(scraper): get_doc_from_page wrong message	2022-10-04 20:40:28 +02:00
types	fix(types): some issues found in pl definitions	2022-10-02 20:55:02 +02:00
.editorconfig	build(teal): initial teal config	2022-09-29 20:38:03 +02:00
.gitignore	build(teal): initial teal config	2022-09-29 20:38:03 +02:00
.luacheckrc	initial	2022-06-26 17:43:18 +02:00
README.MD	chore: add woodpecker status badge in README ✅	2022-08-12 19:54:34 +02:00
debug.lua	initial	2022-06-26 17:43:18 +02:00
justfile	build(just): fix targets find command	2022-09-29 20:38:03 +02:00
set_paths.lua	chore(set_paths): add teal types and build paths	2022-09-29 20:38:03 +02:00
stylua.toml	initial	2022-06-26 17:43:18 +02:00
tlconfig.lua	build(teal): initial teal config	2022-09-29 20:38:03 +02:00

AwesomeWM.d.tl

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

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:

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