@elliemae/ds-codemods 3.70.0-next.2 → 3.70.0-next.4

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

@@ -0,0 +1,25 @@
+export const getLegacyDeprecation27dot1Questions = (originalOptions) => {
+  const extraOptions = [];
+  const { startingDirPath, gitIgnorePath } = originalOptions;
+  if (!startingDirPath && startingDirPath !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'startingDirPath',
+      message: 'Please provide the project root directory (where node_modules folder lives)',
+      default: './',
+    });
+  }
+  if (!gitIgnorePath && gitIgnorePath !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'gitIgnorePath',
+      message:
+        'Please provide the path to the .gitignore file' +
+        '(if a non-matching path is provided, node_modules, dist and build will be ignored)',
+      default: './.gitignore',
+    });
+  }
+  // --debug is a CLI flag, not available as a question.
+
+  return extraOptions;
+};

package/bin/cli/code-mods/command-logics/execute-commands-map.mjs

@@ -1,3 +1,4 @@
+/* eslint-disable complexity */
 import { fixLegacyImports } from './fix-legacy-imports/index.mjs';
 import { checkPackagesInconsistencies } from './check-packages-inconsistencies/index.mjs';
 import { checkMissingPackages } from './check-missing-packages/index.mjs';
@@ -6,6 +7,7 @@ import { helpMigrateToV3 } from './help-migrate-to-v3/index.mjs';
 import { deprecatedComponentsUsageReport } from './deprecated-components-usage-report/index.mjs';
 import { componentsUsageReport } from './components-usage-report/index.mjs';
 import { legacyDeprecation26dot3 } from './legacy-deprecation-26-3/index.mjs';
