@elliemae/ds-codemods 3.55.1 → 3.57.0-next.1

package/bin/cli/code-mods/command-logics/check-deprecated-packages/index.mjs

@@ -1,14 +1,5 @@
-import { exec } from 'child_process';
-import { getEmDsPackagesFromNPMLS } from './getEmDsPackagesFromNPMLS.mjs';
 import { logResults, logCyanQuestion } from './logResults.mjs';
-
-const npmLs = async ({ cwd }) => {
-  const [, stdout] = await new Promise((resolve) => {
-    exec('npm ls', { cwd }, (...cbRes) => resolve(cbRes));
-  });
-  if (stdout) return getEmDsPackagesFromNPMLS(stdout);
-  return [];
-};
+import { npmLs } from '../../../utils/npmLs.mjs';
 
 export const checkDeprecatedPackages = async (options) => {
   const installedPackages = await npmLs(options);

package/bin/cli/code-mods/command-logics/check-missing-packages/index.mjs

@@ -93,7 +93,7 @@ export const checkMissingPackages = async (options) => {
       depcheck.special.tslint,
       depcheck.special.webpack,
     ],
-    ignorePatterns,
+    ignorePatterns: [...ignorePatterns, '.cache', 'src/tests'],
     ignoreMatches,
   };
   const pathToRoot = generatePathFromCurrentFolder(projectFolderPath);

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

@@ -1,6 +1,7 @@
 /* eslint-disable max-params, max-lines, max-statements, max-len */
 import fs from 'fs';
 import { filePathsWithGitIgnore } from '../../../utils/filepathsMatchers.mjs';
+import { npmLsSyncMultipleFormatsSync } from '../../../utils/npmLs.mjs';
 import { dimsumImportStatementsRegExp } from './dimsumImportStatementsRegExp.mjs';
 
 /**
@@ -19,7 +20,7 @@ import { dimsumImportStatementsRegExp } from './dimsumImportStatementsRegExp.mjs
  *
  * @typedef {PartialNamedImport[]} NamedImportResults
  *
- * @typedef { object } ImportsFlags
+ * @typedef {Object} ImportsFlags
  * @property {boolean} hasRelationWithDimsum
  *
  *
@@ -29,8 +30,23 @@ import { dimsumImportStatementsRegExp } from './dimsumImportStatementsRegExp.mjs
  * @property {namedImportWithoutRename[]} importedNamedComponentsWithoutRename
  * @property {namedImportWithRename[]} importedNamedComponentsWithRename
  *
- * @typedef {ImportsFlags & fileImportsInfos & Object} FileReport
+ * @typedef {ImportsFlags & fileImportsInfos} FileReport
  * @property {string} filePath
+ *
+ * @typedef {Object} ScriptOptions
+ * @property {string} options.outputPath - path to the .csv file to write the report to
+ * @property {string} options.startingDirPath - path to the project root directory (where node_modules folder lives)
+ * @property {string} options.gitIgnorePath - path to the .gitignore file
+ * @property {string} options.org - optional org, if present an extra column will be added to the report
+ * @property {string} options.repo - optional repo, if present an extra column will be added to the report
+ * @property {boolean} options.debug - debug flag
+ * @property {boolean} options.append - whether to append to the file or override it
+ *
+ *
+ * @typedef {import('../../../utils/getEmDsPackagesFromNPMLS.mjs').MatchWithMultipleVersionsArrayObj}  MatchWithMultipleVersionsArrayObj
+ * @typedef {Object.<string, MatchWithMultipleVersionsArrayObj>} MapOfMatchesBasedOnPackageName
+ *
+ * @typedef {ScriptOptions & {packagesVersions: MapOfMatchesBasedOnPackageName}} CSVGenerationOptions
  */
 
 // specific regexp to distinguish 'import * as X from "Y"'
