@rbxtina/yaml-converter

1.0.0 • Public • Published

yaml-to-dts

Yaml format to Luau with .d.ts (for roblox-ts workflows)


Configuration files (.yml) comes very handy at the moment of building applications, in and out of ROBLOX. They are being the next candidate for replacing JSON files, and this is a great moment to start being able to write understandable and easy configuration files without having them to being strictly a .ts or .lua file!

This transformer can build both the .lua and the .d.ts file for you! Without any hesitation at all.

You can give several option feedback to the transformer, whether you want the Luau file or the source folder where to look for your configuration files, by default it's src/config.

How to use it?

npm i yaml-to-dts

And from there add it to your compilerOptions.plugins on your tsconfig.json file.

{
    "compilerOptions": {
        ...,

        "plugins": [
            {
                "transform": "yaml-to-dts"
            }
        ]
    }
}

Package Sidebar

Install

npm i @rbxtina/yaml-converter

Weekly Downloads

0

Version

1.0.0

License

ISC

Unpacked Size

24.9 kB

Total Files

23

Last publish

Collaborators

  • siriuslatte
  • rigidstudios