Skip to content

unicornpkg/tstl-typings-libunicornpkg

Repository files navigation

TypeScript to Lua transpiler types for libunicornpkg

Provides hooks into TypeScript's typing system for use with the TypeScript to Lua transpiler.

Usage

Add this as a submodule with the path types/unicorn:

git submodule add https://github.com/unicornpkg/tstl-typings-libunicornpkg types/unicorn
git submodule update --init --recurse

Then, import the library as usual.

Development

Contributions are always welcome! This section demonstrates how to contribute to this project.

  1. Install just. Just is a tool that will make your life significantly easier if you've never developed on TypeScript before.
  2. Fork the repository and clone it locally.
  3. Execute just install. This installs developer dependencies.
  4. Occasionally execute just lint. This uses eslint to check for errors.
  5. Commit your changes, push them up to GitHub, and open a PR.