chore: add option for log

Author: Ma11hewThomas

src/cli.ts

@@ -42,7 +42,7 @@ yargs(hideBin(process.argv))
     async (argv) => {
       try {
         const { pattern, output, tool, env, useSuiteName  } = argv;
-        await convertJUnitToCTRFReport(pattern as string, { outputPath: output as string, toolName: tool as string, envProps: env as string[], useSuiteName: useSuiteName as boolean });
+        await convertJUnitToCTRFReport(pattern as string, { outputPath: output as string, toolName: tool as string, envProps: env as string[], useSuiteName: useSuiteName as boolean, log: true });
         console.log('Conversion completed successfully.');
       } catch (error: any) {
         console.error('Error:', error.message);

src/convert.ts

@@ -8,6 +8,7 @@ interface ConvertOptions {
   toolName?: string;
   envProps?: string[];
   useSuiteName?: boolean;
+  log?: boolean;
 }
 
 /**
@@ -21,25 +22,25 @@ export async function convertJUnitToCTRFReport(
   options: ConvertOptions = {}
 ): Promise<CtrfReport | null> {
   const { outputPath, toolName, envProps, useSuiteName } = options;
-  const testCases = await readJUnitReportsFromGlob(pattern);
+  const testCases = await readJUnitReportsFromGlob(pattern, { log: options.log });
   const envPropsObj = envProps ? Object.fromEntries(envProps.map(prop => prop.split('='))) : {};
 
   if (testCases.length === 0) {
     console.warn('No test cases found in the provided path. No CTRF report generated.');
     return null;
   }
 
-  console.log(`Converting ${testCases.length} test cases to CTRF format`);
+  if (options.log) console.log(`Converting ${testCases.length} test cases to CTRF format`);
   const ctrfReport = createCTRFReport(testCases, toolName, envPropsObj, useSuiteName);
 
   if (outputPath) {
   const finalOutputPath = path.resolve(outputPath)
   const outputDir = path.dirname(finalOutputPath);
   await fs.ensureDir(outputDir);
 
-  console.log('Writing CTRF report to:', finalOutputPath);
+  if (options.log) console.log('Writing CTRF report to:', finalOutputPath);
   await fs.outputJson(finalOutputPath, ctrfReport, { spaces: 2 });
-  console.log(`CTRF report written to ${outputPath}`);
+  if (options.log) console.log(`CTRF report written to ${outputPath}`);
   }
   return ctrfReport;
 }

src/read.ts

@@ -7,19 +7,19 @@ import { glob } from 'glob';
  * @param globPattern - The glob pattern to match JUnit XML files
  * @returns Promise resolving to an array of all test cases from all matching files
  */
-export async function readJUnitReportsFromGlob(globPattern: string): Promise<JUnitTestCase[]> {
-    console.log('Searching for JUnit reports matching pattern:', globPattern);
+export async function readJUnitReportsFromGlob(globPattern: string, options: { log?: boolean } = {}): Promise<JUnitTestCase[]> {
+    if (options.log) console.log('Searching for JUnit reports matching pattern:', globPattern);
 
     const files = await glob(globPattern);
 
     if (files.length === 0) {
-        console.warn('No files found matching the pattern:', globPattern);
+        if (options.log) console.warn('No files found matching the pattern:', globPattern);
         return [];
     }
 
-    console.log(`Found ${files.length} JUnit report files`);
+    if (options.log) console.log(`Found ${files.length} JUnit report files`);
 
-    const allTestCasesPromises = files.map(file => parseJUnitReport(file));
+    const allTestCasesPromises = files.map(file => parseJUnitReport(file, options));
     const testCasesArrays = await Promise.all(allTestCasesPromises);
 
     return testCasesArrays.flat();
@@ -30,8 +30,8 @@ export async function readJUnitReportsFromGlob(globPattern: string): Promise<JUn
  * @param filePath - Path to the JUnit XML file
  * @returns Promise resolving to an array of test cases
  */
-export async function parseJUnitReport(filePath: string): Promise<JUnitTestCase[]> {
-    console.log('Reading JUnit report file:', filePath);
+export async function parseJUnitReport(filePath: string, options: { log?: boolean } = {}): Promise<JUnitTestCase[]> {
+    if (options.log) console.log('Reading JUnit report file:', filePath);
     const xml = await fs.readFile(filePath, 'utf-8');
     const result = await xml2js.parseStringPromise(xml);
     const testCases: JUnitTestCase[] = [];
@@ -89,7 +89,7 @@ export async function parseJUnitReport(filePath: string): Promise<JUnitTestCase[
         const suiteName = suite.$.name;
         parseTestSuite(suite, suiteName);
     } else {
-        console.warn('No test suites found in the provided file.');
+        if (options.log) console.warn('No test suites found in the provided file.');
     }
 
     return testCases;

src/run.ts

@@ -36,7 +36,7 @@ async function main() {
     //   await convertAndSaveToFile();
 
     const report = await convertJUnitToCTRFReport(
-        'test-junit.xml',
+        './*.xml',
         {
             outputPath: 'ctrf/output-report.json',
             toolName: 'junit-test-runner',