feat: add function to replace variables

Author: technote-space

__tests__/utils2.test.ts

@@ -2,8 +2,8 @@
 import { testEnv } from '@technote-space/github-action-test-helper';
 import { Utils } from '../src';
 
-const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, mask}  = Utils;
-const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit} = Utils;
+const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, mask}                    = Utils;
+const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit, replaceVariables} = Utils;
 
 jest.useFakeTimers();
 
@@ -251,3 +251,15 @@ describe('mask', () => {
 		});
 	});
 });
+
+describe('replaceVariables', () => {
+	it('should replace variables', async() => {
+		expect(await replaceVariables('', [])).toBe('');
+		expect(await replaceVariables('${test1}/${test2}/${test3}/${test4}', [
+			{key: 'test1', replace: '1'},
+			{key: 'test2', replace: (): string => '2'},
+			{key: 'test3', replace: (): Promise<string> => Promise.resolve('3')},
+			{key: 'test5', replace: '5'},
+		])).toBe('1/2/3/${test4}');
+	});
+});

src/utils.ts

@@ -186,3 +186,18 @@ export const mask = (value: object, target = 'token'): object => {
 
 	return value;
 };
+
+export const replaceVariables = async(string: string, variables: { key: string; replace: (() => Promise<string> | string) | string }[]): Promise<string> => {
+	let replaced = string;
+	for (const variable of variables) {
+		if (getRegExp(`\${${variable.key}}`).test(replaced)) {
+			if (typeof variable.replace === 'string') {
+				replaced = replaceAll(replaced, `\${${variable.key}}`, variable.replace);
+			} else {
+				replaced = replaceAll(replaced, `\${${variable.key}}`, await variable.replace());
+			}
+		}
+	}
+
+	return replaced;
+};