@elliemae/ds-monorepo-devops 3.51.0-next.10 → 3.51.0-next.12

package/bin/execGitReverseMerge/index.mjs

@@ -75,6 +75,25 @@ export async function promptForCommandOptions() {
     ...answers,
   };
 }
+/*
+ * given a file name, gitRemote and gitBranch and a command, return the command to execute the command on each file with xargs
+ * @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
+ * @param {string} [options.cmd] - the command to execute on each file
+ *
+ * @returns {string} - the command to execute the command on each file with xargs
+ *
+ * @example
+ * // => git ls-files origin/develop '** /CHANGELOG.md' | xargs git restore --source=origin/develop'
+ * executeCmdOnEachFileWithXargs({gitRemote: 'origin', gitBranch: 'develop', fileName: 'CHANGELOG.md', cmd: 'git restore --source=origin/develop' })
+ */
+const executeCmdOnEachFileWithXargs = ({ gitRemote, gitBranch, fileName, wantSubfolder = true, cmd }) =>
+  wantSubfolder
+    ? `git ls-files ${gitRemote}/${gitBranch} '**/${fileName}' | xargs ${cmd}`
+    : `git ls-files ${gitRemote}/${gitBranch} '${fileName}' | xargs ${cmd}`;
 
 /*
  * given a file name, gitRemote and gitBranch, return the command to restore the file in all subfolders, taking the file from the remote branch
@@ -90,9 +109,35 @@ export async function promptForCommandOptions() {
  * 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} `;
+  executeCmdOnEachFileWithXargs({
+    gitRemote,
+    gitBranch,
+    fileName,
+    wantSubfolder,
+    cmd: `git restore --source=${gitRemote}/${gitBranch} `,
+  });
+
+/*
+ * given a file name, gitRemote and gitBranch, return the command to add the files in all subfolders to the commit
+ * @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 add the files in all subfolders to the commit
+ * @example
+ *
+ * // => git ls-files origin/develop '** /CHANGELOG.md' | xargs git add '
+ * getAddChangedFilesToCommitCmd({gitRemote: 'origin', gitBranch: 'develop', fileName: 'CHANGELOG.md'})
+ */
+const getAddChangedFilesToCommitCmd = ({ gitRemote, gitBranch, fileName, wantSubfolder = true }) =>
+  executeCmdOnEachFileWithXargs({
+    gitRemote,
+    gitBranch,
+    fileName,
+    wantSubfolder,
+    cmd: `git add `,
+  });
 
 // 0 nothing to do, 1 can't auto-solve, -1 can auto-solve
 const canAutosolvePackageJsonConflict = async (packageJsonFilePath) => {
@@ -138,6 +183,8 @@ const gitReverseMerge = async (options) => {
     .replace(/\//g, '');
   const newBranchName = `${gitBranch}-${gitCurrent}-${todayMMDDYYYY}`;
 
+  // pull latest version of current branch
+  await execSyntaxSugar({ command: `git pull` });
   // create a new branch
   await execSyntaxSugar({ command: `git checkout -b ${newBranchName}` });
   // run the git merge command
@@ -156,19 +203,33 @@ const gitReverseMerge = async (options) => {
   // 3 - keep any branch CHANGELOG.md (they will be auto-generated anyway)
   const restoreChangelogCmd = getRestoreFileFromBranchUnixCmd({
     gitRemote,
-    gitCurrent,
+    gitBranch: gitCurrent,
     fileName: 'CHANGELOG.md',
     wantSubfolder: false,
   });
   await execSyntaxSugar({ command: restoreChangelogCmd });
+  const addChangelogCmd = getAddChangedFilesToCommitCmd({
+    gitRemote,
+    gitBranch: gitCurrent,
+    fileName: 'CHANGELOG.md',
+    wantSubfolder: false,
+  });
+  await execSyntaxSugar({ command: addChangelogCmd });
   // 4 - keep any branch ** /CHANGELOG.md (they will be auto-generated anyway)
   const restoreChangelogsCmd = getRestoreFileFromBranchUnixCmd({
     gitRemote,
-    gitCurrent,
+    gitBranch: gitCurrent,
     fileName: 'CHANGELOG.md',
     wantSubfolder: true,
   });
   await execSyntaxSugar({ command: restoreChangelogsCmd });
+  const addChangelogsCmd = getAddChangedFilesToCommitCmd({
+    gitRemote,
+    gitBranch: gitCurrent,
+    fileName: 'CHANGELOG.md',
+    wantSubfolder: true,
+  });
+  await execSyntaxSugar({ command: addChangelogsCmd });
 
   // we check all package.json files for conflicts and resolve those that can be auto-resolved, listin the ones that can't
   const cantAutoSolve = [];
@@ -192,15 +253,29 @@ const gitReverseMerge = async (options) => {
       wantSubfolder: false,
     });
     await execSyntaxSugar({ command: restorePackageJsonCmd });
+    const addPackageJsonCmd = getAddChangedFilesToCommitCmd({
+      gitRemote,
+      gitBranch,
+      fileName: packageJsonFilePath,
+      wantSubfolder: false,
+    });
+    await execSyntaxSugar({ command: addPackageJsonCmd });
   }
 
-  // 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
+  //   and because we can't resolve them, we can't continue with the automatic process
   if (cantAutoSolve.length > 0) {
     console.log("The following package.json files have conflicts that can't be auto-solved:");
     console.log(cantAutoSolve.join('\n'));
+    console.log('Please resolve these conflicts manually and finish the merge manually too');
+    console.log(
+      'you probably will need to run \n\t`pnpm run use-registry-version && pnpm run use-workspace-version`\nafter you resolve the package.json conflicts',
+    );
+  }
+
+  // 6 - run 'pnpm run use-registry-version && pnpm run use-workspace-version' to update the package.json files with the correct version
+  if (cantAutoSolve.length === 0) {
+    await execSyntaxSugar({ command: 'pnpm run use-registry-version && pnpm run use-workspace-version' });
   }
 };
 

package/bin/execSyncNxTags/index.mjs

@@ -7,7 +7,7 @@ const { glob } = defGlob;
 
 export async function promptForCommandOptions(options) {
   const questions = [];
-  if (!options.hello) {
+  if (!options.dryRun) {
     questions.push({
       type: 'list',
       name: 'dryRun',

package/bin/execute-commands-map.mjs

@@ -1,10 +1,12 @@
 import inquirer from 'inquirer';
 import { execSyncNxTags } from './execSyncNxTags/index.mjs';
-import {execGitReverseMerge} from './execGitReverseMerge/index.mjs';
+import { execGitReverseMerge } from './execGitReverseMerge/index.mjs';
+import { execForcePnpmCatalogVersions } from './forcePnpmCatalogVersions/index.mjs';
 
 const COMMANDS = {
   SYNC_NX_TAGS: 'sync-nx-tags',
   REVERSE_MERGE_BRANCH: 'reverse-merge-branch',
+  FORCE_PNPM_CATALOG_VERSIONS: 'force-pnpm-catalog-versions',
   EXIT: 'exit',
 };
 export const checkCommandOrInquire = async (options) => {
@@ -32,6 +34,9 @@ export async function executeCommandsMap(args, options) {
     case COMMANDS.REVERSE_MERGE_BRANCH:
       execGitReverseMerge(options);
       break;
+    case COMMANDS.FORCE_PNPM_CATALOG_VERSIONS:
+      execForcePnpmCatalogVersions(options);
+      break;
     default:
       break;
   }

package/bin/forcePnpmCatalogVersions/index.mjs

@@ -0,0 +1,140 @@
+/* eslint-disable complexity, no-console, max-statements */
+import inquirer from 'inquirer';
+import defGlob from 'glob';
+import path from 'node:path';
+import fs from 'node:fs';
+const { glob } = defGlob;
+
+export async function promptForCommandOptions(options) {
+  const questions = [];
+  if (!options.dryRun) {
+    questions.push({
+      type: 'list',
+      name: 'dryRun',
+      message: 'dry-run?',
+      default: 'n',
+      choices: ['y', 'n'],
+    });
+  }
+  const answers = await inquirer.prompt(questions);
+
+  return {
+    ...answers,
+  };
+}
+/**
+ * read the file cwd + pnpm-workspace.yaml and based on the "catalog:" field,
+ *
+ * check all subfolders under cwd + packages/ for a package.json file
+ *   any dependency/devDependency/peerDependency that matches something that is in the catalog: field
+ *   will be pointed to the catalog version via the "catalog:" value
+ *
+ * @example
+ *
+ * `pnpm-workspace.yaml`
+ * ```yaml
+ * catalog:
+ *   react: 18.2.0
+ * ```
+ * `packages/my-package/package.json`
+ * ```json
+ * {
+ *   "dependencies": {
+ *     "react": "no-matter-what",
+ *     "some-other-dep": "^1.0.0",
+ *   }
+ * }
+ * ```
+ * expected result:
+ * `packages/my-package/package.json`
+ * ```json
+ * {
+ *  "dependencies": {
+ *    "react": "catalog:",
+ *    "some-other-dep": "^1.0.0",
+ *   }
+ * }
+ * ```
+ *
+ * @param options
+ * @param {string} [options.dryRun='n'] - Indicates whether to perform a dry run ('y' or 'n').
+ * @returns {Promise<void>}
+ */
+const convertDepsToCatalogIfExisting = async (options) => {
+  const { dryRun } = options;
+  const pnpmWorspaceFilePath = path.resolve(process.cwd(), 'pnpm-workspace.yaml');
+  const pnpmWorkspaceAsString = fs.existsSync(pnpmWorspaceFilePath)
+    ? fs.readFileSync(pnpmWorspaceFilePath, 'utf8')
+    : -1;
+  if (pnpmWorkspaceAsString === -1) {
+    console.log('No pnpm-workspace.yaml found');
+    return;
+  }
+  const catalogStrings = [...pnpmWorkspaceAsString.matchAll(/catalog:\n((?:\s{2}.*\n?)*)/gm)]?.[0]?.[1] ?? '';
+  const catalogPackagesKeys = [...catalogStrings.matchAll(/(?:[\ ]{2}["']?)([\s\S]*?)(?:["']?:)/gm)].map((m) => m?.[1]);
+  if (!catalogPackagesKeys.length === 0) {
+    console.log('No catalog packages found');
+    return;
+  }
+  const globPatternPackage = 'packages/**/*/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 finalPath = path.resolve(process.cwd(), packageJsonFilePath);
+    const packageJson = JSON.parse(fs.readFileSync(finalPath, 'utf8'));
+
+    const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = packageJson;
+
+    const log = {
+      changedDeps: [],
+      changedDevDeps: [],
+      changedPeerDeps: [],
+    };
+
+    Object.keys(dependencies).forEach((pkg) => {
+      const isInCatalog = catalogPackagesKeys.includes(pkg);
+      if (isInCatalog) {
+        packageJson.dependencies[pkg] = 'catalog:';
+        log.changedDeps.push(pkg);
+      }
+    });
+    Object.keys(devDependencies).forEach((pkg) => {
+      const isInCatalog = catalogPackagesKeys.includes(pkg);
+      if (isInCatalog) {
+        packageJson.devDependencies[pkg] = 'catalog:';
+        log.changedDevDeps.push(pkg);
+      }
+    });
+    Object.keys(peerDependencies).forEach((pkg) => {
+      const isInCatalog = catalogPackagesKeys.includes(pkg);
+      if (isInCatalog) {
+        packageJson.peerDependencies[pkg] = 'catalog:';
+        log.changedPeerDeps.push(pkg);
+      }
+    });
+
+    if (dryRun === 'n') {
+      fs.writeFileSync(packageJsonFilePath, JSON.stringify(packageJson, null, 2));
+      if (log.changedDeps.length > 0)
+        console.log(`Updated ${packageJsonFilePath} dependencies: ${log.changedDeps.join(', ')}`);
+      if (log.changedDevDeps.length > 0)
+        console.log(`Updated ${packageJsonFilePath} devDependencies: ${log.changedDevDeps.join(', ')}`);
+      if (log.changedPeerDeps.length > 0)
+        console.log(`Updated ${packageJsonFilePath} peerDependencies: ${log.changedPeerDeps.join(', ')}`);
+      continue;
+    }
+    if (dryRun === 'y') {
+      if (log.changedDeps.length > 0)
+        console.log(`Would update ${packageJsonFilePath} dependencies: ${log.changedDeps.join(', ')}`);
+      if (log.changedDevDeps.length > 0)
+        console.log(`Would update ${packageJsonFilePath} devDependencies: ${log.changedDevDeps.join(', ')}`);
+      if (log.changedPeerDeps.length > 0)
+        console.log(`Would update ${packageJsonFilePath} peerDependencies: ${log.changedPeerDeps.join(', ')}`);
+    }
+  }
+};
+
+export const execForcePnpmCatalogVersions = async (options) => {
+  const commandOptions = await promptForCommandOptions(options);
+  await convertDepsToCatalogIfExisting(commandOptions);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-monorepo-devops",
-  "version": "3.51.0-next.10",
+  "version": "3.51.0-next.12",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Monorepo Devops",
   "type": "module",