feat(cli): add --tsconfig option

Author: matejchalk

packages/cli/src/lib/implementation/core-config.middleware.ts

@@ -13,12 +13,15 @@ export async function coreConfigMiddleware<
   const args = processArgs;
   const {
     config,
+    tsconfig,
     persist: cliPersist,
     upload: cliUpload,
     ...remainingCliOptions
   } = args as GeneralCliOptions & Required<CoreConfig>;
   // if config path is given use it otherwise auto-load
-  const importedRc = config ? await readRcByPath(config) : await autoloadRc();
+  const importedRc = config
+    ? await readRcByPath(config, tsconfig)
+    : await autoloadRc(tsconfig);
   const {
     persist: rcPersist,
     upload: rcUpload,

packages/cli/src/lib/implementation/core-config.model.ts

@@ -15,7 +15,10 @@ export type UploadConfigCliOptions = {
 };
 /* eslint-enable @typescript-eslint/naming-convention */
 
-export type ConfigCliOptions = { config: string };
+export type ConfigCliOptions = {
+  config: string;
+  tsconfig?: string;
+};
 
 export type CoreConfigCliOptions = ConfigCliOptions &
   PersistConfigCliOptions &

packages/cli/src/lib/implementation/global.options.ts

@@ -19,7 +19,12 @@ export function yargsGlobalOptionsDefinition(): Record<
     },
     config: {
       describe:
-        'Path the the config file, e.g. code-pushup.config.ts. By default it loads code-pushup.config.(ts|mjs|js).',
+        'Path to config file, e.g. code-pushup.config.ts. By default it loads code-pushup.config.(ts|mjs|js).',
+      type: 'string',
+    },
+    tsconfig: {
+      describe:
+        'Path to a TypeScript config, to be used when loading config file.',
       type: 'string',
     },
   };

packages/core/src/lib/implementation/read-rc-file.ts

@@ -13,7 +13,10 @@ export class ConfigPathError extends Error {
   }
 }
 
-export async function readRcByPath(filepath: string): Promise<CoreConfig> {
+export async function readRcByPath(
+  filepath: string,
+  tsconfig?: string,
+): Promise<CoreConfig> {
   if (filepath.length === 0) {
     throw new Error('The path to the configuration file is empty.');
   }
@@ -22,12 +25,12 @@ export async function readRcByPath(filepath: string): Promise<CoreConfig> {
     throw new ConfigPathError(filepath);
   }
 
-  const cfg = await importEsmModule({ filepath });
+  const cfg = await importEsmModule({ filepath, tsconfig });
 
   return coreConfigSchema.parse(cfg);
 }
 
-export async function autoloadRc(): Promise<CoreConfig> {
+export async function autoloadRc(tsconfig?: string): Promise<CoreConfig> {
   // eslint-disable-next-line functional/no-let
   let ext = '';
   // eslint-disable-next-line functional/no-loop-statements
@@ -49,5 +52,8 @@ export async function autoloadRc(): Promise<CoreConfig> {
     );
   }
 
-  return readRcByPath(join(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
+  return readRcByPath(
+    join(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`),
+    tsconfig,
+  );
 }

packages/core/src/lib/types.ts

@@ -1,6 +1,6 @@
 export type GlobalOptions = {
-  //  'Show progress bar in stdout'
+  // Show progress bar in stdout
   progress: boolean;
-  //  Outputs additional information for a run'
+  // Outputs additional information for a run
   verbose: boolean;
 };