yjhmelody / tl

The compiler for Teal, a typed dialect of Lua

Teal

This is the repository of tl, the compiler for Teal, a typed dialect of Lua.

Introduction

Here are videos of talks given at FOSDEM 2019 and 2020 which discuss the history of Lua and types, outline the motivations behind Teal and talk about the project's progress:

• Minimalism versus types (2019)
• Minimalistic typed Lua is here (2020)

Installing

Install Lua and LuaRocks, then run:

luarocks install tl

This should put a tl command in your $PATH (run eval $(luarocks path) if the LuaRocks-installed binaries are not in your $PATH)

Running

Once tl is in your path, there are a few subcommands:

• tl run script.tl will run a Teal script.
• tl check module.tl will type check a Teal module, report any errors and quit.
• tl gen module.tl will type check a Teal module, and if there's no syntax errors, generate a module.lua file in plain Lua with all type annotations stripped.

Documentation

You can learn more about programming with Teal in the tutorial.

Type definitions

We have a collaborative repository for type definitions of Lua libraries at https://github.com/teal-language/teal-types — check it out and make your contribution!

Community

Join the chat on Gitter!

Teal is a project started by Hisham Muhammad, developed by a growing number of contributors and is written using Teal itself!

License

License is MIT, the same as Lua.