blob: 6e3f9c26bfb2bb8f692ddb2935cb11cd1dad00db (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
# Teal definitions and sources
This directory contains files written in the
[Teal](https://github.com/teal-language/tl) language, a typed dialect of
Lua. There are two kinds of files, `.tl` Teal source code and `.d.tl`
type definitions files for modules written in Lua. The later allows
writing type-aware Teal using regular Lua or C code.
## Setup
The Teal compiler can be installed from LuaRocks using:
```bash
luarocks install tl
```
## Checking types
```bash
tl check teal-src/prosody/util/example.tl
```
Some editors and IDEs also have support, see [text editor
support](https://github.com/teal-language/tl#text-editor-support)
## Files of note
`module.d.tl`
: Describes the module environment.
|