@dialpad/dialtone 9.150.1 → 9.150.3

package/dist/js/dialtone_migration_helper/configs/box-shadows.mjs

@@ -0,0 +1,19 @@
+export default {
+  description:
+    'Updates dialtone 7 variables to dialtone 8 design tokens.\n' +
+    '- Replaces var(--bs-{kind}) with var(--dt-shadow-{kind})\n\t' +
+      'eg. var(--bs-sm) with var(--dt-shadow-small)\n' +
+    '- Replaces @bs-{kind} with var(--dt-shadow-{kind})\n\t' +
+      'eg. @bs-card with var(--dt-shadow-card)\n',
+  patterns: ['**/*.{css,less,scss,sass,styl,html,vue,md}'],
+  expressions: [
+    // CSS variables
+    { from: /@bs-sm|var\(--bs-sm\)/gi, to: 'var(--dt-shadow-small)' },
+    { from: /@bs-md|var\(--bs-md\)/gi, to: 'var(--dt-shadow-medium)' },
+    { from: /@bs-lg|var\(--bs-lg\)/gi, to: 'var(--dt-shadow-large)' },
+    { from: /@bs-xl|var\(--bs-xl\)/gi, to: 'var(--dt-shadow-extra-large)' },
+    { from: /@bs-card|var\(--bs-card\)/gi, to: 'var(--dt-shadow-card)' },
+    { from: /@bs-focus-ring|var\(--bs-focus-ring\)/gi, to: 'var(--dt-shadow-focus)' },
+    { from: /@bs-focus-ring-inset|var\(--bs-focus-ring-inset\)/gi, to: 'var(--dt-shadow-focus-inset)' },
+  ],
+};

package/dist/js/dialtone_migration_helper/configs/colors.mjs

@@ -0,0 +1,69 @@
+export default {
+    description:
+        'Updates dialtone 7 variables to dialtone 8 design tokens.\n' +
+        '- Replaces var(--{color}-{stop}) with var(--dt-color-{color}-{stop})\n\t' +
+            'eg. var(--black-200) with var(--dt-color-black-200)\n' +
+        '- Replaces @{color}-{stop} with var(--dt-color-{color}-{stop})\n\t' +
+            'eg. @red-100 with var(--dt-color-red-100)\n' +
+        '- Replaces var(--fc-{kind}) with var(--dt-color-foreground-{kind})\n\t' +
+            'eg. var(--fc-success-inverted) with var(--dt-color-foreground-success-inverted)\n',
+    patterns: ['**/*.{css,less,scss,sass,styl,html,vue,md}'],
+    expressions: [
+        // ------------------------------------------------------------ //
+        //                            Colors                            //
+        // ------------------------------------------------------------ //
+        // LESS variables
+        {
+            from: /@(black|purple|magenta|gold|green|red|blue|tan)(-[1-9]00)/g,
+            to: 'var(--dt-color-$1$2)',
+        },
+        // Neutral LESS variables
+        {
+            from: /@(white|black)/g,
+            to: 'var(--dt-color-neutral-$1)',
+        },
+        // CSS variables
+        {
+            from: /var\(--(black|purple|orange|magenta|gold|green|red|blue|tan)(-[1-9]00)(-(h|s|l|hsl))?\)/g,
+            to: 'var(--dt-color-$1$2$3)',
+        },
+        // Neutral CSS variables
+        {
+            from: /var\(--(white|black)(-(h|s|l|hsl))?\)/g,
+            to: 'var(--dt-color-neutral-$1$2)',
+        },
+        // Background colors
+        {
+            // eslint-disable-next-line max-len
+            from: /var\(--bgc-(primary|secondary|moderate|bold|strong|contrast|critical|success|warning|info)(-(subtle|opaque|subtle-opaque|strong))?\)/g,
+            to: 'var(--dt-color-surface-$1$2)',
+        },
+        // Special Background color cases
+        {
+            // eslint-disable-next-line max-len
+            from: /var\(--bgc-(error|danger)(-(subtle|opaque|subtle-opaque|strong))?\)/g,
+            to: 'var(--dt-color-surface-critical$2)',
+        },
+        // Border colors
+        {
+            // eslint-disable-next-line max-len
+            from: /var\(--bc-(default|subtle|moderate|bold|focus|critical|success|warning|brand|ai|accent)(-(inverted|subtle|strong|subtle-inverted|strong-inverted))?\)/g,
+            to: 'var(--dt-color-border-$1$2)',
+        },
+        // Font colors
+        {
+            // eslint-disable-next-line max-len
+            from: /var\(--fc-(primary|secondary|tertiary|muted|placeholder|disabled|critical|success|warning)(-(strong|inverted|strong-inverted))?\)/g,
+            to: 'var(--dt-color-foreground-$1$2)',
+        },
+        // Special Font color cases
+        {
+            from: /var\(--fc-(error|danger)(-(strong|inverted|strong-inverted))?\)/g,
+            to: 'var(--dt-color-foreground-critical$2)',
+        },
+        {
+            from: /d-(fc|bc)-white/g,
+            to: 'd-$1-neutral-white',
+        },
+    ],
+};

