feat: use es6 templates for substitutions

Author: stephenlacy

deno.lock

@@ -1,37 +1,13 @@
 import { Command, EnumType, ValidationError } from '/deps.ts'
 import { config } from '/lib/config.ts'
+import { getSubstitutions, render } from '/lib/template.ts'
 import { cmd, GlobalOptions } from '/index.ts'
 import { CliOptions, RunrealConfig } from '/lib/types.ts'
 import { exec as execCmd, randomBuildkiteEmoji } from '/lib/utils.ts'
 
 export type ExecOptions = typeof exec extends Command<any, any, infer Options, any, any> ? Options
 	: never
 
-// Object containing the allowed substitutions
-const getSubstitutions = (cfg: RunrealConfig): Record<string, string | undefined> => ({
-	'engine.path': cfg.engine.path,
-	'project.path': cfg.project.path,
-	'project.name': cfg.project.name,
-	'build.id': cfg.build.id,
-	'build.path': cfg.build.path,
-	'build.branch': cfg.build.branchSafe,
-	'build.commit': cfg.build.commitShort,
-	'buildkite.buildNumber': cfg.buildkite.buildNumber,
-})
-
-// This helper function will take a command string with placeholders and a substitutions object
-// It will replace all placeholders in the command with their corresponding values
-// If the key is not found in substitutions, keep the original placeholder
-function interpolateCommand(input: string[], substitutions: Record<string, string | undefined>) {
-	// This regular expression matches all occurrences of ${placeholder}
-	const placeholderRegex = /\$\{([^}]+)\}/g
-	return input.map((arg) =>
-		arg.replace(placeholderRegex, (_, key: string) => {
-			return key in substitutions ? substitutions[key] || key : _
-		})
-	)
-}
-
 enum Mode {
 	Local = 'local',
 	Buildkite = 'buildkite',
@@ -84,8 +60,8 @@ export const exec = new Command<GlobalOptions>()
 
 		const steps: { command: string; args: string[] }[] = []
 		for await (const step of run.steps) {
-			const command = interpolateCommand([step.command], getSubstitutions(cfg))[0]
-			const args = interpolateCommand(step.args || [], getSubstitutions(cfg))
+			const command = render(step.command, getSubstitutions(cfg))[0]
+			const args = render(step.args, getSubstitutions(cfg))
 			steps.push({ command, args })
 		}
 

src/commands/workflow/exec.ts

@@ -0,0 +1,36 @@
+import { RunrealConfig } from '/lib/types.ts'
+
+export const render = (template: string, data: any) => {
+	return new Function(
+		'vars',
+		[
+			'const keys = (' + Object.keys(data).join(', ') + ') =>',
+			'`' + template + '`',
+			'return keys(...Object.values(vars))',
+		].join('\n'),
+	)(data)
+}
+
+// Object containing the allowed substitutions
+export const getSubstitutions = (cfg: any): Partial<RunrealConfig> => {
+	const buildkite: Partial<RunrealConfig['buildkite']> = {
+		buildNumber: cfg.buildkite?.buildNumber || 'buildkite.buildNumber',
+	}
+	return {
+		engine: {
+			path: cfg.engine?.path || 'engine.path',
+		},
+		project: {
+			path: cfg.project?.path || 'project.path',
+			name: cfg.project?.name || 'project.name',
+		},
+		build: {
+			id: cfg.build?.id || 'build.id',
+			path: cfg.build?.path || 'build.path',
+			branch: cfg.build?.branchSafe || 'build.branch',
+			commit: cfg.build?.commitShort || 'build.commit',
+		},
+		// @ts-ignore partial
+		buildkite,
+	}
+}

src/lib/source.ts

@@ -0,0 +1,21 @@
+import { render } from '/lib/template.ts'
+import { assertEquals } from 'std/assert/mod.ts'
+import { getSubstitutions } from '/lib/template.ts'
+
+Deno.test('template test', () => {
+	const tmpl = '{"name": "${project.name}", "engine": "${engine.path}", "project": "${project.name}"}'
+	const cfg = { project: { name: 'Deno' }, engine: { path: 'V8' } }
+
+	const result = render(tmpl, cfg)
+	assertEquals(result, '{"name": "Deno", "engine": "V8", "project": "Deno"}')
+})
+
+Deno.test('template test with substitutions', () => {
+	const tmpl = '{"name": "${project.name}", "engine": "${engine.path}", "project": "${project.path}"}'
+	const cfg = { project: { name: 'Deno' }, engine: { path: 'V8' } }
+
+	const res = getSubstitutions(cfg)
+
+	const result = render(tmpl, res)
+	assertEquals(result, '{"name": "Deno", "engine": "V8", "project": "project.path"}')
+})