teal-language/teal-types

Teal type definitions of Lua libraries!

teal-types's Issues

How am I supposed to use this library?

My folder structure looks like this:

.
├── dist
│   └── ...
├── lua_modules
│   ├── lib
│   └── share
├── src
│   ├── init.tl
│   ├── inspect.d.tl
├── tlconfig.lua

lua_modules has been populated by luarocks install <package> --tree lua_modules with, eg, inspect.
In this case, should I just copy the contents of inspect.d.tl from this repo into src/inspect.d.tl?

Add type declarations for Penlight

Penlight is a "batteries"-type module for Lua, and I feel like teal would greatly benefit from integrating properly with it.

I will start my fork along with this issue, I just wanted to create this for documentation's sake.

Error: could not predefine module 'types'

I'm trying to generate types for neovim, I cloned the repo, copied the files from types/neovim/* to the root directory and ran ./autogen, tho I'm getting the error

Error: could not predefine module 'types'

It's caused by the first command: tl check autogen_tl -q

Setup CI

Considering that some changes such as teal-language/tl#159 may break a few things in the declaration files, it would be a good idea to setup CI for this repo.

how to avoid directory structure copy pasta

I am running into an issue where the folder structure of a shared typing library must also match the folder structure of the luarock paths. Ideally the types could be inferred from the luarock e.g. @types/kong, but not sure how to have tl know how to reconcile the defintion files.

├── kong
│   ├── db
│   │   ├── schema
│   │   │   └── typedefs.d.tl <----- would be nice to avoid creating the file structure since plugins (as you know @hishamhm :P) are placed within the larger context of kong with its own rockspec tree
│   │   └── schema.d.tl
│   └── plugins
│       └── myplugin
│           ├── handler.tl
│           └── schema.tl
├── kong-plugin-myplugin-0.1.0-1.rockspec
├── tlconfig.lua
└── types <----------- in the future would be nice to pull from teal-types luarocks similar to @types/<package> in typescript
    ├── kong
    │   ├── db
    │   │   ├── schema
    │   │   │   └── typedefs.d.tl
    │   │   └── schema.d.tl
    │   └── plugins
    │       └── session.d.tl
    ├── kong.d.tl
    ├── kong.lua
    ├── resty
    │   └── session.d.tl
    └── resty.tl

local typedefs = require "kong.db.schema.typedefs"

local schema = {
  name = plugin_name,
  fields = {
    { consumer = typedefs.no_consumer }, -- typedefs is only known because of the explicit folder structure

return {
  gen_target = "5.1",
  -- Execute the equivalent of `require('modulename')` before executing the script.
  preload_modules = {
    "types.resty",
    "types.kong"
  }
}

How to write a .d.tl file for a framework (or something that isn't `require`d))

I am working on a .d.tl file for Neovim's Lua api, but since Neovim itself runs the code, there is no require("vim"). Putting preload_modules = {"vim"} causes a

Error: could not preload module 'vim'

In addition, frameworks like busted would have the same issues