@@ -190,18 +206,29 @@ export const getFileReport = (filePath) => {
 };
 /**
  * given a datum and a file path and options, generates a csv row
+ * @param {Object} datum - the datum to generate the csv row from
+ * @param {string} datum.importedComponent - the imported component name
+ * @param {string} datum.packageName - the package name
+ * @param {string} datum.renamedAs - the renamed alias
+ * @param {string} filePath - the file path where the datum was found
+ * @param {CSVGenerationOptions} options - options for the csv generation
+ * @returns {string} - the csv row
  */
 const generateCSVRow = (datum, filePath, options) => {
-  // "Org(?),Imported Component,Repository(?),Package Name,Renamed Alias,File Path
+  const { packagesVersions = {} } = options;
+  // "Org(?),Imported Component,Repository(?),Package Name,Renamed Alias,File Path,Version(s)"
   const { importedComponent, packageName, renamedAs } = datum;
+  const packageFound = packagesVersions[packageName];
+  const packageVersion = packageFound?.versions?.join?.('; ') || '';
   return `${options.org ? `${options.org},` : ''}${importedComponent},${
     options.repo ? `${options.repo},` : ''
-  }${packageName},${renamedAs},${filePath}`;
+  }${packageName},${renamedAs},${filePath},${packageVersion}`;
 };
 
 /**
  * given a file report, generates related csv rows (one or more)
  * @param {FileReport} fileReport - the file report to generate the csv rows from
+ * @param {CSVGenerationOptions} options - options for the csv generation
  * @returns {string[]} - the csv rows flattened per relevant columns distinguishers
  *
  */
@@ -288,14 +315,7 @@ const generateCSVRows = (fileReport, options) => {
 };
 /**
  * generates a report of components usage
- * @param {object} options - options *
- * @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.org - optional org, if present an extra column will be added to the report
- * @param {string} options.repo - optional repo, 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
+ * @param {ScriptOptions} options - options for the report generation directly from the command line
  *
  * @returns {string[]} - the csv rows, always starting with the header
  */
@@ -303,16 +323,26 @@ export const createCSVReport = (options) => {
   const filesToParse = filePathsWithGitIgnore(options);
 
   let csvRows = [
-    generateCSVRow(
+    `${generateCSVRow(
       { importedComponent: 'Imported Component', packageName: 'Package Name', renamedAs: 'Renamed Alias' },
       'File Path',
-      { ...options, org: options.org ? 'Org' : undefined, repo: options.repo ? 'Repository' : undefined },
-    ),
+      {
+        ...options,
+        org: options.org ? 'Org' : undefined,
+        repo: options.repo ? 'Repository' : undefined,
+        packagesVersions: {}, // the title row does not need versions
+      },
+    )}Version(s)`, // the title row has no related "datum" versions, we hardcode the last column title
   ];
 
+  const packagesVersions =
+    npmLsSyncMultipleFormatsSync({
+      cwd: options.startingDirPath,
+    })?.packageAsKeyVersionMatchedAsArrayOfStrings || {};
+
   filesToParse.forEach((filePath) => {
     const fileReport = getFileReport(filePath);
-    const fileCSVRows = generateCSVRows(fileReport, options);
+    const fileCSVRows = generateCSVRows(fileReport, { ...options, packagesVersions });
     csvRows.push(...fileCSVRows);
   });
 

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

@@ -1,5 +1,6 @@
 import fs from 'fs';
 import { filePathsWithGitIgnore } from '../../../utils/filepathsMatchers.mjs';
+import { npmLsSyncMultipleFormatsSync } from '../../../utils/npmLs.mjs';
 import { generateCsvRows, checkFileForDeprecatedComponents } from './utils.mjs';
 
 /**
@@ -26,19 +27,22 @@ export const deprecatedComponentsUsageReport = (options) => {
   // "Org(?),Legacy Component,Repository(?),Legacy Package,Filename,File Path,Effort Size,Story Points"
   let csvRows = [
     // eslint-disable-next-line prettier/prettier
-    `Legacy Component,${
-      options.org ? 'Org,' : ''
-    }${
+    `Legacy Component,${options.org ? 'Org,' : ''}${
       options.repo ? 'Repository,' : ''
-    }Legacy Package,Filename,File Path,Effort Size,Story Points`,
+    }Legacy Package,Filename,File Path,Effort Size,Story Points,Version(s)`,
   ];
+
+  const packagesVersions =
+    npmLsSyncMultipleFormatsSync({
+      cwd: options.startingDirPath,
+    })?.packageAsKeyVersionMatchedAsArrayOfStrings || {};
   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, options.org, options.repo));
+      csvRows.push(...generateCsvRows(fileReport, filePath, options.org, options.repo, packagesVersions));
     }
   });
   if (!append) {

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

@@ -1,17 +1,19 @@
 /* eslint-disable max-params, max-lines, max-statements, max-len */
 import fs from 'fs';
-import { dimsumImportStatementsRegExp } from './regexp.mjs';
 import {
-  LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT,
-  LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT,
-  LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT,
+  DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED,
   DISMISSED_WITH_EXAMPLE,
+  LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT,
+  LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT,
+  LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT,
   NEVER_INTENDED_FOR_EXTERNAL_USAGE,
-  DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED,
   STORYPOINTS_TO_EFFORT,
 } from '../../../constants/index.mjs';
-
+import { dimsumImportStatementsRegExp } from './regexp.mjs';
 /**
+ * @typedef {import('../../../utils/getEmDsPackagesFromNPMLS.mjs').MatchWithMultipleVersionsArrayObj}  MatchWithMultipleVersionsArrayObj
+ * @typedef {Object.<string, MatchWithMultipleVersionsArrayObj>} MapOfMatchesBasedOnPackageName
+ *
  * @typedef {typeof LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT
  *    | typeof LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT
  *    | typeof LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT} deprecatedEffortMap
@@ -315,10 +317,11 @@ export const checkFileForDeprecatedComponents = (filePath) => {
  * @param {string} filePath
  * @param {string} org - optional, if present an extra column will be added to the report
  * @param {string} repo - optional, if present an extra column will be added to the report
+ * @param {MapOfMatchesBasedOnPackageName} packagesVersions - a map of package names to their versions
  * @returns {string} - csv row
  */
-const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org, repo) => {
-  // "Legacy Component,Org(?),Repository(?),Legacy Package,Filename,File Path,Effort Size,Story Points"
+const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org, repo, packagesVersions) => {
+  // "Legacy Component,Org(?),Repository(?),Legacy Package,Filename,File Path,Effort Size,Story Points,Version(s)"
 
   // matchingEffortMetainfo type is deprecatedEffortMapEntry | dismissedWithExampleEntry
   // they share 'component' and 'oldPackage' properties and for the current use case we only care about those
@@ -331,9 +334,11 @@ const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org,
   const latestMatchingFolderIndx = pathFolders.findIndex((folder, indx) => folder !== cwdFolders[indx]);
   const filePathFolders = pathFolders.slice(latestMatchingFolderIndx);
   const reducedFilePath = filePathFolders.join('/');
+  const packageFound = packagesVersions[oldPackage];
+  const packageVersion = packageFound?.versions?.join?.('; ') || '';
   return `${component},${org ? `${org},` : ''}${
     repo ? `${repo},` : ''
-  }${oldPackage},${filename},${reducedFilePath},${tshirt},${storyPoints}`;
+  }${oldPackage},${filename},${reducedFilePath},${tshirt},${storyPoints},${packageVersion}`;
 };
 /**
  * Helper function to generate a list of csv rows from a given file report
@@ -341,9 +346,10 @@ const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org,
  * @param {string} filePath
  * @param {string} org - optional, if present an extra column will be added to the report
  * @param {string} repo - optional, if present an extra column will be added to the report
+ * @param {MapOfMatchesBasedOnPackageName} packagesVersions - a map of package names to their versions
  * @returns {string[]} - list of csv rows
  */
