feat(utils): interpolate variables in strings

Author: matejchalk

packages/ci/src/lib/monorepo/handlers/nx.ts

@@ -2,6 +2,7 @@ import path from 'node:path';
 import {
   executeProcess,
   fileExists,
+  interpolate,
   stringifyError,
   toArray,
 } from '@code-pushup/utils';
@@ -32,7 +33,7 @@ export const nxHandler: MonorepoToolHandler = {
         'nx',
         'show',
         'projects',
-        ...toArray(nxProjectsFilter).map(arg => arg.replaceAll('{task}', task)),
+        ...toArray(nxProjectsFilter).map(arg => interpolate(arg, { task })),
         '--json',
       ],
       cwd,

packages/utils/src/index.ts

@@ -76,6 +76,7 @@ export {
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
 } from './lib/guards.js';
+export { interpolate } from './lib/interpolate.js';
 export { logMultipleResults } from './lib/log-results.js';
 export { link, ui, type CliUi, type Column } from './lib/logging.js';
 export { mergeConfigs } from './lib/merge-configs.js';

packages/utils/src/lib/interpolate.ts

@@ -0,0 +1,9 @@
+export function interpolate(
+  text: string,
+  variables: Record<string, string>,
+): string {
+  return Object.entries(variables).reduce(
+    (acc, [key, value]) => acc.replaceAll(`{${key}}`, value),
+    text,
+  );
+}

packages/utils/src/lib/interpolate.unit.test.ts

@@ -0,0 +1,52 @@
+import { interpolate } from './interpolate.js';
+
+describe('interpolate', () => {
+  it('should replace variable in string', () => {
+    expect(
+      interpolate('.code-pushup/{projectName}', { projectName: 'utils' }),
+    ).toBe('.code-pushup/utils');
+  });
+
+  it('should replace multiple variables', () => {
+    expect(
+      interpolate('{workspaceRoot}/coverage/{projectRoot}/lcov.info', {
+        workspaceRoot: '/home/matej/Projects/code-pushup-cli',
+        projectRoot: 'packages/ci',
+      }),
+    ).toBe(
+      '/home/matej/Projects/code-pushup-cli/coverage/packages/ci/lcov.info',
+    );
+  });
+
+  it('should replace same variable multiple times', () => {
+    expect(
+      interpolate('.code-pushup/{projectName}/{projectName}-report.json', {
+        projectName: 'utils',
+      }),
+    ).toBe('.code-pushup/utils/utils-report.json');
+  });
+
+  it('should not replace missing variables', () => {
+    expect(interpolate('{projectRoot}/.code-pushup', {})).toBe(
+      '{projectRoot}/.code-pushup',
+    );
+  });
+
+  it('should support empty string interpolation', () => {
+    expect(interpolate('{prefix}report.json', { prefix: '' })).toBe(
+      'report.json',
+    );
+  });
+
+  it('should support strings with only variable', () => {
+    expect(interpolate('{projectName}', { projectName: 'utils' })).toBe(
+      'utils',
+    );
+  });
+
+  it('should leave strings without variables unchanged', () => {
+    expect(interpolate('.code-pushup', { projectName: 'utils' })).toBe(
+      '.code-pushup',
+    );
+  });
+});

packages/utils/src/lib/types.ts

@@ -1,6 +1,6 @@
-export type ExcludeNullableProps<T> = {
+export type ExcludeNullableProps<T> = Prettify<{
   [P in keyof T]: NonNullable<T[P]>;
-};
+}>;
 
 export type ItemOrArray<T> = T | T[];
 
@@ -14,7 +14,7 @@ export type WithRequired<T, K extends keyof T> = Prettify<
   Omit<T, K> & Required<Pick<T, K>>
 >;
 
-export type Prettify<T> = { [K in keyof T]: T[K] };
+export type Prettify<T> = { [K in keyof T]: T[K] } & {};
 
 export type CamelCaseToKebabCase<T extends string> =
   T extends `${infer First}${infer Rest}`