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

Go to file

Aire-One 86ebdac0d9 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 fixup! feat(Visitors): implement type_mapping		2023-07-31 19:49:09 +02:00
.vscode	chore: update the `Debug spec` command	2023-05-14 13:04:45 +02:00
.woodpecker	Merge pull request 'Activate the `lint-pipeline` step (#22 )' (#82 ) from feat/#22 into master	2023-05-01 16:41:31 +02:00
rockspecs	chore: clean rockspec	2023-04-17 00:37:22 +02:00
spec	feat(printer): teal_type_definition should use the `require type` notation	2023-07-31 19:26:19 +02:00
src/awesomewm.d.tl	fixup! feat(Visitors): implement type_mapping	2023-07-31 19:49:09 +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: configure coverage	2023-05-08 23:12:49 +02:00
.gitignore	chore: configure coverage	2023-05-08 23:12:49 +02:00
.luacheckrc	initial	2022-06-26 17:43:18 +02:00
.luacov	chore: configure coverage	2023-05-08 23:12:49 +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	fixup! fixup! chore(just): add pattern parameter to test command	2023-05-14 13:00:27 +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

README.MD

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

Luacheck
Stylua
Busted-tl (https://gitea.aireone.xyz/Aire-One/busted-tl)

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.