[NO-TICKET] Updates to migration scripts to fix prettier, doc updates (…

…#2020)

* updating to fix prettier

* updating readme notes

packages/design-system/scripts/cmsds-migrate/README.md

@@ -6,12 +6,12 @@ A bit more friendly than using unix command line tools.
 ## Configuration
 
 - Stored in `design-system/scripts/cmsds-migrate/configs`
-- Configuration files are ES6 modules that contain a single default export with the following keys:
+- Configuration files are JS modules that contain a single default export with the following keys:
   - description : A description of the config, what it will do, presented to user before changes occur
   - patterns : An array of glob patterns to search for, minimatch compatible
   - globbyConfig : A configuration object passed to globby, defaults provided, `optional`
   - expressions : An array of expression objects in the format `{ from: RegExp to: replacement }`
-- Can be specified from the command line.
+- Can be specified from the command line with the `--file` option.
 
 ## Command Line Options
 

packages/design-system/scripts/cmsds-migrate/configs/migration-notice-cleanup.mjs → packages/design-system/scripts/cmsds-migrate/configs/migration-notice-cleanup.js

@@ -2,7 +2,7 @@ export default {
   description: 'Cleans up comments/flags made by the cmsds-migrate script.',
   patterns: ['**/*'],
   globbyConfig: {
-    ignore: ['**/cmsds-migrate/configs/*.{mjs,js}'],
+    ignore: ['**/cmsds-migrate/configs/*.js'],
   },
   expressions: [
     { from: new RegExp(/<!-- CMSDS-MIGRATE:[\s\S]*?-->/, 'gi'), to: '' },

packages/design-system/scripts/cmsds-migrate/src/lib/migrate-helpers.js

@@ -0,0 +1,213 @@
+import chalk from 'chalk';
+import { globby } from 'globby';
+import inquirer from 'inquirer';
+import path from 'path';
+import { readdir, readFile, writeFile } from 'node:fs/promises';
+
+// confirm prompt for starting operations, display warning and y/n dialog
+export const confirmStart = () => {
+  return new Promise((resolve, reject) => {
+    inquirer
+      .prompt([
+        {
+          type: 'confirm',
+          name: 'yesno',
+          prefix: `
+${chalk.bgRed(
+  '┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  !!! CAUTION !!!  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓'
+)}
+${chalk.bgRed(
+  '┃'
+)}  Please be sure you are running this in a code repository where changes can be rolled back.  ${chalk.bgRed(
+            '┃'
+          )}
+${chalk.bgRed(
+  '┃'
+)}          Modifications will occur to files listed above. Proceed at your own risk.           ${chalk.bgRed(
+            '┃'
+          )}
+${chalk.bgRed(
+  '┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛'
+)}\n
+`,
+          message: 'Start modification?',
+          default: true,
+        },
+      ])
+      .then((choice) => {
+        resolve(choice.yesno);
+      })
+      .catch((err) => {
+        reject(err);
+      });
+  });
+};
+
+// return array of all globby pattern matches in one level
+export const doPatternSearch = async (config) => {
+  let res = [];
+  for (const p of config.patterns) {
+    res.push(
+      ...(await getGlob(p, config.globbyConfig).catch((err) => error('doPatternSearch: ' + err)))
+    );
+  }
+  return res;
+};
+
+// error and quit
+export const error = (message) => {
+  console.log(`\n${chalk.red('!!')} Error: ${message}\n`);
+  process.exit(1);
+};
+
+export const findMatchedFiles = async (fileList, config) => {
+  return getAllFileContents(fileList, config.globbyConfig.cwd).then((globbed) => {
+    // filter out minified files
+    const filtered = globbed
+      .filter((f) => {
+        return (f.data.match(/[\n\r]/g) || []).length > 3;
+      })
+      .filter((f) => {
+        config.expressions.forEach((e) => {
+          if (e.from.test(f.data)) f.matches++;
+        });
+        return f.matches > 0;
+      });
+
+    const matchedFiles = filtered.reduce((prev, current) => {
+      const fn = path.relative(config.globbyConfig.cwd, current.file);
+      return [...prev, fn];
+    }, []);
+
+    return matchedFiles;
+  });
+};
+
+// read file contents of all matched files, return filename and data, default matches (0)
+export const getAllFileContents = (fileList, cwd) => {
+  const readPromises = fileList.map(async (file) => {
+    file = cwd + path.sep + file;
+    return readFile(file, 'utf8')
+      .then((data) => {
+        return { file: file, data: data, matches: 0 };
+      })
+      .catch((err) => error('getAllFileContents: ' + err));
+  });
+  return Promise.all(readPromises);
+};
+
+// return list of files from path
+export const getConfigFileList = (path) => {
+  return new Promise((resolve, reject) => {
+    readdir(path)
+      .then((files) => {
+        resolve(
+          files.map((file) => ({
+            name: file.replaceAll('-', ' ').split('.')[0],
+            value: file,
+          }))
+        );
+      })
+      .catch((err) => reject(err));
+  });
+};
+
+// returns globby promise based on search pattern and configuration
+// https://github.com/sindresorhus/globby
+export const getGlob = (pattern, config) => {
+  return new Promise((resolve, reject) => {
+    globby(pattern, config)
+      .then((matches) => resolve(matches))
+      .catch((err) => reject(err));
+  });
+};
+
+// display list of configuration files retreived by readConfigFile
+export const inquireForFile = (folder, options) => {
+  return new Promise((resolve, reject) => {
+    inquirer
+      .prompt([
+        {
+          type: 'list',
+          name: 'file',
+          choices: options,
+          pageSize: 4,
+          prefix: `\n${chalk.green('?')} Choose a migration configuration to use:\n`,
+        },
+      ])
+      .then((choice) => {
+        const configPath = `${folder}/${choice.file}`;
+        resolve(readConfigFile(configPath));
+      })
+      .catch((err) => {
+        reject(err);
+      });
+  });
+};
+
+// for each expression (string.replace(from, to)) iterate over each file and make
+// changes where a match was found. Records number of matches per file.
+// @TODO: could probably be sped up but it already seems pretty fast.
+export const modifyFileContents = async (content, expr) => {
+  // filter out files with less than 3 newlines, likely compressed/minified files
+  content
+    .filter((f) => {
+      return (f.data.match(/[\n\r]/g) || []).length > 3;
+    })
+    .map((f) => {
+      expr.forEach((e) => {
+        f.data = f.data.replace(e.from, (match) => {
+          f.matches++;
+          return match.replace(e.from, e.to);
+        });
+      });
+      return f;
+    });
+
+  // promise map for writing file to the FS
+  const writePromises = content.map(async (content) => {
+    if (content.matches > 0) {
+      return writeFile(content.file, content.data, 'utf8')
+        .then(() => {
+          return { file: content.file, matches: content.matches };
+        })
+        .catch((err) => error('writePromises: ' + err));
+    } else {
+      return { file: content.file, matches: 0 };
+    }
+  });
+
+  // write out list of files that changed and how many changes were made
+  return await Promise.all(writePromises).then((results) => {
+    results.forEach((result) => {
+      if (result.matches > 0) {
+        // gives a shorter name
+        const shortname = path.relative(process.cwd(), result.file);
+        console.log(
+          `${chalk.yellow('>>')} ${shortname}${chalk.gray(',')} ${chalk.whiteBright(
+            result.matches
+          )} changes`
+        );
+      }
+    });
+  });
+};
+
+// read configuration file and return array with data and config filename
+export const readConfigFile = async (file) => {
+  const config = await import(file);
+  return [config.default, path.basename(file)];
+};
+
+export default {
+  confirmStart,
+  doPatternSearch,
+  error,
+  findMatchedFiles,
+  getAllFileContents,
+  getConfigFileList,
+  getGlob,
+  inquireForFile,
+  modifyFileContents,
+  readConfigFile,
+};