Generate Teal types definitions for the Awesome WM based on the API documentation 📄
Go to file
Aire-One 896c7f2f04 feat(scraper): function can populate `other_nodes`
To allow `extract_section_functions`  to populate `other_node`, we need
to use the `module_name` and migrate the function name scrap method to
use the actually displayed text instead of playing with the node `name`
attribute.

Because of this change, we also need to update
`extract_section_variables`. Not a big deal. BTW, we resolved an issue
where `string` variable can wrongly be detected as `enum`.
2023-05-01 16:46:07 +02:00
.vscode feat(scraper): function can populate `other_nodes` 2023-05-01 16:46:07 +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 test: move to `busted-tl` 2023-04-24 00:14:32 +02:00
src/awesomewm.d.tl feat(scraper): function can populate `other_nodes` 2023-05-01 16:46:07 +02:00
types build(types): luassert 2023-04-17 00:08:35 +02:00
.busted test(config): fix busted config to run teal code 2023-05-01 16:28:37 +02:00
.editorconfig wip: try some stuff 2023-04-17 00:08:35 +02:00
.gitignore test: move to `busted-tl` 2023-04-24 00:14:32 +02:00
.luacheckrc initial 2022-06-26 17:43:18 +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 ci: fix busted-tl_just 2023-04-24 02:10:10 +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.

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

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.