@elliemae/ds-codemods 2.3.3-rc.0 → 2.4.0-next.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "2.3.3-rc.0",
+  "version": "2.4.0-next.0",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "module": "./esm/index.js",
@@ -27,23 +27,23 @@
     "prebuild": "exit 0",
     "predev": "exit 0",
     "build": "exit 0",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "try-codemods": "npx ./",
+    "try-check-deprecated-packages": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/with-deprecated\"",
+    "try-check-deprecated-packages-no-dimsum": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/without-dimsum-packages\""
   },
   "dependencies": {
     "arg": "^5.0.1",
-    "chalk": "5.0.0",
-    "depcheck": "1.4.3",
+    "chalk": "4.1.2",
+    "depcheck": "1.4.2",
     "esm": "^3.2.25",
     "fs": "0.0.1-security",
     "fs-extra": "^10.0.0",
     "glob": "^7.2.0",
     "inquirer": "^8.2.0",
-    "pacote": "12.0.3",
+    "pacote": "12.0.2",
     "path": "^0.12.7"
   },
-  "resolutions": {
-    "depcheck/@babel/parser": "7.16.4"
-  },
   "publishConfig": {
     "access": "public"
   },

package/src/cli/code-mods/cli.js

@@ -5,6 +5,7 @@ import { executeCommandsMap } from './command-logics/execute-commands-map';
 function parseArgumentsIntoOptions(rawArgs) {
   const args = arg(
     {
+      '--cwd': String,
       '--globPattern': String,
       '--globPatternIgnore': String,
       '--projectFolderPath': String,
@@ -16,6 +17,7 @@ function parseArgumentsIntoOptions(rawArgs) {
     },
   );
   return {
+    cwd: args['--cwd'],
     globPattern: args['--globPattern'],
     globPatternIgnore: args['--globPatternIgnore'],
     projectFolderPath: args['--projectFolderPath'],

package/src/cli/code-mods/command-arguments/promptDeprecatedPackages.js

@@ -0,0 +1,13 @@
+export const getDeprecatedPackagesQuestions = (originalOptions) => {
+  const extraOptions = [];
+  const { cwd } = originalOptions;
+  if (!cwd && cwd !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'globPatternIgnore',
+      message: 'Please provide the project root directory (where node_modules folder lives)',
+      default: './',
+    });
+  }
+  return extraOptions;
+};

package/src/cli/code-mods/command-logics/check-deprecated-packages/constants.js

@@ -0,0 +1,87 @@
+export const SEVERITY = {
+  NON_STARTER: ['Failing to upgrade will make the project impossible to start/use', 1],
+  KNOWN_ISSUES: [
+    'The component has unfixable known issues. Failing to upgrade means APP will have to live with those',
+    2,
+  ],
+  FRAGILE_AND_UNMANTAINED: [
+    'Failing to upgrade will make the project fragile and any error will have to be addressed by the APP team',
+    3,
+  ],
+  UNMANTAINED: ['Failing to upgrade will mean that any error will have to be addressed by the APP team', 4],
+};
+
+export const SOLUTIONS = {
+  REMOVED: 'the component has been regarded as supreflous and has hencheforth been removed in favor of examples',
+  NEW_VERSION_BREAKING: 'the component impedes further enhancments/bugfixes, a new version ex-novo has been created.',
+};
+
+export const DEPRECATED_PACKAGES = {
+  '@elliemae/ds-datagrids': {
+    name: 'data-grid',
+    solution: SOLUTIONS.NEW_VERSION_BREAKING,
+    severity: SEVERITY.KNOWN_ISSUES,
+    // TODO create relative confluence
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Breaking+changes+-+Migration+steps+and+rationale',
+  },
+  '@elliemae/ds-date-picker': {
+    name: 'date-picker',
+    solution: SOLUTIONS.NEW_VERSION_BREAKING,
+    severity: SEVERITY.KNOWN_ISSUES,
+    // TODO create relative confluence
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Breaking+changes+-+Migration+steps+and+rationale',
+  },
+  '@elliemae/ds-date-range-picker': {
+    name: 'date-range-picker',
+    solution: SOLUTIONS.NEW_VERSION_BREAKING,
+    severity: SEVERITY.KNOWN_ISSUES,
+    // TODO create relative confluence
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Breaking+changes+-+Migration+steps+and+rationale',
+  },
+  '@elliemae/ds-date-time-picker': {
+    name: 'date-time-picker',
+    solution: SOLUTIONS.NEW_VERSION_BREAKING,
+    severity: SEVERITY.KNOWN_ISSUES,
+    // TODO create relative confluence
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Breaking+changes+-+Migration+steps+and+rationale',
+  },
+  '@elliemae/ds-time-picker': {
+    name: 'time-picker',
+    solution: SOLUTIONS.NEW_VERSION_BREAKING,
+    severity: SEVERITY.KNOWN_ISSUES,
+    // TODO create relative confluence
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Breaking+changes+-+Migration+steps+and+rationale',
+  },
+  '@elliemae/ds-button-group': {
+    name: 'button-group',
+    solution: SOLUTIONS.REMOVED,
+    severity: SEVERITY.NON_STARTER,
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Button+Group+-+Dimsum+2.x',
+  },
+  '@elliemae/ds-card-array': {
+    name: 'card-array',
+    solution: SOLUTIONS.REMOVED,
+    severity: SEVERITY.NON_STARTER,
+    confluence: 'https://confluence.elliemae.io/display/FEAE/Card+Array+-+Dimsum+2.x',
+  },
+  '@elliemae/ds-form': {
+    subComponents: [
+      {
+        name: 'combobox',
+        solution: SOLUTIONS.NEW_VERSION_BREAKING,
+        severity: SEVERITY.FRAGILE_AND_UNMANTAINED,
+        confluence: 'https://confluence.elliemae.io/display/FEAE/Combo-box+-+Dimsum+2.x',
+      },
+    ],
+  },
+  '@elliemae/ds-combox-v1': {
+    subComponents: [
+      {
+        name: 'combobox',
+        solution: SOLUTIONS.NEW_VERSION_BREAKING,
+        severity: SEVERITY.FRAGILE_AND_UNMANTAINED,
+        confluence: 'https://confluence.elliemae.io/display/FEAE/Combo-box+-+Dimsum+2.x',
+      },
+    ],
+  },
+};

package/src/cli/code-mods/command-logics/check-deprecated-packages/getEmDsPackagesFromNPMLS.js

@@ -0,0 +1,18 @@
+/* eslint-disable max-statements */
+export function getEmDsPackagesFromNPMLS(npmLsStdout = '') {
+  const dsPackageRegExp = /@elliemae\/ds-.*?@(.*)/gm;
+  const matches = [];
+  if (npmLsStdout) {
+    const npmLsMatches = [...npmLsStdout.matchAll(dsPackageRegExp)];
+    npmLsMatches.forEach(([fullMatch, version]) => {
+      const matchObj = {
+        fullMatch,
+        version,
+        package: fullMatch.split(version)[0].slice(0, -1),
+      };
+      matches.push(matchObj);
+    });
+  }
+
+  return matches;
+}

package/src/cli/code-mods/command-logics/check-deprecated-packages/index.js

@@ -0,0 +1,19 @@
+import { exec } from 'child_process';
+import { getEmDsPackagesFromNPMLS } from './getEmDsPackagesFromNPMLS';
+import { logResults, logCyanQuestion } from './logResults';
+
+const npmLs = async ({ cwd }) => {
+  const [, stdout] = await new Promise((resolve) => {
+    exec('npm ls', { cwd }, (...cbRes) => resolve(cbRes));
+  });
+  if (stdout) return getEmDsPackagesFromNPMLS(stdout);
+  return [];
+};
+
+export const checkDeprecatedPackages = async (options) => {
+  const installedPackages = await npmLs(options);
+  if (installedPackages.length === 0) logCyanQuestion('no dimsum packages found... did you specify the correct cwd?');
+  logResults(installedPackages);
+};
+
+export default checkDeprecatedPackages;

package/src/cli/code-mods/command-logics/check-deprecated-packages/logResults.js

@@ -0,0 +1,70 @@
+import chalk from 'chalk';
+import { DEPRECATED_PACKAGES } from './constants';
+// Colors
+// black
+// red
+// green
+// yellow
+// blue
+// magenta
+// cyan
+// white
+// blackBright (alias: gray, grey)
+// redBright
+// greenBright
+// yellowBright
+// blueBright
+// magentaBright
+// cyanBright
+// whiteBright
+
+// Background colors
+// bgBlack
+// bgRed
+// bgGreen
+// bgYellow
+// bgBlue
+// bgMagenta
+// bgCyan
+// bgWhite
+// bgBlackBright (alias: bgGray, bgGrey)
+// bgRedBright
+// bgGreenBright
+// bgYellowBright
+// bgBlueBright
+// bgMagentaBright
+// bgCyanBright
+// bgWhiteBright
+
+const chalkMap = {
+  1: chalk.bold.yellowBright.bgRed,
+  2: chalk.bold.redBright,
+  3: chalk.bold.red,
+  4: chalk.red,
+};
+
+const logDeprecatedComponent = ({ name, solution, severity, confluence }) => {
+  const [sevDesc, sevLevel] = severity;
+  const chalkLog = chalkMap[sevLevel];
+  console.log(chalk.yellow('--------------------------------'));
+  console.log(chalk.bold.cyan(`${name} deprecation!`));
+  console.log(chalkLog(sevDesc));
+  console.log(chalk.bold.green(solution));
+  console.log(chalk.white(confluence));
+  console.log(chalk.yellow('--------------------------------'));
+};
+
+export function logCyanQuestion(question) {
+  console.log(chalk.cyanBright(question));
+}
+
+export function logResults(detectedPackages) {
+  detectedPackages.forEach((pack) => {
+    const deprecatedMetaInfo = DEPRECATED_PACKAGES[pack.package];
+    if (deprecatedMetaInfo) {
+      const { subComponents, ...metainfo } = deprecatedMetaInfo;
+      if (JSON.stringify(metainfo) !== '{}') logDeprecatedComponent(metainfo);
+      if (subComponents) subComponents.forEach(logDeprecatedComponent);
+    }
+  });
+}

package/src/cli/code-mods/command-logics/execute-commands-map.js

@@ -1,6 +1,7 @@
 import { fixLegacyImports } from './fix-legacy-imports';
 import { checkPackagesInconsistencies } from './check-packages-inconsistencies';
 import { checkMissingPackages } from './check-missing-packages';
+import { checkDeprecatedPackages } from './check-deprecated-packages';
 import { COMMANDS } from '../commands';
 
 export async function executeCommandsMap(args, options) {
@@ -17,6 +18,9 @@ export async function executeCommandsMap(args, options) {
     case COMMANDS.CHECK_MISSING_PACKAGES:
       checkMissingPackages(options);
       break;
+    case COMMANDS.CHECK_DEPRECATED_PACKAGES:
+      checkDeprecatedPackages(options);
+      break;
     default:
       break;
   }

package/src/cli/code-mods/commands.js

@@ -1,6 +1,7 @@
 export const COMMANDS = {
   FIX_LEGACY_IMPORTS: 'fix-legacy-imports',
   FIX_LEGACY_IMPORTS_REVERT: 'fix-legacy-imports:revert',
+  CHECK_DEPRECATED_PACKAGES: 'check-deprecated-packages',
   CHECK_PACKAGES_INCONSISTENCIES: 'check-packages-inconsistencies',
   CHECK_MISSING_PACKAGES: 'check-missing-packages',
   EXIT: 'exit',

package/src/cli/code-mods/inquirer-questions-prompter.js

@@ -2,6 +2,7 @@ import inquirer from 'inquirer';
 import { COMMANDS, COMMANDS_ARRAY } from './commands';
 import { getLegacyImportsQuestions } from './command-arguments/promptFixLegacyImports';
 import { getPackagesInconsistenciesQuestions } from './command-arguments/promptCheckEmPackagesInconsistencies';
+import { getDeprecatedPackagesQuestions } from './command-arguments/promptDeprecatedPackages';
 import { getMissingPackagesQuestions } from './command-arguments/promptMissingPackages';
 
 async function promptForMissingScriptSpecificOptions({ originalOptions, promptOptions }) {
@@ -18,6 +19,9 @@ async function promptForMissingScriptSpecificOptions({ originalOptions, promptOp
     case COMMANDS.CHECK_MISSING_PACKAGES:
       scriptQuestions.push(...getMissingPackagesQuestions(originalOptions));
       break;
+    case COMMANDS.CHECK_DEPRECATED_PACKAGES:
+      scriptQuestions.push(...getDeprecatedPackagesQuestions(originalOptions));
+      break;
     default:
       break;
   }

package/src/cli/utils/generatePathFromCurrentFolder.js

@@ -1,5 +1,11 @@
 import path from 'path';
-
-export const generatePathFromCurrentFolder = (...patterns) => path.join(process.cwd(), ...patterns);
+/**
+ * prepend process.cwd() to a string and convert to POSIX (glob compatible) slashes ( \ -- to --> /).
+ *
+ * @param {string} stringToPrependTo the string to prepend the CWD and make glob compatible
+ * @returns {string} paths with prepent CWD and glob compatible POSIX slashes ( \ -- to --> /).
+ */
+export const generatePathFromCurrentFolder = (...stringToPrependTo) =>
+  path.join(process.cwd(), ...stringToPrependTo).replace(/\\/g, '/');
 
 export default generatePathFromCurrentFolder;

package/test-ables/check-deprecated-packages/with-deprecated/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "some-project",
+  "version": "2.3.0-next.19",
+  "license": "MIT",
+  "description": "Ellie Mae - Dim Sum - Date Time Picker",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "sideEffects": [
+    "*.css",
+    "*.scss"
+  ],
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development && node ../../scripts/build/build.js -w",
+    "prebuild": "exit 0",
+    "predev": "exit 0",
+    "build": "node ../../scripts/build/build.js"
+  },
+  "dependencies": {
+    "@elliemae/ds-basic": "2.3.0-next.19",
+    "@elliemae/ds-classnames": "2.3.0-next.19",
+    "@elliemae/ds-date-picker": "2.3.0-next.19",
+    "@elliemae/ds-form": "2.3.0-next.19",
+    "@elliemae/ds-utilities": "2.3.0-next.19",
+    "lodash": "~4.17.19",
+    "moment": "~2.29.1",
+    "prop-types": "~15.7.2",
+    "react-dates": "~21.8.0",
+    "react-text-mask": "~5.4.3"
+  },
+  "peerDependencies": {
+    "@elliemae/ds-basic": "2.3.0-next.19",
+    "@elliemae/ds-classnames": "2.3.0-next.19",
+    "@elliemae/ds-date-picker": "2.3.0-next.19",
+    "@elliemae/ds-form": "2.3.0-next.19",
+    "@elliemae/ds-utilities": "2.3.0-next.19",
+    "lodash": "^4.17.20",
+    "react": "~17.0.1",
+    "react-dom": "^17.0.1"
+  },
+  "devDependencies": {
+    "@elliemae/ds-basic": "2.3.0-next.19",
+    "@elliemae/ds-classnames": "2.3.0-next.19",
+    "@elliemae/ds-date-picker": "2.3.0-next.19",
+    "@elliemae/ds-form": "2.3.0-next.19",
+    "@elliemae/ds-utilities": "2.3.0-next.19",
+    "lodash": "^4.17.20",
+    "react": "~17.0.1",
+    "react-dom": "^17.0.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  }
+}

package/test-ables/check-deprecated-packages/without-dimsum-packages/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "some-project",
+  "version": "2.3.0-next.19",
+  "license": "MIT",
+  "description": "Ellie Mae - Dim Sum - Date Time Picker",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "sideEffects": [
+    "*.css",
+    "*.scss"
+  ],
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development && node ../../scripts/build/build.js -w",
+    "prebuild": "exit 0",
+    "predev": "exit 0",
+    "build": "node ../../scripts/build/build.js"
+  },
+  "dependencies": {
+    "lodash": "~4.17.19",
+    "moment": "~2.29.1",
+    "prop-types": "~15.7.2",
+    "react-dates": "~21.8.0",
+    "react-text-mask": "~5.4.3"
+  },
+  "peerDependencies": {
+    "lodash": "^4.17.20",
+    "react": "~17.0.1",
+    "react-dom": "^17.0.1"
+  },
+  "devDependencies": {
+    "lodash": "^4.17.20",
+    "react": "~17.0.1",
+    "react-dom": "^17.0.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  }
+}