Skip to content

include-marcy/luau-class-generator

Repository files navigation

DOCS Production

About the Luau Class Generator

This is a utility tool designed to automatically generate the boiler plate of a specialized and professional Luau Class module. It also defines type information for the Class and defines a CreateInfo type which can be automatically generated in a configurable Types module.

Installation

Features

  • Automatically creates a type-strict module definition of a Luau class with professional syntax usage, type definitions, and a consistent naming scheme.
  • Automatically adds type information to a designated file which can instruct users of the interfaces you create about how to build the objects your library contains.
  • Automatically adds Luau Dynamic/Fast Flags to the tops of class files.
  • Adds a best practice configurable copyright notice to the top of files.
  • Adds Moonwave tags automatically.

About Luau

Luau (lowercase u, /ˈlu.aʊ/) is a fast, small, safe, gradually typed embeddable scripting language derived from Lua. Luau is open-source. To see more information about Luau, check out their GitHub.

Release Notes

This is the official release notes section for the Luau Library Class Generator VSC Extension.

v1.0.6.7.31.24

  • Comment generation restructured to support Moonwave

v1.0.5.7.29.24

  • Added command: LCG: Add File + New Class to allow creation of a class file easily. (Right click a folder)
  • Bug fixes and minor changes

v1.0.3.7.28.24

  • Added command: LCG: Add Class Method to allow generation of a method in a class file.
  • Changed extension official name to "Luau Class Generator".
  • Added Commented Descriptions Toggle setting

v1.0.0.7.28.24

  • Full release of the extension

v0.0.1.7.28.24

  • Released initial version.