Skip to content

Fix destructuring assignment of multiReturn (closes #995) #997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Perryvw merged 3 commits into from
Mar 6, 2021
Merged

Fix destructuring assignment of multiReturn (closes #995) #997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb10d86
Fix destructuring assignment of multiReturn (closes #995)
yancouto Mar 4, 2021
c87257f
Rename test and add test for null return
yancouto Mar 6, 2021
074fd15
Splitting tests
yancouto Mar 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/transformation/visitors/variable-declaration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { isTupleReturnCall } from "../utils/annotations";
import { validateAssignment } from "../utils/assignment-validation";
import { unsupportedVarDeclaration } from "../utils/diagnostics";
import { addExportToIdentifier } from "../utils/export";
import { createLocalOrExportedOrGlobalDeclaration, createUnpackCall } from "../utils/lua-ast";
import { createLocalOrExportedOrGlobalDeclaration, createUnpackCall, wrapInTable } from "../utils/lua-ast";
import { LuaLibFeature, transformLuaLibFunction } from "../utils/lualib";
import { transformIdentifier } from "./identifier";
import { isMultiReturnCall } from "./language-extensions/multi";
Expand Down Expand Up @@ -158,9 +158,11 @@ export function transformBindingVariableDeclaration(
// Contain the expression in a temporary variable
table = lua.createAnonymousIdentifier();
if (initializer) {
statements.push(
lua.createVariableDeclarationStatement(table, context.transformExpression(initializer))
);
let expression = context.transformExpression(initializer);
if (isTupleReturnCall(context, initializer) || isMultiReturnCall(context, initializer)) {
expression = wrapInTable(expression);
}
statements.push(lua.createVariableDeclarationStatement(table, expression));
}
}
statements.push(...transformBindingPattern(context, bindingPattern, table));
Expand Down
4 changes: 3 additions & 1 deletion test/unit/language-extensions/__snapshots__/multi.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ exports[`invalid $multi call (const [a = 0] = $multi()): diagnostics 1`] = `"mai

exports[`invalid $multi call (const {} = $multi();): code 1`] = `
"local ____ = {
____(_G)
{
____(_G)
}
}"
`;

Expand Down
27 changes: 27 additions & 0 deletions test/unit/language-extensions/multi.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,33 @@ test("multi example use case", () => {
.expectToEqual({ a: "foo", b: 5 });
});

// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/995
test("Destructuring assignment of LuaMultiReturn", () => {
util.testModule`
function multiReturn(): LuaMultiReturn<[number, number, number]> {
return $multi(1, 2, 3);
Comment thread
yancouto marked this conversation as resolved.
}

const [a, ...b] = multiReturn();
export {a, b};
`
.setOptions(multiProjectOptions)
.expectToEqual({ a: 1, b: [2, 3] });
});

test("Destructuring assignment of LuaMultiReturn returning nil", () => {
util.testModule`

@Perryvw Perryvw Mar 6, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests should only test one thing, could you split this second testModule into a second test("Destructuring assignment of LuaMultiReturn returning nil", () => {

function multiReturn(): LuaMultiReturn<[number, number, number]> {
return;
}

const [a, ...b] = multiReturn();
export {a, b};
`
.setOptions(multiProjectOptions)
.expectToEqual({ a: undefined, b: [] });
});

test.each<[string, any]>([
["$multi()", undefined],
["$multi(true)", true],
Expand Down