-export const generateCsvRows = (fileReport, filePath, org, repo) => {
+export const generateCsvRows = (fileReport, filePath, org, repo, packagesVersions) => {
   const {
     deprecatedSmallEffort,
     deprecatedMediumEffort,
@@ -352,7 +358,7 @@ export const generateCsvRows = (fileReport, filePath, org, repo) => {
     reportingUsageOfInternalOnly,
     deprecatedBeforeDeprecationFlowsExisted,
   } = fileReport;
-  // csv structure = `Legacy Component,${options.org ? 'Org,' : ''}${options.repo ? 'Repository,' : ''}Legacy Package,Filename,File Path,Effort Size,Story Points`
+  // csv structure = `Legacy Component,${options.org ? 'Org,' : ''}${options.repo ? 'Repository,' : ''}Legacy Package,Filename,File Path,Effort Size,Story Points,Version(s)`;
   // Legacy Component -> matchingEffortMetainfo.component
   // Legacy Package -> matchingEffortMetainfo.oldPackage
   // Filename -> filePath last part
@@ -363,40 +369,40 @@ export const generateCsvRows = (fileReport, filePath, org, repo) => {
   deprecatedSmallEffort.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
   deprecatedMediumEffort.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
   deprecatedLargeEffort.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
 
   deprecatedWithExample.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
 
   reportingUsageOfInternalOnly.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
 
   deprecatedBeforeDeprecationFlowsExisted.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
-      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo, packagesVersions));
     });
   });
 

