Added file header and lualib loading to printer (#327)

Perryvw · web-flow · commit 34a87a175746 · 2019-01-09T23:07:44.000+01:00
diff --git a/src/LuaPrinter.ts b/src/LuaPrinter.ts
@@ -1,6 +1,9 @@
 import * as tstl from "./LuaAST";
 
-import {TSHelper as tsHelper} from "./TSHelper";
+import { TSHelper as tsHelper } from "./TSHelper";
+import { LuaLibFeature, LuaLib } from "./LuaLib";
+import { CompilerOptions } from "./CompilerOptions";
+import { LuaLibImportKind } from "./CompilerOptions";
 
 export class LuaPrinter {
     /* tslint:disable:object-literal-sort-keys */
@@ -33,14 +36,37 @@ export class LuaPrinter {
     };
     /* tslint:enable:object-literal-sort-keys */
 
+    private options: CompilerOptions;
     private currentIndent: string;
 
-    public constructor() {
+    public constructor(options: CompilerOptions) {
+        this.options = options;
         this.currentIndent = "";
     }
 
-    public print(block: tstl.Block): string {
-        return this.printBlock(block);
+    public print(block: tstl.Block, luaLibFeatures?: Set<LuaLibFeature>): string {
+        let header = "";
+
+        if (this.options.addHeader === undefined || this.options.addHeader === true) {
+            header += `--[[ Generated with https://github.com/Perryvw/TypescriptToLua ]]\n`;
+        }
+
+        if (luaLibFeatures) {
+            // Require lualib bundle
+            if ((this.options.luaLibImport === LuaLibImportKind.Require && luaLibFeatures.size > 0)
+                || this.options.luaLibImport === LuaLibImportKind.Always)
+            {
+                header += `require("lualib_bundle");\n`;
+            }    
+            // Inline lualib features
+            else if (this.options.luaLibImport === LuaLibImportKind.Inline && luaLibFeatures.size > 0)
+            {
+                header += "-- Lua Library inline imports\n";
+                header += LuaLib.loadFeatures(luaLibFeatures);
+            }
+        }
+
+        return header + this.printBlock(block);
     }
 
     private pushIndent(): void {
diff --git a/src/LuaTransformer.ts b/src/LuaTransformer.ts
@@ -72,32 +72,15 @@ export class LuaTransformer {
     }
 
     // TODO make all other methods private???
-    public transformSourceFile(node: ts.SourceFile): tstl.Block {
+    public transformSourceFile(node: ts.SourceFile): [tstl.Block, Set<LuaLibFeature>] {
         this.setupState();
 
         this.currentSourceFile = node;
         this.isModule = tsHelper.isFileModule(node);
 
         const statements = this.transformStatements(node.statements);
 
-        const luaLibStatements = [];
-        if ((this.options.luaLibImport === LuaLibImportKind.Require && this.luaLibFeatureSet.size > 0)
-            || this.options.luaLibImport === LuaLibImportKind.Always) {
-            // require helper functions
-            const requireStatement = tstl.createExpressionStatement((tstl.createCallExpression(
-                tstl.createIdentifier("require"),
-                [tstl.createStringLiteral("lualib_bundle")]
-            )));
-            luaLibStatements.push(requireStatement);
-        }
-
-        // Inline lualib features
-        if (this.options.luaLibImport === LuaLibImportKind.Inline && this.luaLibFeatureSet.size > 0) {
-            //result += "\n" + "-- Lua Library Imports\n";
-            luaLibStatements.push(tstl.createIdentifier(LuaLib.loadFeatures(this.luaLibFeatureSet)));
-        }
-
-        return tstl.createBlock(luaLibStatements.concat(statements), undefined, node);
+        return [tstl.createBlock(statements, undefined, node), this.luaLibFeatureSet];
     }
 
     public transformStatement(node: ts.Statement): StatementVisitResult {
diff --git a/src/LuaTranspiler.ts b/src/LuaTranspiler.ts
@@ -20,7 +20,7 @@ export class LuaTranspiler {
         this.program = program;
         this.options = this.program.getCompilerOptions() as CompilerOptions;
         this.luaTransformer = createTransformer(this.program);
-        this.luaPrinter = new LuaPrinter();
+        this.luaPrinter = new LuaPrinter(this.options);
     }
 
     private reportErrors(): number {
@@ -102,9 +102,9 @@ export class LuaTranspiler {
 
     public transpileSourceFile(sourceFile: ts.SourceFile): string {
         // Transform AST
-        const luaAST = this.luaTransformer.transformSourceFile(sourceFile);
+        const [luaAST, lualibFeatureSet] = this.luaTransformer.transformSourceFile(sourceFile);
         // Print AST
-        return this.luaPrinter.print(luaAST);
+        return this.luaPrinter.print(luaAST, lualibFeatureSet);
     }
 
     public reportDiagnostic(diagnostic: ts.Diagnostic): void {
diff --git a/test/src/util.ts b/test/src/util.ts
@@ -3,16 +3,21 @@ import * as ts from "typescript";
 
 import { Expect } from "alsatian";
 
-import { transpileString } from "../../src/Compiler";
-import { LuaTarget } from "../../src/CompilerOptions";
+import { transpileString as compilerTranspileString } from "../../src/Compiler";
+import { CompilerOptions, LuaTarget, LuaLibImportKind } from "../../src/CompilerOptions";
 import { createTransformer } from "../../src/TransformerFactory";
 
 import {lauxlib, lua, lualib, to_jsstring, to_luastring } from "fengari";
 
 import * as fs from "fs";
 import { LuaTransformer } from "../../src/LuaTransformer";
 
-export { transpileString };
+export function transpileString(str: string, options?: CompilerOptions): string {
+    if (options && options.addHeader === undefined) {
+        options.addHeader = false;
+    }
+    return compilerTranspileString(str, options);
+}
 
 export function executeLua(luaStr: string, withLib = true): any {
     if (withLib) {
