@elliemae/ds-monorepo-devops 3.50.1-next.8 → 3.51.0-beta.1

package/bin/cli.mjs

@@ -0,0 +1,20 @@
+import arg from 'arg';
+import { checkCommandOrInquire, executeCommandsMap } from './execute-commands-map.mjs';
+
+function parseArgumentsIntoOptions(rawArgs) {
+  const args = arg(
+    {},
+    {
+      argv: rawArgs.slice(2),
+    },
+  );
+  return {
+    command: args._[0],
+  };
+}
+
+export async function cli(args) {
+  let options = parseArgumentsIntoOptions(args);
+  options = await checkCommandOrInquire(options);
+  executeCommandsMap(args, options);
+}

package/bin/ds-monorepo-devops.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { cli } from './cli.mjs';
+
+cli(process.argv);

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,
+    gitBranch: 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,
+    gitBranch: 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/execSyncNxTags/index.mjs

@@ -0,0 +1,104 @@
+/* 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.hello) {
+    questions.push({
+      type: 'list',
+      name: 'dryRun',
+      message: 'dry-run?',
+      default: 'n',
+      choices: ['y', 'n'],
+    });
+  }
+  const answers = await inquirer.prompt(questions);
+
+  return {
+    ...answers,
+  };
+}
+
+/**
+ * check all subfolders under cwd + packages/ for a package.json file
+ * - if it exists, check for project.json file in the same folder
+ *    - if it doesn't exist, continue to the next folder
+ *    - if both exist, check the "tags" array in the project.json file to
+ *      - package.json `typesafety`
+ *        - true
+ *          - tag ensure "strict-eslint" exists in the tags array
+ *        - false
+ *          - tag remove "strict-eslint" from the tags array if it exists
+ *    - `"status:eol"`
+ *        - yes
+ *          - remove the taxonomy tag from the tags array
+ *        - no
+ *          - add the taxonomy tag to the tags array if it doesn't exist or prompt the user to add it(in dry-run mode)
+ *          (E.G. packages/layout/... -> "layout", packages/atom/... -> "atom")
+ * - if it doesn't exist, continue to the next folder
+ * @param options
+ * @param {string} [options.dryRun='n'] - Indicates whether to perform a dry run ('y' or 'n').
+ * @returns {Promise<void>}
+ */
+const fixMissingTags = async (options) => {
+  const { dryRun } = options;
+  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 { publishConfig: { typeSafety = false } = {} } = packageJson;
+    const taxonomy = finalPath.split('/').reverse()[2];
+
+    const projectJsonFilePath = path.resolve(finalPath, '../project.json');
+    if (!fs.existsSync(projectJsonFilePath)) continue;
+    const projectJson = JSON.parse(fs.readFileSync(projectJsonFilePath, 'utf8'));
+    const missingTags = [];
+    const extraTags = [];
+
+    const isMarkedAsStrict = projectJson.tags.includes('strict-eslint');
+    if (typeSafety && !isMarkedAsStrict) missingTags.push('strict-eslint');
+    if (!typeSafety && isMarkedAsStrict) extraTags.push('strict-eslint');
+
+    const isEol = projectJson.tags.includes('status:eol');
+    const hasTaxonomy = projectJson.tags.includes(taxonomy);
+    if (!isEol && !hasTaxonomy) missingTags.push(taxonomy);
+    if (isEol && hasTaxonomy) extraTags.push(taxonomy);
+
+    const shouldRemoveTags = extraTags.length !== 0;
+    const shouldAddTags = missingTags.length !== 0;
+    const shouldDoNothing = !shouldAddTags && !shouldRemoveTags;
+    if (shouldDoNothing) continue;
+
+    // mutate projectJson.tags
+    if (shouldAddTags) {
+      projectJson.tags.push(...missingTags);
+    }
+    // mutate projectJson.tags
+    if (shouldRemoveTags) {
+      projectJson.tags = projectJson.tags.filter((tag) => !extraTags.includes(tag));
+    }
+
+    if (dryRun === 'n') {
+      projectJson.tags.sort();
+      fs.writeFileSync(projectJsonFilePath, JSON.stringify(projectJson, null, 2));
+      if (shouldAddTags) console.log(`Added ${missingTags.join(', ')} tag to ${projectJsonFilePath}`);
+      if (shouldRemoveTags) console.log(`Removed ${taxonomy} tag from ${projectJsonFilePath}`);
+      continue;
+    }
+    if (dryRun === 'y') {
+      if (shouldAddTags) console.log(`Would have added ${missingTags.join(', ')} to ${projectJsonFilePath}`);
+      if (shouldRemoveTags) console.log(`Would have removed ${taxonomy} from ${projectJsonFilePath}`);
+    }
+  }
+};
+
+export const execSyncNxTags = async (options) => {
+  const commandOptions = await promptForCommandOptions(options);
+  await fixMissingTags(commandOptions);
+};

package/bin/execute-commands-map.mjs

@@ -0,0 +1,38 @@
+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) => {
+  const questions = [];
+  if (!options.command) {
+    questions.push({
+      type: 'list',
+      name: 'command',
+      message: 'Please choose which command to run',
+      choices: Object.values(COMMANDS),
+    });
+  }
+  const answers = await inquirer.prompt(questions);
+  return {
+    ...options,
+    ...answers,
+  };
+};
+
+export async function executeCommandsMap(args, options) {
+  switch (options.command) {
+    case COMMANDS.SYNC_NX_TAGS:
+      execSyncNxTags(options);
+      break;
+    case COMMANDS.REVERSE_MERGE_BRANCH:
+      execGitReverseMerge(options);
+      break;
+    default:
+      break;
+  }
+}