package/dist/js/dialtone_migration_helper/configs/fonts.mjs

@@ -0,0 +1,49 @@
+export default {
+  description:
+    'Updates dialtone 7 variables to dialtone 8 design tokens.\n' +
+    '- Replaces var(--fs-{stop}) with var(--dt-font-size-{stop})\n\t' +
+      'eg. var(--fs-200) with var(--dt-font-size-200)\n' +
+    '- Replaces @fs-{stop} with var(--dt-font-size-{stop})\n\t' +
+      'eg. @fs-100-tv with var(--dt-font-size-100-tv)\n' +
+    '- Replaces var(--fw-{kind}) with var(--dt-font-weight-{kind})\n\t' +
+      'eg. var(--fw-medium) with var(--dt-font-weight-medium)\n' +
+    '- Replaces @fw-{kind} with var(--dt-font-weight-{kind})\n\t' +
+      'eg. @fw-semibold with var(--dt-font-weight-semi-bold)\n' +
+    '- Replaces var(--lh-{stop}) with var(--dt-font-line-height-{stop})\n\t' +
+      'eg. var(--lh-200) with var(--dt-font-line-height-200)\n' +
+    '- Replaces @lh-{stop} with var(--dt-font-line-height-{stop})\n\t' +
+      'eg. @lh-100 with var(--dt-font-line-height-100)\n' +
+    '- Replaces var(--ff-{kind}) with var(--dt-font-family-{kind})\n\t' +
+      'eg. var(--ff-mono) with var(--dt-font-family-mono)',
+  patterns: ['**/*.{css,less,scss,sass,styl,html,vue,md,json}'],
+  expressions: [
+    // ------------------------------------------------------------ //
+    //                            Fonts                             //
+    // ------------------------------------------------------------ //
+    // Size variables
+    {
+      from: /@fs(-[0-9]+)(-(mobile|tc8|tv))?|var\(--fs(-[0-9]+)(-(mobile|tc8|tv))?\)/g,
+      to: 'var(--dt-font-size$1$2$4$5)',
+    },
+    // Weight variables
+    {
+      from: /@fw-(normal|medium|bold)|var\(--fw-(normal|medium|bold)\)/g,
+      to: 'var(--dt-font-weight-$1$2)',
+    },
+    // Special weight case
+    {
+      from: /@fw-semibold|var\(--fw-semibold\)/g,
+      to: 'var(--dt-font-weight-semi-bold)',
+    },
+      // Line heights
+    {
+      from: /@lh(-[0-9]+)|var\(--lh(-[0-9]+)\)/g,
+      to: 'var(--dt-font-line-height$1$2)',
+    },
+    // Font family
+    {
+      from: /var\(--ff-(mono)\)/g,
+      to: 'var(--dt-font-family-$1)',
+    },
+  ],
+};

package/dist/js/dialtone_migration_helper/configs/size-and-space.mjs

