Automatically extracts the full EdgeTX Lua API from C++ source, generates structured JSON and LuaLS-compatible .d.lua stubs — and keeps them in sync with upstream EdgeTX releases.

• Fetches all api_ source files (api_general.cpp, api_colorlcd.cpp, api_model.cpp, api_filesystem.cpp etc.) directly from the EdgeTX GitHub repo (/repos/EdgeTX/edgetx/contents/radio/src/lua?ref=${version}) — no local files needed
• Extracts every /*luadoc ... */ comment block — the same source as the official EdgeTX documentation
• Scans C++ Lua registration tables for constants not covered by luadoc blocks
• Infers types (number, string, boolean, table, nil etc.) for every parameter and return value
• Extracts flag hints (e.g. BOLD, BLINK, PLAY_NOW) from parameter descriptions
• Tracks availableOn per function and constant: GENERAL, COLOR_LCD, or NON_COLOR_LCD
• Generates .d.lua stub files for the Lua Language Server (LuaLS) with full annotation support
• Publishes versioned stubs and a manifest to edgetx-stubs — ready to be consumed by the EdgeTX Dev Kit VS Code extension

This repo runs a GitHub Actions pipeline on a schedule (Monday and Thursday) and on every push to main. It checks for changes in EdgeTX source files before regenerating — so no redundant work is done.

EdgeTX repo (upstream) │ ▼ GitHub Actions (scheduled + push triggered) │ ├─ Fetch source file SHAs from EdgeTX repo ├─ Compare against manifest — skip if nothing changed ├─ Parse changed sources → generate edgetx-lua-api.json and edgetx-script-types.json ├─ Generate .d.lua stubs per module ├─ Generate script type stubs (eg: telemetry script) ├─ Hash all output files └─ Commit stubs + manifest to edgetx-stubs repo 

The VS Code extension fetches manifest.json silently on activation and downloads only what has changed.

Each run produces a versioned edgetx-lua-api.json with two top-level arrays: functions and constants, plus edgetx-script-types.json and a set of .d.lua stub files per EdgeTX version.

{ "version": "2.10", "generated": "2026-03-14T11:16:11.396Z", "functions": [ { "entityType": "function", "module": "lcd", "name": "drawPoint", "signature": "lcd.drawPoint(x, y, [flags])", "description": "Draw a single pixel at (x,y) position", "parameters": [ { "name": "x", "type": "number", "description": "(positive number) x position", "optional": false, "flagHints": [] }, { "name": "y", "type": "number", "description": "(positive number) y position", "optional": false, "flagHints": [] }, { "name": "flags", "type": "number", "description": "(optional) drawing flags", "optional": true, "flagHints": [] } ], "overloadParameters": [], "returns": [], "notices": [ "Taranis has an LCD display width of 212 pixels and height of 64 pixels." ], "status": "current Introduced in 2.0.0", "sinceVersion": "2.0.0", "deprecated": false, "sourceFile": "api_colorlcd.cpp", "availableOn": "GENERAL" } ], "constants": [ { "entityType": "constant", "name": "COLOR_THEME_PRIMARY1", "module": "lcd", "description": "Theme color. Can be changed with lcd.setColor(color_index, color).", "sourceFile": "api_colorlcd.cpp", "availableOn": "COLOR_LCD" } ] }

The generator maintains a manifest.json in the edgetx-stubs repo. The VS Code extension uses it to silently detect when stubs need updating — without re-downloading everything every time.

{ "manifestVersion": 1, "updatedAt": "2026-03-16T06:00:00Z", "versions": { "2.10": { "generatedAt": "2026-03-16T06:00:00Z", "stubHash": "f7e6d5c4a3b2e1d0...", "sources": { "radio/src/lua/api_colorlcd.cpp": "fda476ff4e5bd1cccc2cc55b30176086c6fd2be2", "radio/src/lua/api_general.cpp": "a1b2c3d4e5f6g7h8...", "radio/src/lua/api_misc.cpp": "e5f6g7h8i9j0k1l2..." }, "files": [ "edgetx-lua-api.json", "edgetx.globals.d.lua", "edgetx.constants.d.lua", "edgetx.scripts.d.lua", "lcd.d.lua", "model.d.lua" ] } } }

Generated stubs and the manifest are published to the edgetx-stubs repo — this repo contains only the generator source and pipeline.

/ └── src/ ├── index.ts ← Entry point — CLI, orchestration, JSON output ├── fetcher.ts ← Downloads C++ source files from the EdgeTX GitHub repo ├── parser.ts ← luadoc block extraction + C++ registration table scan ├── typeInferrer.ts ← Infers LuaValueType from param names and descriptions ├── flagLinker.ts ← Extracts ALL_CAPS flag references from param descriptions ├── scriptTypes.ts ← Handcrafted types for edgetx script types ├── stubgen.ts ← Generates .d.lua stub files from the API JSON ├── scriptsgen.ts ← Called from `stubgen.ts`. Generates .d.lua stub files from `scriptTypes.ts` ├── helpers.ts ← Helper functions ├── regex.ts ← Major regular expressions └── types.ts ← All TypeScript interfaces 

npm install

Create a .env file for local runs:

GITHUB_TOKEN=github_pat_xxxxxx NODE_ENV=development 

A fine-grained GitHub personal access token is recommended. Set Contents: Read and Write on this repo only. The token raises your GitHub API rate limit from 60 to 5,000 requests/hour — necessary when fetching branch lists and source file SHAs across multiple EdgeTX versions.

# Fetch latest from GitHub (main branch) and write to stubs/ npm start # Fetch all from GitHub and write to stubs/ npm run all # Equivalent explicit form npx tsx src/index.ts --version main --withstubs

# Fetch a specific EdgeTX version branch npx tsx src/index.ts --version 2.10 --withstubs # Fetch ALL numeric version branches from the EdgeTX repo npx tsx src/index.ts --version all --withstubs # Custom output directory (default: stubs/) npx tsx src/index.ts --version 2.10 --outDir ./releases/2.10 --withstubs

Stubs are generated as part of extraction via --withstubs and published to edgetx-stubs. The generator produces one .d.lua file per Lua module, derived from the module prefix in each function's name (e.g. lcd.drawText → lcd.d.lua). Functions with no module prefix land in edgetx.globals.d.lua.

stubs/2.10/ ├── edgetx-lua-api.json ← full merged API, all sources ├── edgetx-script-types.json ← edgetx script types ├── edgetx.globals.d.lua ← global functions (no module prefix) ├── edgetx.constants.d.lua ← all constants grouped by module ├── edgetx.scripts.d.lua ← script types ├── edgetx.lcd.d.lua ← lcd.* namespace ├── edgetx.model.d.lua ← model.* namespace ├── edgetx.bitmap.d.lua ← Bitmap.* namespace └── ... ← any future modules are handled automatically 

Each file uses LuaCATS annotations (---@param, ---@return, ---@overload, ---@class, ---@deprecated etc.) for full IntelliSense support in the Lua Language Server.

The pipeline runs automatically. No manual intervention is needed for routine updates.

The source SHA check means the scheduled run is a no-op most of the time — it only does real work when EdgeTX actually changes a Lua API file.

The generator is intentionally structured so new EdgeTX modules require no code changes — any function with an unrecognised module prefix automatically gets its own stub file. If you find a parsing gap or a type inference miss, the relevant files are parser.ts and typeInferrer.ts.