Repository files navigation

Please note that Typed Lua is not being actively maintained. For an active type checker for Lua seetl.

Typed Lua is a typed superset of Lua that compiles to plain Lua.It provides optional type annotations, compile-time type checking, andclass-based object oriented programming through the definition of classes,interfaces, and modules.

1. Lua >= 5.1
2. LPeg >= 0.12

Typed Lua must be installed in a standard location;LuaRocks will do this, and will also install the LPeg dependency automatically.

    $ [install luarocks]    $ luarocks install typedlua-scm-1.rockspec

    $ tlc [options] [filename]

    -h       print this help    -d name  dump the AST (after typechecking) to file 'name'    -o name  output to file 'name' (default is 'tlc.lua')    -c       ansi colors on    -p       print the AST in Metalua format (before typechecking)    -s       strict mode on    -v       print current version    -w       warnings on (consistent-subtyping, unused locals)

Typed Lua also provides a runtime loader to use Typed Lua modules on anystandard Lua virtual machine:

require"typedlua"package.path="./?.tl;"..package.path-- It will load my_module.tl if it exists:localmy_module=require"my_module"localmy_file=loadfile"my_file.tl"

The loader functions use the file extension (chunk name extension in the casesof load and loadstring) to decide whether it contains Typed Lua (.tl) or plainLua. If you want to force loading the chunks as Typed Lua you can use thefunctions provided by the typedlua module (these work like their standard Luacounterparts):

localtypedlua=require"typedlua"typedlua.loadstring(string,chunkname)typedlua.load(func,chunkname)typedlua.loadfile(filename)typedlua.dofile(filename)

Released under the MIT License (MIT)

Copyright (c) 2013 Andre Murbach Maidl

Permission is hereby granted, free of charge, to any person obtaining a copy ofthis software and associated documentation files (the "Software"), to deal inthe Software without restriction, including without limitation the rights touse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies ofthe Software, and to permit persons to whom the Software is furnished to do so,subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESSFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS ORCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHERIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR INCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.