Skip to content

Fix namespace and module resulting in invalid Lua when modified with TS transformer plugin #1014

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 4 commits into from
May 3, 2021
Merged

Fix namespace and module resulting in invalid Lua when modified with TS transformer plugin #1014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
538e675
Failing test
Perryvw Apr 26, 2021
4bba5a7
Fixed bug #1013
Perryvw Apr 26, 2021
1d1a8c7
Fix prettier
Perryvw Apr 26, 2021
907b97c
Switched transformer plugin to TS instead of JS
Perryvw May 3, 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
2 changes: 1 addition & 1 deletion src/transformation/visitors/namespace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export const transformModuleDeclaration: FunctionVisitor<ts.ModuleDeclaration> =
const isFirstDeclaration =
symbol === undefined ||
(!symbol.declarations.some(d => ts.isClassLike(d) || ts.isFunctionDeclaration(d)) &&
node === symbol.declarations.find(ts.isModuleDeclaration));
ts.getOriginalNode(node) === symbol.declarations.find(ts.isModuleDeclaration));

if (isNonModuleMergeable) {
// 'local NS = NS or {}' or 'exportTable.NS = exportTable.NS or {}'
Expand Down
20 changes: 20 additions & 0 deletions test/transpile/plugins/plugins.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,23 @@ test("statement comments", () => {
.setOptions({ luaPlugins: [{ name: path.join(__dirname, "add-comments.ts") }] })
.expectLuaToMatchSnapshot();
});

// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1013
test.each(["namespace", "module"])("%s with TS transformer plugin", moduleOrNamespace => {
util.testModule`
import { ns } from "module";
export const result = ns.returnsBool();
`
.addExtraFile(
"module.ts",
`
export ${moduleOrNamespace} ns {
export function returnsBool() {
return false;
}
}
`
)
.setOptions({ plugins: [{ transform: path.join(__dirname, "transformer-plugin.ts") }] })
.expectNoExecutionError();
});
15 changes: 15 additions & 0 deletions test/transpile/plugins/transformer-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* This is a TS tranformer plugin that replaces any return statement to 'return true'.
*/
import * as ts from "typescript";

const replaceNode = (node: ts.Node) => {
if (ts.isReturnStatement(node)) {
return ts.factory.createReturnStatement(ts.factory.createTrue());
}
};
const createTransformer = () => (context: ts.TransformationContext) => {
const visit = (node: ts.Node): ts.Node => replaceNode(node) ?? ts.visitEachChild(node, visit, context);
return (file: ts.SourceFile) => ts.visitNode(file, visit);
};
exports.default = createTransformer;