package/bin/cli/constants/deprecatedPackages.mjs

@@ -246,6 +246,11 @@ export const LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT = [
     newComponent: 'DSControlledRadio',                newPackage: '@elliemae/ds-controlled-form',
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "150",
   },
+
+  { component:    'DSRadioGroup',                     oldPackage: '@elliemae/ds-form',
+    newComponent: 'DSFormLayoutRadioGroup',           newPackage: '@elliemae/ds-form-layout-blocks',
+    tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "150",
+  },
   
   { component:    'DSTextBox',                        oldPackage: '@elliemae/ds-form',
     newComponent: 'DSInputText',                      newPackage: '@elliemae/ds-controlled-form',
@@ -345,7 +350,7 @@ export const LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT = [
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "500",
   },
 
-  { component:    'DataGrid',                         oldPackage: '@elliemae/ds-data-grid',
+  { component:    'DSDataGrid',                       oldPackage: '@elliemae/ds-datagrids',
     newComponent: 'DataTable',                        newPackage: '@elliemae/ds-data-table',
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "500",
   },

package/bin/cli/utils/getEmDsPackagesFromNPMLS.mjs

@@ -0,0 +1,79 @@
+/* eslint-disable max-statements */
+
+/**
+ * @typedef {Object} MatchObj
+ * @property {string} fullMatch - the full match string from npm ls
+ * @property {string} version - the version string from npm ls
+ * @property {string} package - the package name string from npm ls
+ *
+ * @typedef {Object} MatchWithMultipleVersionsArrayObj
+ * @property {Array<{string}>} versions - all the versions found for this package
+ * @property {Array<MatchObj>} matchObjs
+ *  - all the match objects found for this package
+ *
+ * @typedef {Object.<string, MatchWithMultipleVersionsArrayObj>} MapOfMatchesBasedOnPackageName
+ *
+ * @typedef {Object} getEmDsPackagesFromNPMLSOptions
+ * @property {Function} [perMatchCallback] - a callback function that is called for each match found
+ *
+ * @typedef {Object} getEmDsPackagesFromNPMLsMultipleFormatsReturn
+ * @property {MapOfMatchesBasedOnPackageName} packageAsKeyVersionMatchedAsArrayOfStrings
+ *  - an object with package names as keys and their versions and match objects as values
+ * @property {Array<MatchObj>} arrayOfMatches
+ *  - an array of match objects
+ */
+
+const dsPackageRegExpFromNpmLs = /@elliemae\/ds-.*?@(.*)/gm;
+
+/**
+ * Given the npm ls stdout, parse it to find @elliemae/ds-* packages and return the matches
+ * @param {string} npmLsStdout
+ * @param {getEmDsPackagesFromNPMLSOptions} opts
+ * @returns {Array<MatchObj>}
+ */
+export function getEmDsPackagesFromNPMLS(npmLsStdout = '', { perMatchCallback = () => {} } = {}) {
+  const matches = new Map();
+  if (npmLsStdout && typeof npmLsStdout === 'string') {
+    const npmLsMatches = [...npmLsStdout.matchAll(dsPackageRegExpFromNpmLs)];
+    npmLsMatches.forEach(([fullMatch, version], index) => {
+      // in case there are extraneous things after the version, like "deduped" or "extraneous"
+      const cleanedFullMatch = fullMatch.split(' ')[0];
+      const cleanedVersion = version.split(' ')[0];
+      const cleanedPackage = cleanedFullMatch.split(cleanedVersion)[0].slice(0, -1);
+      const matchObj = {
+        fullMatch: cleanedFullMatch,
+        version: cleanedVersion,
+        package: cleanedPackage,
+      };
+      matches.set(cleanedFullMatch, matchObj);
+      perMatchCallback({ matchObj, cleanedFullMatch, cleanedVersion, cleanedPackage, fullMatch, version, index });
+    });
+  }
+
+  return Array.from(matches.values());
+}
+
+// like getEmDsPackagesFromNPMLS and based on it, but we organize the output format differently
+/**
+ * given the npm ls stdout, parse it to find @elliemae/ds-* packages and return the matches in different formats
+ *
+ * @param {string} npmLsStdout - the stdout from running `npm ls`
+ * @returns {getEmDsPackagesFromNPMLsMultipleFormatsReturn}
+ *  - object with the different formats of the parsed output
+ */
+export function getEmDsPackagesFromNPMLsMultipleFormats(npmLsStdout = '') {
+  const packageAsKeyVersionMatchedAsArrayOfStrings = {};
+  const opts = {
+    perMatchCallback: ({ matchObj, cleanedPackage, cleanedVersion }) => {
+      if (!packageAsKeyVersionMatchedAsArrayOfStrings[cleanedPackage]) {
+        packageAsKeyVersionMatchedAsArrayOfStrings[cleanedPackage] = { versions: [], matchObjs: [] };
+      }
+      packageAsKeyVersionMatchedAsArrayOfStrings[cleanedPackage].versions.push(cleanedVersion);
+      packageAsKeyVersionMatchedAsArrayOfStrings[cleanedPackage].matchObjs.push(matchObj);
+    },
+  };
+
+  const arrayOfMatches = getEmDsPackagesFromNPMLS(npmLsStdout, opts);
+
+  return { packageAsKeyVersionMatchedAsArrayOfStrings, arrayOfMatches };
+}

package/bin/cli/utils/index.mjs

@@ -1,5 +1,6 @@
-export { generatePathFromCurrentFolder, fullFilesPaths } from './filepathsMatchers.mjs';
+export { fullFilesPaths, generatePathFromCurrentFolder } from './filepathsMatchers.mjs';
+export { getLatestDimsumVersion } from './getLatestDimsumVersion.mjs';
 export { globArray } from './globArray.mjs';
+export { getHighestMatchVersion, getMatchVersions, getVersions } from './matchHelpers.mjs';
+export { npmLs } from './npmLs.mjs';
 export { replaceFromMap } from './replaceFromMap.mjs';
-export { getVersions, getMatchVersions, getHighestMatchVersion } from './matchHelpers.mjs';
-export { getLatestDimsumVersion } from './getLatestDimsumVersion.mjs';

package/bin/cli/utils/npmLs.mjs

@@ -0,0 +1,78 @@
+import { exec, execSync } from 'child_process';
+import { getEmDsPackagesFromNPMLS, getEmDsPackagesFromNPMLsMultipleFormats } from './getEmDsPackagesFromNPMLS.mjs';
+
+/**
+ * @typedef {import('./getEmDsPackagesFromNPMLS.mjs').MatchObj} MatchObj
+ * @typedef {import('./getEmDsPackagesFromNPMLS.mjs').PackageNameAsKeyObject} PackageNameAsKeyObject
+ * @typedef {import('./getEmDsPackagesFromNPMLS.mjs').getEmDsPackagesFromNPMLsMultipleFormatsReturn}
+ * getEmDsPackagesFromNPMLsMultipleFormatsReturn
+ */
+
+/** run `npm ls` in the specified directory and parse the output to find @elliemae/ds-* packages
+ * @param {object} runningOptions
+ * @param {string} runningOptions.cwd - the working directory to run npm ls in
+ * @returns {Promise<Array<MatchObj>>}
+ *  - array of objects with fullMatch, version, and package keys
+ */
+export const npmLs = async ({ cwd }) => {
+  const [, stdout] = await new Promise((resolve) => {
+    exec('npm ls', { cwd }, (...cbRes) => resolve(cbRes));
+  });
+  if (stdout) return getEmDsPackagesFromNPMLS(stdout);
+  return [];
+};
+/** run `npm ls` in the specified directory and parse the output to find @elliemae/ds-* packages in a synchronous way
+ * @param {object} runningOptions
+ * @param {string} runningOptions.cwd - the working directory to run npm ls in
+ * @returns {Array<MatchObj>}
+ *  - array of objects with fullMatch, version, and package keys
+ */
+export const npmLsSync = ({ cwd }) => {
+  let stdout = '';
+  try {
+    stdout = execSync('npm ls', { cwd, encoding: 'utf-8', stdio: ['pipe', 'pipe', 'ignore'] });
+  } catch (error) {
+    if (error.stdout) {
+      // we expect errors due to the fragility of npm ls and how it errors on malformed but functional package.json
+      //   but we want to continue with the stdout if it exists
+      stdout = error.stdout;
+    }
+  }
+  if (stdout) return getEmDsPackagesFromNPMLS(stdout);
+  return [];
+};
+/** run `npm ls` in the specified directory and parse the output to find @elliemae/ds-* packages
+ *
+ * @param {object} runningOptions
+ * @param {string} runningOptions.cwd - the working directory to run npm ls in
+ * @returns {Promise<getEmDsPackagesFromNPMLsMultipleFormatsReturn>}
+ *  - object with the different formats of the parsed output
+ */
+export const npmLsMultipleFormats = async ({ cwd }) => {
+  const [, stdout] = await new Promise((resolve) => {
+    exec('npm ls', { cwd }, (...cbRes) => resolve(cbRes));
+  });
+  if (stdout) return getEmDsPackagesFromNPMLsMultipleFormats(stdout);
+  return [];
+};
+/** run `npm ls` in the specified directory and parse the output to find @elliemae/ds-* packages
+ *
+ * @param {object} runningOptions
+ * @param {string} runningOptions.cwd - the working directory to run npm ls in
+ * @returns {getEmDsPackagesFromNPMLsMultipleFormatsReturn}
+ *  - object with the different formats of the parsed output
+ */
+export const npmLsSyncMultipleFormatsSync = ({ cwd }) => {
+  let stdout = '';
+  try {
+    stdout = execSync('npm ls', { cwd, encoding: 'utf-8', stdio: ['pipe', 'pipe', 'ignore'] });
+  } catch (error) {
+    if (error.stdout) {
+      // we expect errors due to the fragility of npm ls and how it errors on malformed but functional package.json
+      //   but we want to continue with the stdout if it exists
+      stdout = error.stdout;
+    }
+  }
+  if (stdout) return getEmDsPackagesFromNPMLsMultipleFormats(stdout);
+  return [];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "3.55.1",
+  "version": "3.57.0-next.1",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "files": [
@@ -50,10 +50,10 @@
     "test-check-packages-inconsistencies": "npx ./ check-packages-inconsistencies --globPattern='./test-ables/check-packages-inconsistencies/package.mock' --globPatternIgnore='**/node_modules/**/*'",
     "test-check-deprecated-packages": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/with-deprecated\"",
     "test-check-deprecated-packages-no-dimsum": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/without-dimsum-packages\"",
-    "test-components-usage-report-deprecated": "npx ./ deprecated-components-usage-report --outputPath=\"./test.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\"",
+    "test-components-usage-report-deprecated": "npx ./ deprecated-components-usage-report --outputPath=\"./test-deprecated.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\"",
     "test-components-usage-report": "npx ./ components-usage-report --outputPath=\"./test.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\"",
-    "test-components-usage-report-complete": "npx ./ components-usage-report --outputPath=\"./test.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\" --repo=\"Dimsum\" --org=\"ICE\"",
-    "test-components-usage-report-complete-append": "npx ./ components-usage-report --outputPath=\"./test.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\" --repo=\"Dimsum2\" --org=\"ICE2\"",
+    "test-components-usage-report-complete": "npx ./ components-usage-report --outputPath=\"./test-with-org.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\" --repo=\"Dimsum\" --org=\"ICE\"",
+    "test-components-usage-report-complete-append": "npx ./ components-usage-report --outputPath=\"./test-with-org.csv\" --startingDirPath=\"../../../environments\" --gitIgnorePath=\"../../../.gitignore\" --repo=\"Dimsum2\" --org=\"ICE2\"",
     "test-help-migrate-to-v3": "npx ./ help-migrate-to-v3 --globPattern=\"test-ables/help-migrate-to-v3/**/*.js,./**/*.jsx,./**/*.ts,./**/*.tsx\" --globPatternIgnore=\"**/node_modules/**/*\"",
     "checkDeps": "exit 0 | echo"
   }

package/bin/cli/code-mods/command-logics/check-deprecated-packages/getEmDsPackagesFromNPMLS.mjs

@@ -1,18 +0,0 @@
-/* eslint-disable max-statements */
-export function getEmDsPackagesFromNPMLS(npmLsStdout = '') {
-  const dsPackageRegExp = /@elliemae\/ds-.*?@(.*)/gm;
-  const matches = [];
-  if (npmLsStdout) {
-    const npmLsMatches = [...npmLsStdout.matchAll(dsPackageRegExp)];
-    npmLsMatches.forEach(([fullMatch, version]) => {
-      const matchObj = {
-        fullMatch,
-        version,
-        package: fullMatch.split(version)[0].slice(0, -1),
-      };
-      matches.push(matchObj);
-    });
-  }
-
-  return matches;
-}