Skip to content

Allow configuring output file extension in config #1229

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 1 commit into from
Mar 13, 2022
Merged

Allow configuring output file extension in config #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/CompilerOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export interface LuaPluginImport {

export type CompilerOptions = OmitIndexSignature<ts.CompilerOptions> & {
buildMode?: BuildMode;
extension?: string;
luaBundle?: string;
luaBundleEntry?: string;
luaTarget?: LuaTarget;
Expand Down
5 changes: 5 additions & 0 deletions src/cli/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ export const optionDeclarations: CommandLineOption[] = [
type: "enum",
choices: Object.values(BuildMode),
},
{
name: "extension",
description: 'File extension for the resulting Lua files. Defaults to ".lua"',
type: "string",
},
{
name: "luaBundle",
description: "The name of the lua file to bundle output lua to. Requires luaBundleEntry.",
Expand Down
7 changes: 5 additions & 2 deletions src/transpilation/transpiler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,11 @@ export function getEmitPathRelativeToOutDir(fileName: string, program: ts.Progra
emitPathSplits[0] = "lua_modules";
}

// Make extension lua
emitPathSplits[emitPathSplits.length - 1] = trimExtension(emitPathSplits[emitPathSplits.length - 1]) + ".lua";
// Set extension
const extension = ((program.getCompilerOptions() as CompilerOptions).extension ?? "lua").trim();
const trimmedExtension = extension.startsWith(".") ? extension.substring(1) : extension;
emitPathSplits[emitPathSplits.length - 1] =
trimExtension(emitPathSplits[emitPathSplits.length - 1]) + "." + trimmedExtension;

return path.join(...emitPathSplits);
}
Expand Down
3 changes: 3 additions & 0 deletions test/cli/parse.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,9 @@ describe("command line", () => {

["luaBundle", "foo", { luaBundle: "foo" }],
["luaBundleEntry", "bar", { luaBundleEntry: "bar" }],

["extension", ".lua", { extension: ".lua" }],
["extension", "scar", { extension: "scar" }],
])("--%s %s", (optionName, value, expected) => {
const result = tstl.parseCommandLine([`--${optionName}`, value]);

Expand Down
32 changes: 32 additions & 0 deletions test/transpile/paths.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,38 @@ describe("getEmitPath", () => {
expect(fileNames).toHaveLength(1);
expect(fileNames).toContain(path.join(cwd, "out1", "out2", "bundle.lua"));
});

test.each([".scar", "scar"])("uses config extension (%p)", extension => {
const { transpiledFiles } = util.testModule``
.setMainFileName("main.ts")
.addExtraFile("dir/extra.ts", "")
.setOptions({ extension })
.expectToHaveNoDiagnostics()
.getLuaResult();

const fileNames = transpiledFiles.map(f => f.outPath);
expect(fileNames).toContain("main.scar");
expect(fileNames).toContain(path.join("dir", "extra.scar"));
});

test("bundle with different extension", () => {
const { transpiledFiles } = util.testModule``
.setMainFileName("src/main.ts")
.addExtraFile("src/extra.ts", "")
.setOptions({
configFilePath,
rootDir: "src",
outDir: "out1",
luaBundle: "out2/bundle.scar",
luaBundleEntry: "src/main.ts",
})
.expectToHaveNoDiagnostics()
.getLuaResult();

const fileNames = transpiledFiles.map(f => f.outPath);
expect(fileNames).toHaveLength(1);
expect(fileNames).toContain(path.join(cwd, "out1", "out2", "bundle.scar"));
});
});

function normalize(path: string) {
Expand Down