fix(src): rename the executeCsv function into generateCsv

Green-Software-Foundation · Jul 16, 2024 · 669a422 · 669a422
1 parent e609d0c
commit 669a422
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/src/__tests__/if-csv/util/helpers.test.ts b/src/__tests__/if-csv/util/helpers.test.ts
@@ -3,7 +3,7 @@ import * as fs from 'fs/promises';
 import {stringify} from 'csv-stringify/sync';
 import {ERRORS} from '@grnsft/if-core/utils';
 
-import {executeCsv, getManifestData} from '../../../if-csv/util/helpers';
+import {generateCsv, getManifestData} from '../../../if-csv/util/helpers';
 import {CsvOptions} from '../../../if-csv/types/csv';
 
 const {ManifestValidationError} = ERRORS;
@@ -26,7 +26,7 @@ jest.mock('fs/promises', () => {
 });
 
 describe('if-csv/util/helpers: ', () => {
-  describe('executeCsv(): ', () => {
+  describe('generateCsv(): ', () => {
     it('generates CSV file with correct data.', async () => {
       const outputPath = 'output';
       const columns = ['Path', 'Aggregated', '2023-12-12T00:00:00.000Z'];
@@ -65,7 +65,7 @@ describe('if-csv/util/helpers: ', () => {
         params: 'carbon',
       };
 
-      await executeCsv(options);
+      await generateCsv(options);
 
       expect(fs.writeFile).toHaveBeenCalledWith(
         'output.csv',
@@ -112,7 +112,7 @@ describe('if-csv/util/helpers: ', () => {
         params: 'carbon',
       };
 
-      await executeCsv(options);
+      await generateCsv(options);
 
       expect.assertions(1);
 
@@ -162,7 +162,7 @@ describe('if-csv/util/helpers: ', () => {
         params: 'carbon',
       };
 
-      await executeCsv(options);
+      await generateCsv(options);
 
       expect.assertions(1);
       expect(fs.writeFile).toHaveBeenCalledWith(
@@ -190,7 +190,7 @@ describe('if-csv/util/helpers: ', () => {
         params: 'carbon',
       };
 
-      const result = await executeCsv(options);
+      const result = await generateCsv(options);
 
       expect.assertions(1);
       expect(result).toEqual(stringify(matrix, {columns}));
@@ -221,7 +221,7 @@ describe('if-csv/util/helpers: ', () => {
         params: 'carbon',
       };
 
-      await executeCsv(options);
+      await generateCsv(options);
 
       expect.assertions(1);
       expect(fs.writeFile).toHaveBeenCalledWith(

diff --git a/src/if-csv/index.ts b/src/if-csv/index.ts
@@ -7,7 +7,7 @@ import {debugLogger} from '../common/util/debug-logger';
 import {Manifest} from '../common/types/manifest';
 import {logger} from '../common/util/logger';
 
-import {executeCsv, getManifestData} from './util/helpers';
+import {generateCsv, getManifestData} from './util/helpers';
 import {parseIfCsvArgs} from './util/args';
 import {CsvOptions} from './types/csv';
 
@@ -30,7 +30,7 @@ const IfCsv = async () => {
       outputPath: output,
       params,
     };
-    const result = await executeCsv(options);
+    const result = await generateCsv(options);
 
     if (!output && result) {
       console.log(result);

diff --git a/src/if-csv/util/helpers.ts b/src/if-csv/util/helpers.ts
@@ -26,9 +26,9 @@ export const getManifestData = async (manifest: string) => {
 };
 
 /**
- * Executes a CSV generation based on the provided tree structure, context, output path, and params.
+ * Generates a CSV file based on the provided tree structure, context, output path, and params.
  */
-export const executeCsv = async (options: CsvOptions) => {
+export const generateCsv = async (options: CsvOptions) => {
   const {tree, context, outputPath, params} = options;
   const columns = ['Path'];
   const matrix = [columns];