feat: build another copy of lualib for 5.0

YoRyan · YoRyan · commit a1abb9ee7f87 · 2022-08-18T01:09:26.000Z
diff --git a/package.json b/package.json
@@ -19,13 +19,14 @@
         "dist/**/*.lua",
         "dist/**/*.ts",
         "dist/lualib/*.json",
+        "dist/lualib-lua50/*.json",
         "language-extensions/**/*.ts"
     ],
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
         "build": "tsc && npm run build-lualib",
-        "build-lualib": "node dist/tstl.js -p src/lualib/tsconfig.json",
+        "build-lualib": "node dist/tstl.js -p src/lualib/tsconfig.json && node dist/tstl.js -p src/lualib-lua50/tsconfig.json",
         "pretest": "npm run lint && npm run check:language-extensions && npm run build-lualib",
         "test": "jest",
         "lint": "npm run lint:eslint && npm run lint:prettier",
diff --git a/src/LuaLib.ts b/src/LuaLib.ts
@@ -1,6 +1,7 @@
 import * as path from "path";
 import { EmitHost } from "./transpilation";
 import * as lua from "./LuaAST";
+import { LuaTarget } from "./CompilerOptions";
 
 export enum LuaLibFeature {
     ArrayConcat = "ArrayConcat",
@@ -113,9 +114,10 @@ export type LuaLibModulesInfo = Record<LuaLibFeature, LuaLibFeatureInfo>;
 
 export const luaLibModulesInfoFileName = "lualib_module_info.json";
 let luaLibModulesInfo: LuaLibModulesInfo | undefined;
-export function getLuaLibModulesInfo(emitHost: EmitHost): LuaLibModulesInfo {
+export function getLuaLibModulesInfo(luaTarget: LuaTarget, emitHost: EmitHost): LuaLibModulesInfo {
     if (luaLibModulesInfo === undefined) {
-        const lualibPath = path.resolve(__dirname, `../dist/lualib/${luaLibModulesInfoFileName}`);
+        const lualibDir = `../dist/${luaTarget === LuaTarget.Lua50 ? "lualib-lua50" : "lualib"}`;
+        const lualibPath = path.resolve(__dirname, `${lualibDir}/${luaLibModulesInfoFileName}`);
         const result = emitHost.readFile(lualibPath);
         if (result !== undefined) {
             luaLibModulesInfo = JSON.parse(result) as LuaLibModulesInfo;
@@ -126,8 +128,9 @@ export function getLuaLibModulesInfo(emitHost: EmitHost): LuaLibModulesInfo {
     return luaLibModulesInfo;
 }
 
-export function readLuaLibFeature(feature: LuaLibFeature, emitHost: EmitHost): string {
-    const featurePath = path.resolve(__dirname, `../dist/lualib/${feature}.lua`);
+export function readLuaLibFeature(feature: LuaLibFeature, luaTarget: LuaTarget, emitHost: EmitHost): string {
+    const lualibDir = `../dist/${luaTarget === LuaTarget.Lua50 ? "lualib-lua50" : "lualib"}`;
+    const featurePath = path.resolve(__dirname, `${lualibDir}/${feature}.lua`);
     const luaLibFeature = emitHost.readFile(featurePath);
     if (luaLibFeature === undefined) {
         throw new Error(`Could not load lualib feature from '${featurePath}'`);
@@ -137,8 +140,9 @@ export function readLuaLibFeature(feature: LuaLibFeature, emitHost: EmitHost): s
 
 export function resolveRecursiveLualibFeatures(
     features: Iterable<LuaLibFeature>,
+    luaTarget: LuaTarget,
     emitHost: EmitHost,
-    luaLibModulesInfo: LuaLibModulesInfo = getLuaLibModulesInfo(emitHost)
+    luaLibModulesInfo: LuaLibModulesInfo = getLuaLibModulesInfo(luaTarget, emitHost)
 ): LuaLibFeature[] {
     const loadedFeatures = new Set<LuaLibFeature>();
     const result: LuaLibFeature[] = [];
@@ -162,19 +166,27 @@ export function resolveRecursiveLualibFeatures(
     return result;
 }
 
-export function loadInlineLualibFeatures(features: Iterable<LuaLibFeature>, emitHost: EmitHost): string {
+export function loadInlineLualibFeatures(
+    features: Iterable<LuaLibFeature>,
+    luaTarget: LuaTarget,
+    emitHost: EmitHost
+): string {
     let result = "";
 
-    for (const feature of resolveRecursiveLualibFeatures(features, emitHost)) {
-        const luaLibFeature = readLuaLibFeature(feature, emitHost);
+    for (const feature of resolveRecursiveLualibFeatures(features, luaTarget, emitHost)) {
+        const luaLibFeature = readLuaLibFeature(feature, luaTarget, emitHost);
         result += luaLibFeature + "\n";
     }
 
     return result;
 }
 
-export function loadImportedLualibFeatures(features: Iterable<LuaLibFeature>, emitHost: EmitHost): lua.Statement[] {
-    const luaLibModuleInfo = getLuaLibModulesInfo(emitHost);
+export function loadImportedLualibFeatures(
+    features: Iterable<LuaLibFeature>,
+    luaTarget: LuaTarget,
+    emitHost: EmitHost
+): lua.Statement[] {
+    const luaLibModuleInfo = getLuaLibModulesInfo(luaTarget, emitHost);
 
     const imports = Array.from(features).flatMap(feature => luaLibModuleInfo[feature].exports);
 
@@ -201,9 +213,10 @@ export function loadImportedLualibFeatures(features: Iterable<LuaLibFeature>, em
 }
 
 let luaLibBundleContent: string;
-export function getLuaLibBundle(emitHost: EmitHost): string {
+export function getLuaLibBundle(luaTarget: LuaTarget, emitHost: EmitHost): string {
     if (luaLibBundleContent === undefined) {
-        const lualibPath = path.resolve(__dirname, "../dist/lualib/lualib_bundle.lua");
+        const lualibDir = `../dist/${luaTarget === LuaTarget.Lua50 ? "lualib-lua50" : "lualib"}`;
+        const lualibPath = path.resolve(__dirname, `${lualibDir}/lualib_bundle.lua`);
         const result = emitHost.readFile(lualibPath);
         if (result !== undefined) {
             luaLibBundleContent = result;
diff --git a/src/LuaPrinter.ts b/src/LuaPrinter.ts
@@ -1,7 +1,7 @@
 import * as path from "path";
 import { Mapping, SourceMapGenerator, SourceNode } from "source-map";
 import * as ts from "typescript";
-import { CompilerOptions, isBundleEnabled, LuaLibImportKind } from "./CompilerOptions";
+import { CompilerOptions, isBundleEnabled, LuaLibImportKind, LuaTarget } from "./CompilerOptions";
 import * as lua from "./LuaAST";
 import { loadInlineLualibFeatures, LuaLibFeature, loadImportedLualibFeatures } from "./LuaLib";
 import { isValidLuaIdentifier, shouldAllowUnicode } from "./transformation/utils/safe-names";
@@ -233,14 +233,15 @@ export class LuaPrinter {
             sourceChunks.push(tstlHeader);
         }
 
+        const luaTarget = this.options.luaTarget ?? LuaTarget.Lua54;
         const luaLibImport = this.options.luaLibImport ?? LuaLibImportKind.Require;
         if (luaLibImport === LuaLibImportKind.Require && file.luaLibFeatures.size > 0) {
             // Import lualib features
-            sourceChunks = this.printStatementArray(loadImportedLualibFeatures(file.luaLibFeatures, this.emitHost));
+            sourceChunks = this.printStatementArray(loadImportedLualibFeatures(file.luaLibFeatures, luaTarget, this.emitHost));
         } else if (luaLibImport === LuaLibImportKind.Inline && file.luaLibFeatures.size > 0) {
             // Inline lualib features
             sourceChunks.push("-- Lua Library inline imports\n");
-            sourceChunks.push(loadInlineLualibFeatures(file.luaLibFeatures, this.emitHost));
+            sourceChunks.push(loadInlineLualibFeatures(file.luaLibFeatures, luaTarget, this.emitHost));
             sourceChunks.push("-- End of Lua Library inline imports\n");
         }
 
diff --git a/src/lualib-build/plugin.ts b/src/lualib-build/plugin.ts
@@ -47,7 +47,8 @@ class LuaLibPlugin implements tstl.Plugin {
 
         // Figure out the order required in the bundle by recursively resolving all dependency features
         const allFeatures = Object.values(LuaLibFeature) as LuaLibFeature[];
-        const orderedFeatures = resolveRecursiveLualibFeatures(allFeatures, emitHost, luaLibModuleInfo);
+        const luaTarget = options.luaTarget ?? tstl.LuaTarget.Lua54;
+        const orderedFeatures = resolveRecursiveLualibFeatures(allFeatures, luaTarget, emitHost, luaLibModuleInfo);
 
         // Concatenate lualib files into bundle with exports table and add lualib_bundle.lua to results
         let lualibBundle = orderedFeatures.map(f => exportedLualibFeatures.get(LuaLibFeature[f])).join("\n");
diff --git a/src/lualib-lua50/tsconfig.json b/src/lualib-lua50/tsconfig.json
@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "outDir": "../../dist/lualib-lua50",
+        "target": "esnext",
+        "lib": ["esnext"],
+        // Counterintuitively, we do not build with the 5.0 types as they are incompatible with
+        // branches written for the universal target. For now, the 5.4 types work for both targets.
+        "types": ["lua-types/5.4"],
+        "skipLibCheck": true,
+
+        "noUnusedLocals": true,
+        "noUnusedParameters": true
+    },
+    "tstl": {
+        "luaLibImport": "none",
+        "noHeader": true,
+        "luaTarget": "5.0",
+        "luaPlugins": [{ "name": "../../dist/lualib-build/plugin.js" }]
+    },
+    "include": ["../lualib", "../../language-extensions/index.d.ts"]
+}
diff --git a/src/transpilation/transpiler.ts b/src/transpilation/transpiler.ts
@@ -1,6 +1,6 @@
 import * as path from "path";
 import * as ts from "typescript";
-import { CompilerOptions, isBundleEnabled } from "../CompilerOptions";
+import { CompilerOptions, isBundleEnabled, LuaTarget } from "../CompilerOptions";
 import { getLuaLibBundle } from "../LuaLib";
 import { normalizeSlashes, trimExtension } from "../utils";
 import { getBundleResult } from "./bundle";
@@ -126,7 +126,8 @@ export class Transpiler {
 
             // Add lualib bundle to source dir 'virtually', will be moved to correct output dir in emitPlan
             const fileName = normalizeSlashes(path.resolve(getSourceDir(program), "lualib_bundle.lua"));
-            resolutionResult.resolvedFiles.unshift({ fileName, code: getLuaLibBundle(this.emitHost) });
+            const luaTarget = options.luaTarget ?? LuaTarget.Lua54;
+            resolutionResult.resolvedFiles.unshift({ fileName, code: getLuaLibBundle(luaTarget, this.emitHost) });
         }
 
         let emitPlan: EmitFile[];
