chatterino2
Code Issues

refactor: move LuaLS meta to a subdirectory (#6530)

Browse Source
This commit is contained in:
nerix
2025-10-08 15:56:01 +02:00
committed by GitHub
parent 4abf8c59f7
commit 4be0e13883
4 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+1
View File
@@ -23,6 +23,7 @@
- Dev: Refactored `Emotes` into `EmoteController`. (#6516) - Dev: Refactored `Emotes` into `EmoteController`. (#6516)
- Dev: Added Qt keyword and warning flags project wide. (#6520) - Dev: Added Qt keyword and warning flags project wide. (#6520)
- Def: Fixed compilation error in tests with Clang 21. (#6519) - Def: Fixed compilation error in tests with Clang 21. (#6519)
- Dev: The LuaLS meta files moved from `docs/plugin-meta.lua` to `docs/lua-meta/globals.lua`. (#6530)
## 2.5.4 ## 2.5.4
docs/plugin-meta.lua → docs/lua-meta/globals.lua
+1 -1
View File
@@ -1,4 +1,4 @@
---@meta Chatterino2 ---@meta _
-- This file is automatically generated from src/controllers/plugins/LuaAPI.hpp by the scripts/make_luals_meta.py script -- This file is automatically generated from src/controllers/plugins/LuaAPI.hpp by the scripts/make_luals_meta.py script
-- This file is intended to be used with LuaLS (https://luals.github.io/). -- This file is intended to be used with LuaLS (https://luals.github.io/).
docs/wip-plugins.md
+2 -2
View File
@@ -113,7 +113,7 @@ runtime.
## LuaLS type definitions ## LuaLS type definitions
Type definitions for LuaLS are available in Type definitions for LuaLS are available in
[the `/plugin-meta.lua` file](./plugin-meta.lua). These are generated from [the C++ [the `/lua-meta` directory](./lua-meta). These are generated from [the C++
headers](../src/controllers/plugins/LuaAPI.hpp) of Chatterino using [a headers](../src/controllers/plugins/LuaAPI.hpp) of Chatterino using [a
script](../scripts/make_luals_meta.py). script](../scripts/make_luals_meta.py).
@@ -607,7 +607,7 @@ c2.register_command("/testing", function(ctx)
end) end)
``` ```
The full range of options can be found in the typing files ([LuaLS](./plugin-meta.lua), [TypeScript](./chatterino.d.ts)). The full range of options can be found in the typing files ([LuaLS](./lua-meta/globals.lua), [TypeScript](./chatterino.d.ts)).
#### `LinkType` enum #### `LinkType` enum
scripts/make_luals_meta.py
+2 -2
View File
@@ -43,7 +43,7 @@ import re
from typing import Optional from typing import Optional
BOILERPLATE = """ BOILERPLATE = """
---@meta Chatterino2 ---@meta _
-- This file is automatically generated from src/controllers/plugins/LuaAPI.hpp by the scripts/make_luals_meta.py script -- This file is automatically generated from src/controllers/plugins/LuaAPI.hpp by the scripts/make_luals_meta.py script
-- This file is intended to be used with LuaLS (https://luals.github.io/). -- This file is intended to be used with LuaLS (https://luals.github.io/).
@@ -54,7 +54,7 @@ c2 = {}
repo_root = Path(__file__).parent.parent repo_root = Path(__file__).parent.parent
lua_api_file = repo_root / "src" / "controllers" / "plugins" / "LuaAPI.hpp" lua_api_file = repo_root / "src" / "controllers" / "plugins" / "LuaAPI.hpp"
lua_meta = repo_root / "docs" / "plugin-meta.lua" lua_meta = repo_root / "docs" / "lua-meta" / "globals.lua"
print("Writing to", lua_meta.relative_to(repo_root)) print("Writing to", lua_meta.relative_to(repo_root))