lgi-devs / lgi-devs/lgi

[Discussion] type definitions from GIR

Open
#339 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
491
Forks
81
PR merge metrics
No merged PRs in 30d

Description

There is a project https://github.com/teal-language/teal-types/ where Lua libraries earn their type definitions (in Teal syntax).
Because LGI content is generated dynamically, it's not as straightforward to do the same for it.

If someone would want to generate it, what would be the "one true way" to do it? Any idea is welcome.

P.S. Opening this issue because (1) https://matrix.to/#/%23LuaLang:matrix.org isn't very active about LGI, and (2) I've found no other chat/forum where LGI questions would be appropriate.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the teal-types project and how LGI content is generated dynamically through GObject-Introspection. Define and discuss a single generation approach, including the expected Teal output; the issue provides no files or tests to run, so the design must be established before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.