Lualib as module by GlassBricks · Pull Request #1213 · TypeScriptToLua/TypeScriptToLua

GlassBricks · 2022-02-03T00:49:35Z

This implements lualib as modules (lualib source files and lualib_bundle are now modules), removes use of global variables.

Creates a new "internal" compiler option lualibCompilation for compiling lualib.
In this mode, lualib source files are modules, with the following restrictions:
- No export default or export =
- ltems can only be imported from other lualib source files
  As this mode is meant to be "internal", these restrictions are currently not enforced (no checking or diagnostics).
LuaLib feature dependencies are now automatically determined (instead of manually defined), and written to a file called lualib_modules_info.json.
Fixes a number of issues with lualib features not being loaded.

Additional details

Each lualib module compilations's output is such that it declares local variables that correspond to the module's exports, potentially wrapping module statements in a do block if nessecary to avoid leaking variables out of scope. See sourceFile.ts for more info.
This allows lualib modules to have non-exported members, i.e. be written like a normal module.
The result can be directly inlined for lualibImport: "inline", or for assembling lualib_bundle.

Possible future changes

Change polyfilled global objects to actual objects, so that const func = Object.assign or const foo = console works.
Change lualib/builtin handling to be more declarative; Allow plugins to supply lualib functions or to modify lualib/builtin behavior.
Assemble a "custom" lualib_bundle for projects, which contains only used features.
Make it so that multiple tstl compiled projects (bundles) running in the same environment use the same lualib.

EDIT: reflect latest commits.
Thanks to @Zamiell for testing these changes in an existing project.

…e changes

lolleko · 2022-02-06T16:24:14Z

src/lualib/ArrayConcat.ts

@@ -1,4 +1,4 @@
-function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {
+export function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {


Is it possible to make Array a class like set/map?
To give people the ability to overwrite array built ins.

EDIT: same applies to Object

that might cause problems when interacting with existing lua code. Could be done in separate PR, see #262

i think it would be annoying for end users to have to mix Array and LuaArray, for example my game API returns lots of LuaArray

Out of scope for this PR, this should be considered in a separate PR.

Zamiell · 2022-02-08T07:26:10Z

I tried out this PR today with my mod, and everything seems to be working great so far.
There are no more global variables, as promised!
I will update this if I find any issues in the coming days.

src/LuaPrinter.ts

src/cli/parse.ts

src/CompilerOptions.ts

Perryvw · 2022-02-27T16:29:01Z

src/lualib/ArrayConcat.ts

@@ -1,4 +1,4 @@
-function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {
+export function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {


Out of scope for this PR, this should be considered in a separate PR.

Perryvw · 2022-02-27T17:43:45Z

src/transformation/visitors/class/index.ts

    const superInfo = getOrUpdate(classSuperInfos, context, () => []);
    superInfo.push({ className, extendedTypeNode });

-    if (extendedType) {


Are you sure this can be removed? Why does this not break promises construction?

The check for lualib type has been moved to transformIdentifier. For a class extends, transformIdentifier is eventually called in createClassSetup.

Perryvw · 2022-02-27T17:54:05Z

src/transpilation/transpiler.ts

-    const relativeOutputPath = getEmitPathRelativeToOutDir(file, program);
+export function getEmitPath(file: string | ProcessedFile, program: ts.Program): string {
    const outDir = getEmitOutDir(program);
+    if (typeof file !== "string" && file.isRawFile) {


Perryvw · 2022-02-27T17:54:17Z

src/transpilation/utils.ts

    code: string;
    sourceMap?: string;
    sourceFiles?: ts.SourceFile[];
+    isRawFile?: boolean;


why is this even required?

This is for the json file. Before getEmitPath expects absolute paths and turns filenames into lua, and the json file name is not absolute. This allows treating the json file differently.
If you can think of a better way to handle this let me know.

Perryvw · 2022-02-27T17:55:52Z

test/transpile/module-resolution.spec.ts

            "lualibuser.lua",
            `
-                require("lualib_bundle")
+                local __TS__ArrayPush = require("lualib_bundle").__TS__ArrayPush


why is this optimized into one statement here, but not in the cases in the snapshot below?

src/lualib/tsconfig.json

GlassBricks · 2022-03-15T02:27:17Z

Closing in favor of #1224

GlassBricks added 6 commits February 2, 2022 16:14

Basic lualib as modules

558b7b4

Fix tests and update snapshots

f4f7a92

Fix lualib_bundle.lua not being updated immediately when lualib sourc…

6b9e7a8

…e changes

Add global assign test

8ce2350

Use buildMode=lualib instead of luaLibProject compiler option

2d6141f

Consistent naming for in LuaLibModulesInfo

9279d27

lolleko reviewed Feb 6, 2022

View reviewed changes

GlassBricks added 4 commits February 7, 2022 09:20

Remove now unnecessary imports from build-lualib.js

323bced

Make lualib compilation a separate, internal option

aceb355

Add lualib_modules_info.json to npm package

db0e257

Move checkForLualibType to identifier

8d5283c

GlassBricks mentioned this pull request Feb 25, 2022

Optimize lualib functions #1217

Merged

Perryvw requested changes Feb 27, 2022

View reviewed changes

PR feedback

c5e3e9e

GlassBricks requested a review from Perryvw February 27, 2022 20:08

Move lualibCompilation option out of public api

1132f16

GlassBricks force-pushed the lualib-module branch from 8e8aa39 to 1132f16 Compare February 27, 2022 20:13

GlassBricks mentioned this pull request Mar 5, 2022

Lualib modules via plugin #1224

Merged

GlassBricks closed this Mar 15, 2022

GlassBricks mentioned this pull request Mar 16, 2022

Fix using tstl CLI to build lualib #1233

Merged

GlassBricks deleted the lualib-module branch March 16, 2022 16:26

		@@ -1,4 +1,4 @@
		function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {
		export function __TS__ArrayConcat(this: void, arr1: any[], ...args: any[]): any[] {

Uh oh!

Conversation

GlassBricks commented Feb 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional details

Possible future changes

Uh oh!

lolleko Feb 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Zamiell commented Feb 8, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

GlassBricks commented Mar 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GlassBricks commented Feb 3, 2022 •

edited

Loading

lolleko Feb 6, 2022 •

edited

Loading