https://github.com/adamraichu/tstl-attribution-plugin

A transformer for Typescript-To-Lua which can be used to add attribution to output files.
https://github.com/adamraichu/tstl-attribution-plugin

attribution tstl tstl-plugin

Last synced: 6 days ago
JSON representation

A transformer for Typescript-To-Lua which can be used to add attribution to output files.

• Host: GitHub
• URL: https://github.com/adamraichu/tstl-attribution-plugin
• Owner: AdamRaichu
• License: mit
• Created: 2024-10-15T14:00:30.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T15:14:15.000Z (2 months ago)
• Last Synced: 2024-10-16T22:05:52.430Z (2 months ago)
• Topics: attribution, tstl, tstl-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@adamraichu/tstl-attribution-plugin
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# tstl-attribution-plugin

A transformer for Typescript-To-Lua which can be used to add attribution to output files.

## Usage

First, install with npm:

```bash

npm i --save-dev @adamraichu/tstl-attribution-plugin

```

Then, add the plugin to your `tsconfig.json`:

```jsonc

// tsconfig.json

{

  // [...]

  "tstl": {

    // [...]

    "luaPlugins": [

      {

        "name": "@adamraichu/tstl-attribution-plugin",

        "comment": "-- Hello world!"

      }

    ]

  }

}

```

Now, when you run `tstl`, the output file will have the comment `-- Hello world!` prepended to it.

If you forget to put the newline character (`\n`) at the end of your comment, the plugin will add it for you. Other than that, there is no validation! So double check that anything you put in there is valid lua syntax.