@@ -0,0 +1,124 @@
+export default {
+  description:
+    'Updates dialtone 7 variables to dialtone 8 design tokens.\n' +
+    '- Replaces var(--{size}-{stop}) with var(--dt-size-{stop})\n\t' +
+      'eg. var(--size-200) with var(--dt-size-200)\n' +
+    '- Replaces @{size}{stop} with var(--dt-size-{stop})\n\t' +
+      'eg. @size4 with var(--dt-size-300)\n' +
+    '- Replaces @icon{size} with var(--dt-icon-size-{stop})\n\t' +
+      'eg. @icon12 with var(--dt-icon-size-100)\n' +
+    '- Replaces var(--su{stop}) with var(--dt-size-{stop})\n\t' +
+      'eg. var(--su0) with var(--dt-size-0)\n' +
+    '- Replaces @su{stop} with var(--dt-size-{stop})\n\t' +
+      'eg. @su8 with var(--dt-size-400)\n' +
+    '- Replaces var(--sun{stop}) with var(--dt-size-{stop}-negative)\n\t' +
+      'eg. var(--sun1) with var(--dt-size-100-negative)\n' +
+    '- Replaces var(--br{stop}) with var(--dt-size-radius-{stop})\n\t' +
+      'eg. var(--br4) with var(--dt-size-radius-300)\n' +
+    '- Replaces @br{stop} with var(--dt-size-radius-{stop})\n\t' +
+      'eg. @br-pill with var(--dt-size-radius-pill)\n',
+  patterns: ['**/*.{css,less,scss,sass,styl,html,vue,md}'],
+  expressions: [
+    // ------------------------------------------------------------ //
+    //                        Size and Space                        //
+    // ------------------------------------------------------------ //
+    {
+      from: /var\(--(size|space)(-[0-9]+)(-negative)?\)/gi,
+      to: 'var(--dt-$1$2$3)',
+    },
+
+    // Size LESS variables
+    { from: /@size0\b|var\(--size0\)/g, to: 'var(--dt-size-0)' },
+    { from: /@size1\b|var\(--size1\)/g, to: 'var(--dt-size-100)' },
+    { from: /@size2\b|var\(--size2\)/g, to: 'var(--dt-size-200)' },
+    { from: /@size4\b|var\(--size4\)/g, to: 'var(--dt-size-300)' },
+    { from: /@size6\b|var\(--size6\)/g, to: 'var(--dt-size-350)' },
+    { from: /@size8\b|var\(--size8\)/g, to: 'var(--dt-size-400)' },
+    { from: /@size12\b|var\(--size12\)/g, to: 'var(--dt-size-450)' },
+    { from: /@size16\b|var\(--size16\)/g, to: 'var(--dt-size-500)' },
+    { from: /@size20\b|var\(--size20\)/g, to: 'var(--dt-size-525)' },
+    { from: /@size24\b|var\(--size24\)/g, to: 'var(--dt-size-550)' },
+    { from: /@size32\b|var\(--size32\)/g, to: 'var(--dt-size-600)' },
+    { from: /@size42\b|var\(--size42\)/g, to: 'var(--dt-size-625)' },
+    { from: /@size48\b|var\(--size48\)/g, to: 'var(--dt-size-650)' },
+    { from: /@size64\b|var\(--size64\)/g, to: 'var(--dt-size-700)' },
+    { from: /@size72\b|var\(--size72\)/g, to: 'var(--dt-size-720)' },
+    { from: /@size84\b|var\(--size84\)/g, to: 'var(--dt-size-730)' },
+    { from: /@size96\b|var\(--size96\)/g, to: 'var(--dt-size-750)' },
+    { from: /@size102\b|var\(--size102\)/g, to: 'var(--dt-size-760)' },
+    { from: /@size114\b|var\(--size114\)/g, to: 'var(--dt-size-775)' },
+    { from: /@size128\b|var\(--size128\)/g, to: 'var(--dt-size-800)' },
+    { from: /@size164\b|var\(--size164\)/g, to: 'var(--dt-size-825)' },
+    { from: /@size216\b|var\(--size216\)/g, to: 'var(--dt-size-875)' },
+    { from: /@size264\b|var\(--size264\)/g, to: 'var(--dt-size-905)' },
+    { from: /@size332\b|var\(--size332\)/g, to: 'var(--dt-size-925)' },
+    { from: /@size464\b|var\(--size464\)/g, to: 'var(--dt-size-975)' },
+    { from: /@size512\b|var\(--size512\)/g, to: 'var(--dt-size-1000)' },
+    { from: /@size628\b|var\(--size628\)/g, to: 'var(--dt-size-1020)' },
+    { from: /@size764\b|var\(--size764\)/g, to: 'var(--dt-size-1040)' },
+    { from: /@size828\b|var\(--size828\)/g, to: 'var(--dt-size-1060)' },
+    { from: /@size912\b|var\(--size912\)/g, to: 'var(--dt-size-1080)' },
+    { from: /@size1024\b|var\(--size1024\)/g, to: 'var(--dt-size-1100)' },
+    { from: /@size1140\b|var\(--size1140\)/g, to: 'var(--dt-size-1115)' },
+    { from: /@size1268\b|var\(--size1268\)/g, to: 'var(--dt-size-1120)' },
+    { from: /@size1340\b|var\(--size1340\)/g, to: 'var(--dt-size-1130)' },
+
+    // Icon variables
+    { from: /@icon12\b|var\(--icon12\)/g, to: 'var(--dt-icon-size-100)' },
+    { from: /@icon14\b|var\(--icon14\)/g, to: 'var(--dt-icon-size-200)' },
+    { from: /@icon16\b|var\(--icon16\)/g, to: 'var(--dt-size-500)' },
+    { from: /@icon18\b|var\(--icon18\)/g, to: 'var(--dt-icon-size-300)' },
+    { from: /@icon20\b|var\(--icon20\)/g, to: 'var(--dt-icon-size-400)' },
+    { from: /@icon24\b|var\(--icon24\)/g, to: 'var(--dt-icon-size-500)' },
+    { from: /@icon32\b|var\(--icon32\)/g, to: 'var(--dt-icon-size-600)' },
+    { from: /@icon48\b|var\(--icon48\)/g, to: 'var(--dt-size-650)' },
+    { from: /@icon64\b|var\(--icon64\)/g, to: 'var(--dt-size-700)' },
+    // Variable prefixed with negative, must go before positive spacing
+    { from: /-@su1\b|-var\(--su1\)|[^-]var\(--sun1\)/g, to: 'var(--dt-space-100-negative)' },
+    { from: /-@su2\b|-var\(--su2\)|[^-]var\(--sun2\)/g, to: 'var(--dt-space-200-negative)' },
+    { from: /-@su4\b|-var\(--su4\)|[^-]var\(--sun4\)/g, to: 'var(--dt-space-300-negative)' },
+    { from: /-@su6\b|-var\(--su6\)|[^-]var\(--sun6\)/g, to: 'var(--dt-space-350-negative)' },
+    { from: /-@su8\b|-var\(--su8\)|[^-]var\(--sun8\)/g, to: 'var(--dt-space-400-negative)' },
+    { from: /-@su12\b|-var\(--su12\)|[^-]var\(--sun12\)/g, to: 'var(--dt-space-450-negative)' },
+    { from: /-@su16\b|-var\(--su16\)|[^-]var\(--sun16\)/g, to: 'var(--dt-space-500-negative)' },
+    { from: /-@su24\b|-var\(--su24\)|[^-]var\(--sun24\)/g, to: 'var(--dt-space-550-negative)' },
+    { from: /-@su32\b|-var\(--su32\)|[^-]var\(--sun32\)/g, to: 'var(--dt-space-600-negative)' },
+    { from: /-@su48\b|-var\(--su48\)|[^-]var\(--sun48\)/g, to: 'var(--dt-space-650-negative)' },
+    { from: /-@su64\b|-var\(--su64\)|[^-]var\(--sun64\)/g, to: 'var(--dt-space-700-negative)' },
+    { from: /-@su72\b|-var\(--su72\)|[^-]var\(--sun72\)/g, to: 'var(--dt-space-720-negative)' },
+    { from: /-@su84\b|-var\(--su84\)|[^-]var\(--sun84\)/g, to: 'var(--dt-space-730-negative)' },
+    { from: /-@su96\b|-var\(--su96\)|[^-]var\(--sun96\)/g, to: 'var(--dt-space-750-negative)' },
+    { from: /-@su102\b|-var\(--su102\)|[^-]var\(--sun102\)/g, to: 'var(--dt-space-760-negative)' },
+    { from: /-@su114\b|-var\(--su114\)|[^-]var\(--sun114\)/g, to: 'var(--dt-space-775-negative)' },
+    { from: /-@su128\b|-var\(--su128\)|[^-]var\(--sun128\)/g, to: 'var(--dt-space-800-negative)' },
+    // Positive spacing
+    { from: /@su0\b|var\(--su0\)/g, to: 'var(--dt-space-0)' },
+    { from: /@su1\b|var\(--su1\)/g, to: 'var(--dt-space-100)' },
+    { from: /@su2\b|var\(--su2\)/g, to: 'var(--dt-space-200)' },
+    { from: /@su4\b|var\(--su4\)/g, to: 'var(--dt-space-300)' },
+    { from: /@su6\b|var\(--su6\)/g, to: 'var(--dt-space-350)' },
+    { from: /@su8\b|var\(--su8\)/g, to: 'var(--dt-space-400)' },
+    { from: /@su12\b|var\(--su12\)/g, to: 'var(--dt-space-450)' },
+    { from: /@su16\b|var\(--su16\)/g, to: 'var(--dt-space-500)' },
+    { from: /@su24\b|var\(--su24\)/g, to: 'var(--dt-space-550)' },
+    { from: /@su32\b|var\(--su32\)/g, to: 'var(--dt-space-600)' },
+    { from: /@su48\b|var\(--su48\)/g, to: 'var(--dt-space-650)' },
+    { from: /@su64\b|var\(--su64\)/g, to: 'var(--dt-space-700)' },
+    { from: /@su72\b|var\(--su72\)/g, to: 'var(--dt-space-720)' },
+    { from: /@su84\b|var\(--su84\)/g, to: 'var(--dt-space-730)' },
+    { from: /@su96\b|var\(--su96\)/g, to: 'var(--dt-space-750)' },
+    { from: /@su102\b|var\(--su102\)/g, to: 'var(--dt-space-760)' },
+    { from: /@su114\b|var\(--su114\)/g, to: 'var(--dt-space-775)' },
+    { from: /@su128\b|var\(--su128\)/g, to: 'var(--dt-space-800)' },
+    // Border radius
+    { from: /@br-(pill|circle)|var\(--br-(pill|circle)\)/g, to: 'var(--dt-size-radius-$1$2)' },
+    { from: /@br0|var\(--br0\)/g, to: 'var(--dt-size-radius-0)' },
+    { from: /@br2\b|var\(--br2\)/g, to: 'var(--dt-size-radius-200)' },
+    { from: /@br4|var\(--br4\)/g, to: 'var(--dt-size-radius-300)' },
+    { from: /@br8|var\(--br8\)/g, to: 'var(--dt-size-radius-400)' },
+    { from: /@br12|var\(--br12\)/g, to: 'var(--dt-size-450)' },
+    { from: /@br16|var\(--br16\)/g, to: 'var(--dt-size-radius-500)' },
+    { from: /@br24|var\(--br24\)/g, to: 'var(--dt-size-550)' },
+    { from: /@br32|var\(--br32\)/g, to: 'var(--dt-size-radius-600)' },
+  ],
+};

