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

Go to file

Aire-One 631f78ff6a ci/woodpecker/pr/lint Pipeline was successful Details ci/woodpecker/pr/build Pipeline was successful Details fix(generator): render_typed_variable concat The `snippets.render_typed_variable` types concat characters were wrong. Teal union uses pipe-separator " \| " not comma ", ".		2022-10-31 11:18:03 +01:00
.vscode	feat(crawler): manage `file://` protocol	2022-09-11 03:17:40 +02:00
.woodpecker	ci: only run on master branch	2022-10-23 19:01:39 +02:00
rockspecs	feat(rockspec): remove htmlparser dependency	2022-09-29 19:20:40 +02:00
src/awesomewm.d.tl	fix(generator): render_typed_variable concat	2022-10-31 11:18:03 +01:00
types	build(types): fix scan_html indentation level	2022-10-23 21:07:49 +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	run(justfile): run recipe run sources with Teal	2022-10-11 18:41:03 +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	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.