@elliemae/ds-monorepo-devops 3.51.0-next.7 → 3.51.0-next.9

package/bin/execGitReverseMerge/index.mjs

@@ -0,0 +1,210 @@
+/* eslint-disable max-lines */
+/* eslint-disable max-len */
+/* eslint-disable complexity, no-console, max-statements */
+import defGlob from 'glob';
+import inquirer from 'inquirer';
+import { exec } from 'node:child_process';
+import fs from 'node:fs';
+const { glob } = defGlob;
+
+const execSyntaxSugar = async ({ command, dryRun = false, silentFail = false }) => {
+  const noLFNorCRLFCmd = command.replace(/\r?\n|\r/g, '');
+  if (dryRun) {
+    console.log(noLFNorCRLFCmd);
+    return;
+  }
+  return new Promise((resolve, reject) => {
+    exec(noLFNorCRLFCmd, (error, stdout) => {
+      if (error && !silentFail) {
+        console.error(error);
+        reject(error);
+      }
+      resolve(stdout);
+    });
+  });
+};
+
+export async function promptForCommandOptions() {
+  const preAnswears = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'readyForProcedure',
+      message: 'are you currently on the branch you want to reverse merge into?',
+      default: 'n',
+      choices: ['y', 'n'],
+    },
+    {
+      type: 'list',
+      name: 'pendingChanges',
+      message: 'you have pending changes in your working directory?',
+      default: 'y',
+      choices: ['y', 'n'],
+    },
+  ]);
+  if (preAnswears.readyForProcedure === 'n') {
+    console.log('Please checkout the branch you want to reverse merge into and run the command again');
+    process.exit(0);
+  }
+  if (preAnswears.pendingChanges === 'y') {
+    console.log('Please commit or stash your changes and run the command again');
+    process.exit(0);
+  }
+  // we use git remote to get the list of remotes to choose from
+  const gitRemotes = await execSyntaxSugar({ command: 'git remote' });
+  const gitRemotesArray = gitRemotes.split('\n').filter((remote) => remote !== '');
+
+  const questions = [
+    {
+      type: 'list',
+      name: 'gitRemote',
+      message: 'which remote do you want to take the file from?',
+      choices: gitRemotesArray,
+      default: gitRemotesArray[0],
+    },
+    {
+      type: 'text',
+      name: 'gitBranch',
+      message: 'which branch do you want to take the files from?',
+      default: 'develop',
+    },
+  ];
+
+  const answers = await inquirer.prompt(questions);
+
+  return {
+    ...answers,
+  };
+}
+
+/*
+ * given a file name, gitRemote and gitBranch, return the command to restore the file in all subfolders, taking the file from the remote branch
+ * @param options
+ * @param {string} [options.gitRemote] - the remote to take the file from
+ * @param {string} [options.gitBranch] - the branch to take the file from
+ * @param {string} [options.fileName] - the file to restore
+ * @param {boolean} [options.wantSubfolder] - whether to restore the file in all subfolders or current folder only
+ * @returns {string} - the command to restore the file in all subfolders
+ *
+ * @example
+ * // => git ls-files origin/develop '** /CHANGELOG.md' | xargs git restore --source=origin/develop'
+ * getRestoreFileFromBranchUnixCmd({gitRemote: 'origin', gitBranch: 'develop', fileName: 'CHANGELOG.md'})
+ */
+const getRestoreFileFromBranchUnixCmd = ({ gitRemote, gitBranch, fileName, wantSubfolder = true }) =>
+  wantSubfolder
+    ? `git ls-files ${gitRemote}/${gitBranch} '**/${fileName}' | xargs git restore --source=${gitRemote}/${gitBranch} `
+    : `git ls-files ${gitRemote}/${gitBranch} '${fileName}' | xargs git restore --source=${gitRemote}/${gitBranch} `;
+
+// 0 nothing to do, 1 can't auto-solve, -1 can auto-solve
+const canAutosolvePackageJsonConflict = async (packageJsonFilePath) => {
+  const conflictRegexp = /<<<<<<<[\s\S]*=======[\s\S]*?>>>>>>>[\s\S]*?\n/g;
+  const packageJsonString = fs.readFileSync(packageJsonFilePath, 'utf8');
+
+  // check if only one conflict marker exists, if multiple, this requires manual resolution
+  const foundConflictMarkers = [...packageJsonString.matchAll(conflictRegexp)];
+  //check if no conflict markers exist
+  if (foundConflictMarkers.length === 0) return 0;
+  if (foundConflictMarkers.length === 1) {
+    // check if the conflict is only in the version field by matching "version" and see if it's found twice
+    const foundVersionKeys = [...packageJsonString.matchAll(/"version"/g)];
+    return foundVersionKeys.length === 2 ? -1 : 1;
+  }
+  return 1;
+};
+
+/*
+ * reverse merge a file from a remote branch using the following strategy:
+ * 1 - keep current branch ./lerna.json
+ * 2 - keep current branch ./ci_cd folder content
+ * 3 - keep current branch CHANGELOG.md (they will be auto-generated, but keeping "current" makes the diff easier to read)
+ * 4 - keep current branch ** /CHANGELOG.md (they will be auto-generated, but keeping "current" makes the diff easier to read
+ * 5 - check `** /* /package.json` that the conflict is ONLY in `version` field, any other conflict is marked for manual resolution
+ * 6 - run 'pnpm run use-registry-version && pnpm run use-workspace-version' to update the package.json files with the correct version
+ * also automatically switch to the $gitBranch-$gitCurrent-mmddyyyy new branch
+ * @param options
+ * @param {string} [options.gitRemote] - the remote to take the file from
+ * @param {string} [options.gitBranch] - the branch to take the file from
+ * @returns {Promise<void>}
+ */
+const gitReverseMerge = async (options) => {
+  const { gitRemote, gitBranch } = options;
+
+  const gitCurrent = await execSyntaxSugar({ command: 'git branch --show-current', dryRun: false });
+  const todayMMDDYYYY = new Intl.DateTimeFormat('en-US', {
+    month: '2-digit',
+    day: '2-digit',
+    year: 'numeric',
+  })
+    .format(new Date())
+    .replace(/\//g, '');
+  const newBranchName = `${gitBranch}-${gitCurrent}-${todayMMDDYYYY}`;
+
+  // create a new branch
+  await execSyntaxSugar({ command: `git checkout -b ${newBranchName}` });
+  // run the git merge command
+  await execSyntaxSugar({
+    command: `git merge --no-edit --no-commit --no-ff ${gitRemote}/${gitBranch}`,
+    silentFail: true,
+  });
+
+  // apply the strategy
+  // 1 - keep current branch ./lerna.json
+  const restoreLernaJsonCmd = `git restore --source=HEAD lerna.json`;
+  await execSyntaxSugar({ command: restoreLernaJsonCmd });
+  // 2 - keep current branch ./ci_cd folder content
+  const restoreCiCdCmd = `git restore --source=HEAD ci_cd`;
+  await execSyntaxSugar({ command: restoreCiCdCmd });
+  // 3 - keep any branch CHANGELOG.md (they will be auto-generated anyway)
+  const restoreChangelogCmd = getRestoreFileFromBranchUnixCmd({
+    gitRemote,
+    gitCurrent,
+    fileName: 'CHANGELOG.md',
+    wantSubfolder: false,
+  });
+  await execSyntaxSugar({ command: restoreChangelogCmd });
+  // 4 - keep any branch ** /CHANGELOG.md (they will be auto-generated anyway)
+  const restoreChangelogsCmd = getRestoreFileFromBranchUnixCmd({
+    gitRemote,
+    gitCurrent,
+    fileName: 'CHANGELOG.md',
+    wantSubfolder: true,
+  });
+  await execSyntaxSugar({ command: restoreChangelogsCmd });
+
+  // we check all package.json files for conflicts and resolve those that can be auto-resolved, listin the ones that can't
+  const cantAutoSolve = [];
+  const globPatternPackage = '**/*/package.json';
+  const packageJsonFilesPaths = glob(globPatternPackage, { sync: true, ignore: ['**/node_modules/**', '**/dist/**'] });
+
+  for (let i = 0; i < packageJsonFilesPaths.length; i += 1) {
+    const packageJsonFilePath = packageJsonFilesPaths[i];
+    const canAutoSolve = await canAutosolvePackageJsonConflict(packageJsonFilePath);
+    if (canAutoSolve === 0) continue;
+
+    if (canAutoSolve === 1) {
+      cantAutoSolve.push(packageJsonFilePath);
+      continue;
+    }
+
+    const restorePackageJsonCmd = getRestoreFileFromBranchUnixCmd({
+      gitRemote,
+      gitBranch,
+      fileName: packageJsonFilePath,
+      wantSubfolder: false,
+    });
+    await execSyntaxSugar({ command: restorePackageJsonCmd });
+  }
+
+  // 6 - run 'pnpm run use-registry-version && pnpm run use-workspace-version' to update the package.json files with the correct version
+  await execSyntaxSugar({ command: 'pnpm run use-registry-version && pnpm run use-workspace-version' });
+
+  // if there are conflicts that can't be auto-solved, list them
+  if (cantAutoSolve.length > 0) {
+    console.log("The following package.json files have conflicts that can't be auto-solved:");
+    console.log(cantAutoSolve.join('\n'));
+  }
+};
+
+export const execGitReverseMerge = async (options) => {
+  const commandOptions = await promptForCommandOptions(options);
+  await gitReverseMerge(commandOptions);
+};

package/bin/execute-commands-map.mjs

@@ -1,8 +1,10 @@
 import inquirer from 'inquirer';
 import { execSyncNxTags } from './execSyncNxTags/index.mjs';
+import {execGitReverseMerge} from './execGitReverseMerge/index.mjs';
 
 const COMMANDS = {
   SYNC_NX_TAGS: 'sync-nx-tags',
+  REVERSE_MERGE_BRANCH: 'reverse-merge-branch',
   EXIT: 'exit',
 };
 export const checkCommandOrInquire = async (options) => {
@@ -27,6 +29,9 @@ export async function executeCommandsMap(args, options) {
     case COMMANDS.SYNC_NX_TAGS:
       execSyncNxTags(options);
       break;
+    case COMMANDS.REVERSE_MERGE_BRANCH:
+      execGitReverseMerge(options);
+      break;
     default:
       break;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-monorepo-devops",
-  "version": "3.51.0-next.7",
+  "version": "3.51.0-next.9",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Monorepo Devops",
   "type": "module",
@@ -25,7 +25,7 @@
   },
   "engines": {
     "pnpm": ">=8",
-    "node": ">=18"
+    "node": ">=22"
   },
   "author": "ICE MT",
   "jestSonar": {