Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One 5ca672d0ed
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
test: play with local modules
2023-04-17 00:38:17 +02:00
.vscode wip: try some stuff 2023-04-17 00:08:35 +02:00
.woodpecker feat(ci): version management in cyan dockerfile 2023-02-03 23:27:34 +01:00
rockspecs chore: clean rockspec 2023-04-17 00:37:22 +02:00
src test: play with local modules 2023-04-17 00:38:17 +02:00
types build(types): luassert 2023-04-17 00:08:35 +02:00
.busted wip: try some stuff 2023-04-17 00:08:35 +02:00
.editorconfig wip: try some stuff 2023-04-17 00:08:35 +02:00
.gitignore chore: clean ignored files 2023-04-17 00:09:41 +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 test: move tests to compiled file 2023-04-17 00:09:41 +02:00
run-busted.lua test: play with local modules 2023-04-17 00:38:17 +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 tests to compiled file 2023-04-17 00:09:41 +02: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.