Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One 013bff1a31
ci/woodpecker/pr/build Pipeline was successful Details
ci/woodpecker/pr/docker-build Pipeline was successful Details
ci/woodpecker/pr/lint Pipeline was successful Details
feat(Module_Doc): fixup to add property signals
This is a naive approach to automatically add all the `"property::"`
signals. A better way to do that would be to look for this information
in the documentation with the scrapper. It would be, however, less
efficient, and requires quite a few refactors of the data structure.

So this current naive approach will be good enough for now.
2023-01-08 17:56:51 +01:00
.vscode fix(filesystem): mkdir handle multiple parents 2022-12-19 22:47:47 +01:00
.woodpecker ci(docker-build): fix path 2022-12-10 01:50:25 +01:00
rockspecs fix(filesystem): mkdir handle multiple parents 2022-12-19 22:47:47 +01:00
src/awesomewm.d.tl feat(Module_Doc): fixup to add property signals 2023-01-08 17:56:51 +01:00
types fix(filesystem): mkdir handle multiple parents 2022-12-19 22:47:47 +01: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(justfile): fix the `validate` recipe 2022-12-28 18:55:53 +01: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 chore: clean `tlconfig.lua` 2022-12-28 19:07:20 +01: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:

  • Luacheck
  • Stylua

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.