+import { legacyDeprecation27dot1 } from './legacy-deprecation-27-1/index.mjs';
 import { COMMANDS } from '../commands.mjs';
 
 export async function executeCommandsMap(args, options) {
@@ -37,6 +39,9 @@ export async function executeCommandsMap(args, options) {
     case COMMANDS.LEGACY_DEPRECATION_26DOT3:
       legacyDeprecation26dot3(options);
       break;
+    case COMMANDS.LEGACY_DEPRECATION_27DOT1:
+      legacyDeprecation27dot1(options);
+      break;
     default:
       break;
   }

package/bin/cli/code-mods/command-logics/legacy-deprecation-27-1/index.mjs

@@ -0,0 +1,52 @@
+import fs from 'fs';
+import fse from 'fs-extra';
+import { filePathsWithGitIgnore } from '../../../utils/filepathsMatchers.mjs';
+import { legacy27dot1ImportMap, executeMapReplacement } from './legacy27dot1ImportMap.mjs';
+import { packageJsonReplaceLogic } from './packageJsonReplaceLogic.mjs';
+
+/**
+ * generates a report of deprecated components usage
+ * @param {object} options - options *
+ * @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 {boolean} options.debug - debug flag
+ * @param {string} options.fileExtensions - comma separated list of file extensions to filter by
+ *
+ * @returns {void}
+ */
+export const legacyDeprecation27dot1 = (options) => {
+  // 1- get all the "raw" code file paths using gitignore blacklist and file extension filter
+  const filesToParse = filePathsWithGitIgnore(options);
+  if (options.debug) console.log('legacy27dot1ImportMap :>> ', legacy27dot1ImportMap);
+  // 2- for each file, replace the imports from the legacy components with the new ones
+  filesToParse.forEach((path) => {
+    const fileContent = fs.readFileSync(path, {
+      encoding: 'utf8',
+      flag: 'r',
+    });
+    if (fileContent && typeof fileContent === 'string') {
+      const { finalString, matchesFound } = executeMapReplacement(fileContent);
+      const didChangeSomething = matchesFound.length > 0;
+      if (didChangeSomething) {
+        if (!options.debug) fse.outputFileSync(path, finalString);
+        else {
+          console.log(`File: ${path} - import(s) replacement(s) found!`);
+          console.log('matchesFound :>> ', matchesFound);
+        }
+      }
+    }
+  });
+  // 3- do something similar, but with opinionated "package.json" files and logic
+  //   in particular:
+  //   - we get the package.json files (multiple for monorepos?) and we parse them as json.
+  //   - check the dependencies and devDependencies and peerDependencies for any legacy component
+  //       (keyof legacy27dot1ImportMap) and replace it with the new one (value of legacy27dot1ImportMap)
+  const packageJsonPendingReplacements = packageJsonReplaceLogic(options);
+  if (options.debug) console.log('packageJsonPendingReplacements :>> ', packageJsonPendingReplacements);
+  else
+    Object.entries(packageJsonPendingReplacements).forEach(([path, newContent]) => {
+      fse.outputFileSync(path, newContent);
+    });
+};
+
+export default legacyDeprecation27dot1;

package/bin/cli/code-mods/command-logics/legacy-deprecation-27-1/legacy27dot1ImportMap.mjs

@@ -0,0 +1,44 @@
+/*
+  we need an exact match of the imports, we can't do a lose match
+  why?
+  we have packages that are the old package name with a different append
+  E.G. @elliemae/ds-button (legacy) and @elliemae/ds-button-v2 (new)
+  we can't replace
+    @elliemae/ds-button-v2 to @elliemae/ds-legacy-button-v2
+     because @elliemae/ds-button is a substring of @elliemae/ds-button-v2
+  how do we solve this?
+  key: exact match of the imports
+  value:{
+    matchChange: string; // the new package name to replace with
+    regexp
+    regexp: RegExp; // new Regexp(/(['"])(${key})(['"])/)
+  }
+  this will allow regexp match and replace based on group capture, so we can keep the same quotes as the original import
+  E.G. we can replace
+    from '@elliemae/ds-truncated-tooltip-text' to '@elliemae/ds-legacy-truncated-tooltip-text'
+    but also
+    from "@elliemae/ds-truncated-tooltip-text" to "@elliemae/ds-legacy-truncated-tooltip-text"
+*/
+export const legacy27dot1ImportMap = {
+  '@elliemae/ds-truncated-tooltip-text': {
+    matchChange: '@elliemae/ds-legacy-truncated-tooltip-text',
+    regexp: new RegExp(/(from ['"])(@elliemae\/ds-truncated-tooltip-text)(['"])/g),
+  },
+};
+
+export const executeMapReplacement = (fullFileStringContent) => {
+  if (typeof fullFileStringContent !== 'string') {
+    const error = `expected string argument but received ${typeof fullFileStringContent}`;
+    console.error(error);
+    throw new Error(error);
+  }
+  let finalString = fullFileStringContent;
+  const matchesFound = [];
+  Object.entries(legacy27dot1ImportMap).forEach(([key, { matchChange, regexp }]) => {
+    if (regexp.test(finalString)) {
+      matchesFound.push(key);
+      finalString = finalString.replaceAll(regexp, `$1${matchChange}$3`);
+    }
+  });
+  return { finalString, matchesFound };
+};

package/bin/cli/code-mods/command-logics/legacy-deprecation-27-1/packageJsonReplaceLogic.mjs

@@ -0,0 +1,124 @@
+/* eslint-disable max-statements */
+import fs from 'fs';
+import { boldRedStr, yellowStr } from '../../../utils/CLI_COLORS.mjs';
+import { filePathsWithGitIgnore } from '../../../utils/filepathsMatchers.mjs';
+import { legacy27dot1ImportMap } from './legacy27dot1ImportMap.mjs';
+
+/**
+ *
+ * parse a package.json, checks the dependencies(dev and peer included) for any legacy component
+ *
+ * if any legacy component is found,
+ *  generates a new content for the file with the legacy component replaced with the new one and version set to "latest"
+ *
+ * @param {string} path - the package.json file path
+ * @param {object} options - options *
+ * @param {boolean} options.debug - debug flag
+ * @returns {string | -1} - the new content (json to string) if any change is needed,
+ *   or -1 if no change is needed or in case of error
+ */
+// eslint-disable-next-line complexity
+const specificPackageJsonReplaceLogic = (path, options) => {
+  const fileContent = fs.readFileSync(path, {
+    encoding: 'utf8',
+    flag: 'r',
+  });
+  if (!fileContent || typeof fileContent !== 'string') {
+    if (options.debug) console.log(yellowStr(`Empty or invalid content in ${path}`));
+    return -1;
+  }
+  const parsedContent = JSON.parse(fileContent);
+  const newDeps = { ...parsedContent.dependencies };
+  let depsChanged = false;
+  Object.keys(parsedContent.dependencies || {}).forEach((oldPackageString) => {
+    if (legacy27dot1ImportMap[oldPackageString]) {
+      const newPackageString = legacy27dot1ImportMap[oldPackageString].matchChange;
+      newDeps[newPackageString] = 'latest';
+      delete newDeps[oldPackageString];
+      depsChanged = true;
+    }
+  });
+
+  const newDevDeps = { ...parsedContent.devDependencies };
+  let devDepsChanged = false;
+  Object.keys(parsedContent.devDependencies || {}).forEach((oldPackageString) => {
+    if (legacy27dot1ImportMap[oldPackageString]) {
+      const newPackageString = legacy27dot1ImportMap[oldPackageString].matchChange;
+      newDevDeps[newPackageString] = 'latest';
+      delete newDevDeps[oldPackageString];
+      devDepsChanged = true;
+    }
+  });
+  const newPeerDeps = { ...parsedContent.peerDependencies };
+  let peerDepsChanged = false;
+  Object.keys(parsedContent.peerDependencies || {}).forEach((oldPackageString) => {
+    if (legacy27dot1ImportMap[oldPackageString]) {
+      const newPackageString = legacy27dot1ImportMap[oldPackageString].matchChange;
+      newPeerDeps[newPackageString] = 'latest';
+      delete newPeerDeps[oldPackageString];
+      peerDepsChanged = true;
+    }
+  });
+  if (!depsChanged && !devDepsChanged && !peerDepsChanged) {
+    if (options.debug) console.log(yellowStr(`No legacy dependencies found in ${path}`));
+    return -1;
+  }
+  const newContent = {
+    ...parsedContent,
+    ...(depsChanged && { dependencies: newDeps }),
+    ...(devDepsChanged && { devDependencies: newDevDeps }),
+    ...(peerDepsChanged && { peerDependencies: newPeerDeps }),
+  };
+
+  return JSON.stringify(newContent, null, 2);
+};
+
+/**
+ * do something similar, but with opinionated "package.json" files and logic
+ *
+ * in particular:
+ * - we get the package.json files (multiple for monorepos?) and we parse them as json.
+ * - check the dependencies and devDependencies and peerDependencies for any legacy component
+ *     (keyof legacy27dot1ImportMap) and replace it with the new one (value of legacy27dot1ImportMap)
+ * - if any change is needed, we return an object so that the caller can decide what to do with it
+ *     (write it or just log it for the user to review)
+ * @param {object} options - options *
+ * @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 {boolean} options.debug - debug flag
+ * @param {string} options.fileExtensions - comma separated list of file extensions to filter by
+ * @returns {object} - an object with the (package.json) file path as key and the new content (json to string) as value,
+ * for each package.json file that needs changes
+ */
+export const packageJsonReplaceLogic = (options) => {
+  // 1- get the package.json files (multiple for monorepos?) paths
+  const jsonFilesPaths = filePathsWithGitIgnore({ ...options, fileExtensions: '.json' });
+  //  the above function doesn't allow for specific filename matching,
+  //    this is a one-off right now so not extending the function
+  //    instead we filter the results with a simple string match, to get only the package.json files paths
+  const packageJsonFilesPaths = jsonFilesPaths.filter((path) => path.endsWith('package.json'));
+  if (packageJsonFilesPaths.length === 0) {
+    console.log(boldRedStr('No package.json files! Please check the startingDirPath and gitIgnorePath options.'));
+    console.log(
+      yellowStr(
+        `To make sure migration is successful manually:
+- check for any legacy components in your package.json
+- replace them with the new ones.
+- point them to "latest" version, the legacy library only get updated with critical security fixes and very rarely so.
+- regenerate the lock file ( pnpm i --fix-lockfile or equivalent command/flow for your package manager)
+
+The legacy components to look for are:`,
+      ),
+    );
+    console.log(legacy27dot1ImportMap);
+    return {};
+  }
+  const filesToChange = {};
+  // 2 - parse, check and generate new content for each package.json file
+  packageJsonFilesPaths.forEach((path) => {
+    if (options.debug) console.log('path :>> ', path);
+    const newContent = specificPackageJsonReplaceLogic(path, options);
+    if (newContent !== -1) filesToChange[path] = newContent;
+  });
+  return filesToChange;
+};

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

@@ -8,6 +8,7 @@ export const COMMANDS = {
   DEPRECATED_PACKAGES_USAGE_REPORT: 'deprecated-components-usage-report',
   COMPONENT_USAGE_REPORT: 'components-usage-report',
   LEGACY_DEPRECATION_26DOT3: 'legacy-deprecation-26dot3',
+  LEGACY_DEPRECATION_27DOT1: 'legacy-deprecation-27dot1',
   EXIT: 'exit',
 };
 

package/bin/cli/code-mods/inquirer-questions-prompter.mjs

@@ -7,6 +7,7 @@ import { getHelpMigrateToV3Questions } from './command-arguments/promptHelpMigra
 import { getMissingPackagesQuestions } from './command-arguments/promptMissingPackages.mjs';
 import { getDeprecatedUsageReportQuestions } from './command-arguments/getDeprecatedUsageReportQuestions.mjs';
 import { getLegacyDeprecation26dot3Questions } from './command-arguments/getLegacyDeprecation26dot3Questions.mjs';
+import { getLegacyDeprecation27dot1Questions } from './command-arguments/getLegacyDeprecation27dot1Questions.mjs';
 
 // eslint-disable-next-line complexity
 async function promptForMissingScriptSpecificOptions({ originalOptions, promptOptions }) {
@@ -36,6 +37,9 @@ async function promptForMissingScriptSpecificOptions({ originalOptions, promptOp
     case COMMANDS.LEGACY_DEPRECATION_26DOT3:
       scriptQuestions.push(...getLegacyDeprecation26dot3Questions(originalOptions));
       break;
+    case COMMANDS.LEGACY_DEPRECATION_27DOT1:
+      scriptQuestions.push(...getLegacyDeprecation27dot1Questions(originalOptions));
+      break;
     default:
       break;
   }

package/package.json

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