/tfm-types

Environment definition generator for Transformice. Supports Lua Language Server and TypeScriptToLua.

Primary LanguageTypeScript

tfm-types

Environment definition generator for Transformice. Supports Lua Language Server and TypeScriptToLua.

Usage

Generating environment definition

pnpm install
pnpm run generate

As a dependency to generate your own documentation

pnpm install -D @mousetool/tfm-types
# or
yarn add -D @mousetool/tfm-types
# or
npm install -D @mousetool/tfm-types

Content

This repository includes a generator script, and exports a few supporting utility libraries. It is also home to the below packages:

Package Description Remarks
luahelpparser Parser for LuaHelp, an API documentation for the Lua tree. Produces an abstract syntax tree (AST)-like object representing the LuaHelp output. Available on the NPM registry as @cassolette/luahelpparser.
lua-types Lua Language Server environment definition for Transformice. Automatically generated and kept updated by the generator.
tstl-types Provides the TypeScriptToLua environment definition for Transformice. Automatically generated and kept updated by the generator. Available on the NPM registry as tfm-tstl-types.