Make lualib compilation a separate, internal option

GlassBricks · GlassBricks · commit aceb355d63e3 · 2022-02-07T17:18:23.000-08:00
diff --git a/src/CompilerOptions.ts b/src/CompilerOptions.ts
@@ -34,6 +34,7 @@ export type CompilerOptions = OmitIndexSignature<ts.CompilerOptions> & {
     plugins?: Array<ts.PluginImport | TransformerImport>;
     sourceMapTraceback?: boolean;
     tstlVerbose?: boolean;
+    luaLibCompilation?: boolean;
     [option: string]: any;
 };
 
@@ -56,7 +57,6 @@ export enum LuaTarget {
 export enum BuildMode {
     Default = "default",
     Library = "library",
-    LuaLib = "lualib",
 }
 
 export const isBundleEnabled = (options: CompilerOptions) =>
diff --git a/src/cli/information.ts b/src/cli/information.ts
@@ -19,6 +19,7 @@ export function getHelpString(): string {
 
     result += "Options:\n";
     for (const option of optionDeclarations) {
+        if (option.internal) continue;
         const aliasStrings = (option.aliases ?? []).map(a => "-" + a);
         const optionString = [...aliasStrings, "--" + option.name].join("|");
 
diff --git a/src/cli/parse.ts b/src/cli/parse.ts
@@ -10,6 +10,7 @@ interface CommandLineOptionBase {
     name: string;
     aliases?: string[];
     description: string;
+    internal?: boolean;
 }
 
 interface CommandLineOptionOfEnum extends CommandLineOptionBase {
@@ -83,6 +84,12 @@ export const optionDeclarations: CommandLineOption[] = [
         description: "An array of paths that tstl should not resolve and keep as-is.",
         type: "array",
     },
+    {
+        name: "luaLibCompilation",
+        description: "Internal. Specifies if this project is lualib source.",
+        type: "boolean",
+        internal: true,
+    },
 ];
 
 export function updateParsedConfigFile(parsedConfigFile: ts.ParsedCommandLine): ParsedCommandLine {
@@ -103,7 +110,7 @@ export function updateParsedConfigFile(parsedConfigFile: ts.ParsedCommandLine):
 
         for (const [name, rawValue] of Object.entries(parsedConfigFile.raw.tstl)) {
             const option = optionDeclarations.find(option => option.name === name);
-            if (!option) {
+            if (!option && option !== "lualibCompilation") {
                 parsedConfigFile.errors.push(cliDiagnostics.unknownCompilerOption(name));
                 continue;
             }
diff --git a/src/lualib/tsconfig.json b/src/lualib/tsconfig.json
@@ -5,13 +5,12 @@
         "lib": ["esnext"],
         "types": ["lua-types/5.4"],
         "skipLibCheck": true,
-
         "noUnusedLocals": true,
         "noUnusedParameters": true
     },
     "tstl": {
-        "buildMode": "lualib",
         "luaLibImport": "none",
-        "noHeader": true
+        "noHeader": true,
+        "luaLibCompilation": true
     }
 }
diff --git a/src/transformation/utils/lua-ast.ts b/src/transformation/utils/lua-ast.ts
@@ -1,5 +1,5 @@
 import * as ts from "typescript";
-import { LuaTarget, BuildMode } from "../../CompilerOptions";
+import { LuaTarget } from "../../CompilerOptions";
 import * as lua from "../../LuaAST";
 import { assert, castArray } from "../../utils";
 import { TransformationContext } from "../context";
@@ -146,7 +146,7 @@ export function createLocalOrExportedOrGlobalDeclaration(
         if (!rhs) {
             return [];
         } else {
-            if (context.options.buildMode === BuildMode.LuaLib) {
+            if (context.options.luaLibCompilation) {
                 // assignment to a local variable defined elsewhere
                 // see sourceFile.ts
                 assignment = lua.createAssignmentStatement(lhs, rhs, tsOriginal);
diff --git a/src/transformation/visitors/class/setup.ts b/src/transformation/visitors/class/setup.ts
@@ -11,7 +11,6 @@ import {
 import { createExportsIdentifier, createLocalOrExportedOrGlobalDeclaration } from "../../utils/lua-ast";
 import { LuaLibFeature, transformLuaLibFunction } from "../../utils/lualib";
 import { getExtendedNode, getExtendsClause } from "./utils";
-import { BuildMode } from "../../../CompilerOptions";
 
 export function createClassSetup(
     context: TransformationContext,
@@ -41,7 +40,7 @@ export function createClassSetup(
         result.push(lua.createVariableDeclarationStatement(localClassName, defaultExportLeftHandSide));
     } else {
         const exportScope = getIdentifierExportScope(context, className);
-        if (exportScope && context.options.buildMode !== BuildMode.LuaLib) {
+        if (exportScope && !context.options.luaLibCompilation) {
             // local localClassName = ____exports.className
             result.push(
                 lua.createVariableDeclarationStatement(
diff --git a/src/transformation/visitors/identifier.ts b/src/transformation/visitors/identifier.ts
@@ -23,7 +23,6 @@ import { isTableExtensionIdentifier } from "./language-extensions/table";
 import { isVarargConstantNode } from "./language-extensions/vararg";
 import { isOptionalContinuation } from "./optional-chaining";
 import { isErrorClass } from "../builtins/error";
-import { BuildMode } from "../../CompilerOptions";
 
 export function transformIdentifier(context: TransformationContext, identifier: ts.Identifier): lua.Identifier {
     if (isOptionalContinuation(identifier)) {
@@ -74,7 +73,7 @@ export function transformIdentifier(context: TransformationContext, identifier:
 
 export const transformIdentifierExpression: FunctionVisitor<ts.Identifier> = (node, context) => {
     const symbol = context.checker.getSymbolAtLocation(node);
-    if (symbol && context.options.buildMode !== BuildMode.LuaLib) {
+    if (symbol && !context.options.luaLibCompilation) {
         const exportScope = getSymbolExportScope(context, symbol);
         if (exportScope) {
             const name = symbol.name;
diff --git a/src/transformation/visitors/modules/import.ts b/src/transformation/visitors/modules/import.ts
@@ -12,7 +12,6 @@ import { transformIdentifier } from "../identifier";
 import { transformPropertyName } from "../literal";
 import { LuaLibFeature } from "../../../LuaLib";
 import { importLuaLibFeature } from "../../utils/lualib";
-import { BuildMode } from "../../../CompilerOptions";
 
 function isNoResolutionPath(context: TransformationContext, moduleSpecifier: ts.Expression): boolean {
     const moduleOwnerSymbol = context.checker.getSymbolAtLocation(moduleSpecifier);
@@ -62,7 +61,7 @@ function transformImportSpecifier(
 }
 
 export const transformImportDeclaration: FunctionVisitor<ts.ImportDeclaration> = (statement, context) => {
-    if (context.options.buildMode === BuildMode.LuaLib) {
+    if (context.options.luaLibCompilation) {
         // in lualib project, imports declare dependencies
         // Assume that relevant imports are in the form `import "./module"`
 
diff --git a/src/transformation/visitors/sourceFile.ts b/src/transformation/visitors/sourceFile.ts
@@ -10,7 +10,6 @@ import { performHoisting, popScope, pushScope, ScopeType } from "../utils/scope"
 import { hasExportEquals } from "../utils/typescript";
 import { getSymbolIdOfSymbol, getSymbolInfo } from "../utils/symbols";
 import { getExportedSymbolsFromScope } from "../utils/export";
-import { BuildMode } from "../../CompilerOptions";
 
 export const transformSourceFileNode: FunctionVisitor<ts.SourceFile> = (node, context) => {
     let statements: lua.Statement[] = [];
@@ -36,7 +35,7 @@ export const transformSourceFileNode: FunctionVisitor<ts.SourceFile> = (node, co
         statements = performHoisting(context, context.transformStatements(node.statements));
         popScope(context);
 
-        if (context.options.buildMode === BuildMode.LuaLib) {
+        if (context.options.luaLibCompilation) {
             // Exports are currently assignment statements
             const exportedSymbolIds = getExportedSymbolsFromScope(context, context.sourceFile)
                 .map(symbol => getSymbolIdOfSymbol(context, symbol))
diff --git a/src/transpilation/transpile.ts b/src/transpilation/transpile.ts
@@ -1,6 +1,6 @@
 import * as path from "path";
 import * as ts from "typescript";
-import { CompilerOptions, validateOptions, BuildMode } from "../CompilerOptions";
+import { CompilerOptions, validateOptions } from "../CompilerOptions";
 import { createPrinter } from "../LuaPrinter";
 import { createVisitorMap, transformSourceFile } from "../transformation";
 import { isNonNull } from "../utils";
@@ -124,7 +124,7 @@ export function getProgramTranspileResult(
         program.getSourceFiles().filter(isEmittableJsonFile).forEach(processSourceFile);
     }
 
-    if (options.buildMode === BuildMode.LuaLib) {
+    if (options.luaLibCompilation) {
         // add lualib dependencies json file
         transpiledFiles.push(...generateExtraLualibFiles(emitHost, program, transpiledFiles));
     }
