@elliemae/ds-codemods 3.27.0-next.7 → 3.27.0-next.8

package/bin/cli/code-mods/cli.mjs

@@ -18,6 +18,8 @@ function parseArgumentsIntoOptions(rawArgs) {
       // it's impossible to determine if the user has passed the flag or not because
       //  for arg Boolean are either true or undefined.
       '--debug': Boolean,
+      '--append': Boolean,
+      '--codebaseName': String,
       '--fileExtensions': String,
     },
     {
@@ -35,6 +37,8 @@ function parseArgumentsIntoOptions(rawArgs) {
     startingDirPath: args['--startingDirPath'],
     debug: args['--debug'], // CLI flag, not available as a question.
     fileExtensions: args['--fileExtensions'], // CLI flag, not available as a question.
+    append: args['--append'], // CLI flag, not available as a question.
+    codebaseName: args['--codebaseName'], // CLI flag, not available as a question.
     gitIgnorePath: args['--gitIgnorePath'],
     script: args._[0],
   };

package/bin/cli/code-mods/command-arguments/getDeprecatedUsageReportQuestions.mjs

@@ -26,6 +26,8 @@ export const getDeprecatedUsageReportQuestions = (originalOptions) => {
     });
   }
   // --debug is a CLI flag, not available as a question.
+  // --append is a CLI flag, not available as a question.
+  // --codebaseName is a CLI flag, not available as a question.
 
   return extraOptions;
 };

package/bin/cli/code-mods/command-logics/deprecated-components-usage-report/index.mjs

@@ -8,29 +8,49 @@ import { generateCsvRows, checkFileForDeprecatedComponents } from './utils.mjs';
  * @param {string} options.outputPath - path to the .csv file to write the report to
  * @param {string} options.startingDirPath - path to the project root directory (where node_modules folder lives)
  * @param {string} options.gitIgnorePath - path to the .gitignore file
+ * @param {string} options.codebaseName - optional codebaseName, if present an extra column will be added to the report
  * @param {boolean} options.debug - debug flag
+ * @param {boolean} options.append - whether to append to the file or override it
  *
  * @returns {void}
  */
 export const deprecatedComponentsUsageReport = (options) => {
-  const { outputPath } = options;
+  const { outputPath, append } = options;
 
   const filesToParse = filePathsWithGitIgnore(options);
   // we have a lot more info than the one we use in the csv,
   //  in case we want to expand it in the future we can store it in the map...
   // const problematicFiles = new Map();
 
-  const csvRows = ['Legacy Component,Legacy Package,Filename,File Path'];
+  let csvRows = [`${options.codebaseName ? 'Codebase Name,' : ''}Legacy Component,Legacy Package,Filename,File Path`];
   filesToParse.forEach((filePath) => {
     const fileReport = checkFileForDeprecatedComponents(filePath);
     if (fileReport.isFileProblematic) {
       // we have a lot more info than the one we use in the csv,
       //  in case we want to expand it in the future we can store it in the map...
       // problematicFiles.set(filePath, fileReport);
-      csvRows.push(...generateCsvRows(fileReport, filePath));
+      csvRows.push(...generateCsvRows(fileReport, filePath, options.codebaseName));
     }
   });
-  fs.writeFileSync(outputPath, csvRows.join('\n'));
+  if (!append) {
+    fs.writeFileSync(outputPath, csvRows.join('\n'));
+  } else {
+    // when we append we do not want to repeat the header
+    // we check if the file exists and if it does we check if the first line is the header
+    const fileExists = fs.existsSync(outputPath);
+    let shouldAddHeader = true;
+    if (fileExists) {
+      const fileContent = fs.readFileSync(outputPath, 'utf8');
+      const firstLine = fileContent.split('\n')[0];
+      if (firstLine === csvRows[0]) {
+        shouldAddHeader = false;
+      }
+    }
+    if (!shouldAddHeader) {
+      csvRows.shift();
+    }
+    fs.appendFileSync(outputPath, csvRows.join('\n'));
+  }
 };
 
 export default deprecatedComponentsUsageReport;

package/bin/cli/code-mods/command-logics/deprecated-components-usage-report/utils.mjs

@@ -206,9 +206,10 @@ export const checkFileForDeprecatedComponents = (filePath) => {
  * Helper function to generate a csv row from a "matched effort" object
  * @param {matchedEffortMapValue} matchedEffort
  * @param {string} filePath
+ * @param {string} codebaseName - optional, if present an extra column will be added to the report
  * @returns {string} - csv row
  */
-const generateCsvRowFromMatchedEffort = (matchedEffort, filePath) => {
+const generateCsvRowFromMatchedEffort = (matchedEffort, filePath, codebaseName) => {
   const { matchingEffortMetainfo } = matchedEffort;
   // matchingEffortMetainfo type is deprecatedEffortMapEntry | dismissedWithExampleEntry
   // they share 'component' and 'oldPackage' properties and for the current use case we only care about those
@@ -220,15 +221,16 @@ const generateCsvRowFromMatchedEffort = (matchedEffort, filePath) => {
   const latestMatchingFolderIndx = pathFolders.findIndex((folder, indx) => folder !== cwdFolders[indx]);
   const filePathFolders = pathFolders.slice(latestMatchingFolderIndx);
   const reducedFilePath = filePathFolders.join('/');
-  return `${component},${oldPackage},${filename},${reducedFilePath}`;
+  return `${codebaseName ? `${codebaseName},` : ''}${component},${oldPackage},${filename},${reducedFilePath}`;
 };
 /**
  * Helper function to generate a list of csv rows from a given file report
  * @param {fileReport} fileReport
  * @param {string} filePath
+ * @param {string} codebaseName - optional, if present an extra column will be added to the report
  * @returns {string[]} - list of csv rows
  */
-export const generateCsvRows = (fileReport, filePath) => {
+export const generateCsvRows = (fileReport, filePath, codebaseName) => {
   const { deprecatedSmallEffort, deprecatedMediumEffort, deprecatedLargeEffort, deprecatedDismissed } = fileReport;
   // csv structure = 'Legacy Component,Legacy Package,Filename,File Path'
   // Legacy Component -> matchingEffortMetainfo.component
@@ -239,17 +241,17 @@ export const generateCsvRows = (fileReport, filePath) => {
   //  this is not a perfect "detect the root" solution, but should work in our CI/CD pipeline
   const csvRows = [];
   deprecatedSmallEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath));
+    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, codebaseName));
   });
   deprecatedMediumEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath));
+    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, codebaseName));
   });
   deprecatedLargeEffort.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath));
+    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, codebaseName));
   });
 
   deprecatedDismissed.forEach((effort) => {
-    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath));
+    csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, codebaseName));
   });
 
   return csvRows;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "3.27.0-next.7",
+  "version": "3.27.0-next.8",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "files": [