package/configs/jest.config.mjs

@@ -1,14 +1,70 @@
 import { jestConfig } from '@elliemae/pui-cli';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
+const __dirname = path.dirname(__filename); // get the name of the directory
+const getFileFromCurrentFolder = (fileName) => path.normalize(path.resolve(__dirname, fileName));
+/**
+ * Generates an array of setup files for Jest based on provided flags.
+ *
+ * @param {Object} options - The options object.
+ * @param {boolean} [options.silenceConsole=false] - Flag to determine if console output should be silenced.
+ * @returns {string[]} An array of setup files for Jest.
+ */
+const getSetupFilesAfterEnvBasedOnFlags = ({ silenceConsole = false }) => {
+  const setupFilesAfterEnv = [];
 
-export const config = (specificFile = undefined, specialRules = {}) => ({
-  ...jestConfig,
-  collectCoverage: false,
-  collectCoverageFrom: [],
-  coverageDirectory: undefined,
-  coverageReporters: undefined,
-  ...specialRules,
-  // testRegex: 'tests/.*\\.test\\.[jt]sx?$',
-  testRegex: specificFile ? `.*/tests/${specificFile}$` : 'tests/.*\\.test\\.[jt]sx?$',
-  testTimeout: 120000,
-});
+  if (silenceConsole) {
+    setupFilesAfterEnv.push(getFileFromCurrentFolder('noConsoleMode.mjs'));
+  }
+
+  return setupFilesAfterEnv;
+};
+
+/**
+ * Generates a Jest configuration object.
+ *
+ * @param {Object} options - Configuration options.
+ * @param {string} [options.relativePathAfterTestsFolder] - Relative path after the tests folder to match test files.
+ * @param {Object} [options.firstLevelSpread] - Configuration options to override defaults.
+ * @param {Object} options.flags - Flags for configuration.
+ * @param {boolean} [options.flags.silenceConsole=false] - Flag to silence the console during tests.
+ * @returns {import('jest').Config} Jest configuration object.
+ *
+ * @example
+ * config({
+ *   // matches tests/GlobalHeader.keyboard.test.js
+ *   relativePathAfterTestsFolder: 'GlobalHeader.keyboard.test.js',
+ *   // overrides the default configuration for jest config 'verbose' to true
+ *   firstLevelSpread: { verbose: true },
+ *   // silences the console during tests via custom setup file
+ *   flags: { silenceConsole: true }
+ * });
+ *
+ * @example
+ * // matches tests/GlobalHeader/a11y/test.keys.js
+ * config({
+ *   relativePathAfterTestsFolder: 'GlobalHeader/a11y/test.keys.js',
+ *   flags: { silenceConsole: true }
+ * });
+ */
+export const config = ({ relativePathAfterTestsFolder = undefined, firstLevelSpread = {}, flags = {} } = {}) => {
+  const silenceConsole = flags.silenceConsole ?? process.env.JEST_FORCE_SILENT_CONSOLE ?? false;
+
+  /** @type {import('jest').Config} */
+  return {
+    ...jestConfig,
+    collectCoverage: false,
+    collectCoverageFrom: [],
+    coverageDirectory: undefined,
+    coverageReporters: undefined,
+    // testRegex: 'tests/.*\\.test\\.[jt]sx?$',
+    testRegex: relativePathAfterTestsFolder
+      ? `.*/tests/${relativePathAfterTestsFolder}$`
+      : 'tests/.*\\.test\\.[jt]sx?$',
+    testTimeout: 120000,
+    setupFilesAfterEnv: [...jestConfig.setupFilesAfterEnv, ...getSetupFilesAfterEnvBasedOnFlags({ silenceConsole })],
+    ...firstLevelSpread,
+  };
+};
 export default config;

package/configs/noConsoleMode.mjs

@@ -0,0 +1 @@
+global.console = { jestLog: console.log, error: jest.fn(), warn: jest.fn(), log: jest.fn() };

package/package.json

@@ -1,11 +1,17 @@
 {
   "name": "@elliemae/ds-monorepo-devops",
-  "version": "3.50.1-next.8",
+  "version": "3.51.0-beta.1",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Monorepo Devops",
+  "type": "module",
   "files": [
+    "bin",
     "configs"
   ],
+  "bin": {
+    "@elliemae/ds-monorepo-devops": "./bin/ds-monorepo-devops.mjs",
+    "ds-monorepo-devops": "./bin/ds-monorepo-devops.mjs"
+  },
   "exports": {
     "./configs/jest.config": {
       "import": "./configs/jest.config.mjs",
@@ -19,7 +25,7 @@
   },
   "engines": {
     "pnpm": ">=8",
-    "node": ">=18"
+    "node": ">=22"
   },
   "author": "ICE MT",
   "jestSonar": {
@@ -29,7 +35,11 @@
     "indent": 4
   },
   "peerDependencies": {
-    "@elliemae/pui-cli": "9.0.0-next.31",
+    "@elliemae/pui-cli": "9.0.0-next.55",
+    "arg": "~5.0.2",
+    "glob": "~10.2.5",
+    "ignore": "^5.3.0",
+    "inquirer": "~12.0.0",
     "jest": "~29.7.0"
   },
   "publishConfig": {