package/dist/js/dialtone_migration_helper/helpers.mjs

@@ -0,0 +1,212 @@
+import chalk from 'chalk';
+import { globby } from 'globby';
+import inquirer from 'inquirer';
+import path from 'path';
+import fs from 'fs';
+const { readdir, readFile, writeFile } = 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) => {
+  const 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;
+      });
+
+    return filtered.reduce((prev, current) => {
+      const fn = path.relative(config.globbyConfig.cwd, current.file);
+      return [...prev, fn];
+    }, []);
+  });
+};
+
+// 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, 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.replace(/-/g, ' ').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,
+};

package/dist/js/dialtone_migration_helper/index.mjs

@@ -0,0 +1,135 @@
+#!/usr/bin/env node
+
+import chalk from 'chalk';
+import {
+  confirmStart,
+  doPatternSearch,
+  error,
+  findMatchedFiles,
+  getConfigFileList,
+  getAllFileContents,
+  inquireForFile,
+  modifyFileContents,
+  readConfigFile,
+} from './helpers.mjs';
+import ora from 'ora';
+import { dirname, normalize } from 'path';
+import { fileURLToPath } from 'url';
+import { hideBin } from 'yargs/helpers';
+import yargs from 'yargs';
+
+// eslint-disable-next-line complexity
+(async () => {
+  // get command line args
+  const argv = yargs(hideBin(process.argv))
+    .scriptName('dialtone-migration-helper')
+    .usage(
+      '$0 --cwd "../root/directory" --include "file1.ext" "**/*.ext2" --ignore "**/ignored/**", "**/another_ignored/**"',
+    )
+    .options({
+      cwd: {
+        type: 'string',
+        description: 'Root directory for scan. Defaults to CWD.',
+        default: process.cwd(),
+      },
+      include: {
+        type: 'array',
+        description: 'Glob patters to include during search, if omitted, will include all the files on the CWD.',
+      },
+      ignore: {
+        type: 'array',
+        description: 'Other glob patterns to ignore during search. .gitignore included by default.',
+      },
+      force: {
+        boolean: true,
+        description: 'Skip interactive prompts, use caution!',
+        default: false,
+      },
+    })
+    .help().argv;
+
+  // get list of configuration files
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = dirname(__filename);
+  const CONFIG_FOLDER = __dirname + '/configs';
+  const configList = await getConfigFileList(CONFIG_FOLDER).catch((err) =>
+    error('getConfigFileList: ' + err),
+  );
+
+  // load configuration from arg or list
+  const [configData, configFile] = await inquireForFile(CONFIG_FOLDER, configList)
+      .catch((err) =>
+        error('inquireForFile: ' + err),
+      );
+
+  // set up some globby defaults
+  configData.globbyConfig = configData.globbyConfig || {};
+  configData.globbyConfig.gitignore = configData.globbyConfig.gitignore || true;
+
+  console.log(
+    `\n${chalk.green('++')} Configuration Loaded! (${configFile}) ${chalk.green('++')}\n`,
+  );
+
+  // take CWD if specified from command line
+  const cwd = !argv.cwd ? process.cwd() : normalize(argv.cwd);
+  configData.globbyConfig.cwd = configData.globbyConfig.cwd || cwd;
+  // push include list to configuration array
+  if (argv.include) {
+    configData.patterns = argv.include;
+  }
+  // push ignore list to configuration array
+  if (argv.ignore) {
+    configData.globbyConfig.ignore = argv.ignore;
+  }
+
+  // run glob search with configData.patterns
+  const globSpinner = ora('Performing pattern search').start();
+  const files = await doPatternSearch(configData).then((f) => {
+    return findMatchedFiles(f, configData);
+  });
+  if (files.length <= 0) {
+    console.log(
+      '\n' +
+        chalk.cyan('??') +
+        ' No matches found! Check your patterns and cwd settings if you think this is an error ' +
+        `patterns: [${configData.patterns}] | cwd: [${configData.globbyConfig.cwd}] `,
+    );
+    process.exit(0);
+  }
+
+  globSpinner.stop();
+  console.log(`[ ${chalk.whiteBright(files.length)} ] files queued for modification:\n`);
+  console.log(files);
+  console.log(
+    `\n${chalk.yellow('Configuration Description')}${chalk.gray(':')}\n${configData.description}\n`,
+  );
+
+  // kick off file search and replace
+  const startModification = () => {
+    console.log(`\n${chalk.blue('__')} Starting ...`);
+
+    getAllFileContents(files, configData.globbyConfig.cwd)
+      .then((content) => {
+        modifyFileContents(content, configData.expressions).then(() => {
+          console.log(`${chalk.magenta('==')} Modification complete!\n`);
+        });
+      })
+      .catch((err) => error('getAllFileContents: ' + err));
+  };
+
+  // begin file modification based on configuration rules
+  // start automatically if --force is specified
+  if (!argv.force) {
+    confirmStart()
+      .then((val) => {
+        if (val) {
+          startModification();
+        } else {
+          console.log(`\n${chalk.red('__')} Cancelling ...\n`);
+        }
+      })
+      .catch((err) => error('confirmStart ' + err));
+  } else {
+    startModification();
+  }
+})();