0.1.3 • Published 29 days ago

generator-luau v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
29 days ago

checks version GitHub top language license npm

generator-luau

A Yeoman generator for Luau projects.

This generator will setup a Luau project in no time. It will add all the necessary files to:

  • publish the project on npm
  • format your code with stylua
  • run code analysis with Selene and luau-lsp
  • create Github actions:
    • to run tests
    • publish the package(s)
    • to create a new release and attach artifacts
  • Run unit tests using Jest
  • Bundle your project into a single Lua file using darklua
  • Build your project into a Roblox model file using rojo (and darklua to convert the requires!)
  • add a license file (MIT, Apache, MPL and more)
  • add other tools like lune, mantle or tarmac to the foreman.toml configuration file

Installation

First, install Yeoman and generator-luau using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-luau

Then generate your new project:

yo luau package-name

License

This project is available under the MIT license. See LICENSE.txt for details.