@elliemae/ds-codemods 2.0.0-alpha.1 → 2.0.0-alpha.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.13",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "module": "./esm/index.js",
@@ -31,11 +31,14 @@
   },
   "dependencies": {
     "arg": "^5.0.1",
+    "chalk": "4.1.2",
+    "depcheck": "1.4.2",
     "esm": "^3.2.25",
     "fs": "0.0.1-security",
-    "fs-extra": "^9.1.0",
-    "glob": "^7.1.7",
-    "inquirer": "^8.0.1",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.2.0",
+    "inquirer": "^8.2.0",
+    "pacote": "12.0.2",
     "path": "^0.12.7"
   },
   "publishConfig": {

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

@@ -7,6 +7,9 @@ function parseArgumentsIntoOptions(rawArgs) {
     {
       '--globPattern': String,
       '--globPatternIgnore': String,
+      '--projectFolderPath': String,
+      '--ignorePackagesGlobPattern': String,
+      '--ignoreFilesGlobPattern': String,
     },
     {
       argv: rawArgs.slice(2),
@@ -15,6 +18,9 @@ function parseArgumentsIntoOptions(rawArgs) {
   return {
     globPattern: args['--globPattern'],
     globPatternIgnore: args['--globPatternIgnore'],
+    projectFolderPath: args['--projectFolderPath'],
+    ignorePackagesGlobPattern: args['--ignorePackagesGlobPattern'],
+    ignoreFilesGlobPattern: args['--ignoreFilesGlobPattern'],
     script: args._[0],
   };
 }

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

@@ -1,6 +1,7 @@
 export const getPackagesInconsistenciesQuestions = (originalOptions) => {
   const extraOptions = [];
-  if (!originalOptions.globPattern) {
+  const { globPattern, globPatternIgnore } = originalOptions;
+  if (!globPattern && globPattern !== '') {
     extraOptions.push({
       type: 'input',
       name: 'globPattern',
@@ -9,7 +10,7 @@ export const getPackagesInconsistenciesQuestions = (originalOptions) => {
       default: './package.json', // './packages/ds-codemods/test-ables/check-packages-inconsistencies/package.json.test',
     });
   }
-  if (!originalOptions.globPatternIgnore) {
+  if (!globPatternIgnore && globPatternIgnore !== '') {
     extraOptions.push({
       type: 'input',
       name: 'globPatternIgnore',

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

@@ -1,6 +1,7 @@
 export const getLegacyImportsQuestions = (originalOptions) => {
   const extraOptions = [];
-  if (!originalOptions.globPattern) {
+  const { globPattern, globPatternIgnore } = originalOptions;
+  if (!globPattern && globPattern !== '') {
     extraOptions.push({
       type: 'input',
       name: 'globPattern',
@@ -8,7 +9,7 @@ export const getLegacyImportsQuestions = (originalOptions) => {
       default: './**/*.js,./**/*.jsx,./**/*.ts,./**/*.tsx',
     });
   }
-  if (!originalOptions.globPatternIgnore) {
+  if (!globPatternIgnore && globPatternIgnore !== '') {
     extraOptions.push({
       type: 'input',
       name: 'globPatternIgnore',

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

@@ -0,0 +1,29 @@
+export const getMissingPackagesQuestions = (originalOptions) => {
+  const extraOptions = [];
+  const { projectFolderPath, ignorePackagesGlobPattern, ignoreFilesGlobPattern } = originalOptions;
+  if (!projectFolderPath && projectFolderPath !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'projectFolderPath',
+      message: 'path to the project folder containing package.json file',
+      default: './',
+    });
+  }
+  if (!ignorePackagesGlobPattern && ignorePackagesGlobPattern !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'ignorePackagesGlobPattern',
+      message: 'Please provide a comma separated list of globPatterns for ignored packages, if any.',
+      default: '',
+    });
+  }
+  if (!ignoreFilesGlobPattern && ignoreFilesGlobPattern !== '') {
+    extraOptions.push({
+      type: 'input',
+      name: 'ignoreFilesGlobPattern',
+      message: 'Please provide a comma separated list of globPatterns for ignored files, if any.',
+      default: '**/*.eslintrc.js',
+    });
+  }
+  return extraOptions;
+};

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

@@ -0,0 +1,82 @@
+/* eslint-disable no-console */
+import depcheck from 'depcheck';
+import chalk from 'chalk';
+import { generatePathFromCurrentFolder } from '../../../utils';
+
+const logUnusedDep = (unused) => {
+  console.log(chalk.yellowBright('### Found unused dependencies :>>'));
+  console.log('```');
+  console.log(unused.dependencies);
+  console.log('```');
+};
+const logUnusedDevDep = (unused) => {
+  console.log(chalk.magentaBright('### Found unused dev dependencies :>>'));
+  console.log('```');
+  console.log(unused.devDependencies);
+  console.log('```');
+};
+const logMissing = (unused) => {
+  const missingString = [...Object.keys(unused.missing)].map((pack) => `\t${pack}`).join(',\n');
+  console.log(chalk.redBright('### Found missing dependencies :>>'));
+  console.log('```');
+  console.log('{');
+  console.log(missingString);
+  console.log('}');
+  console.log('```');
+};
+
+export const checkMissingPackages = async (options) => {
+  const { projectFolderPath, ignorePackagesGlobPattern, ignoreFilesGlobPattern } = options;
+  const ignorePatterns = ignorePackagesGlobPattern
+    .split(',')
+    .map((pattern) => (pattern && pattern !== '' ? generatePathFromCurrentFolder(pattern) : ''));
+  const ignoreMatches = ignoreFilesGlobPattern
+    .split(',')
+    .map((pattern) => (pattern && pattern !== '' ? generatePathFromCurrentFolder(pattern) : ''));
+  const depCheckOptions = {
+    ignoreBinPackage: false, // ignore the packages with bin entry
+    skipMissing: false, // skip calculation of missing dependencies
+    parsers: {
+      // the target parsers
+      '**/*.js': depcheck.parser.jsx,
+      '**/*.jsx': depcheck.parser.jsx,
+      '**/*.ts': depcheck.parser.typescript,
+      '**/*.tsx': depcheck.parser.typescript,
+    },
+    detectors: [
+      depcheck.detector.requireCallExpression,
+      depcheck.detector.requireResolveCallExpression,
+      depcheck.detector.importDeclaration,
+      depcheck.detector.typescriptImportType,
+      depcheck.detector.exportDeclaration,
+    ],
+    specials: [
+      // the target special parsers
+      depcheck.special.babel,
+      depcheck.special.bin,
+      depcheck.special.eslint,
+      depcheck.special.husky,
+      depcheck.special.jest,
+      depcheck.special.mocha,
+      depcheck.special.prettier,
+      depcheck.special.tslint,
+      depcheck.special.webpack,
+    ],
+    ignorePatterns,
+    ignoreMatches,
+  };
+  const pathToRoot = generatePathFromCurrentFolder(projectFolderPath);
+
+  depcheck(pathToRoot, depCheckOptions).then((unused) => {
+    const unusedDep = Array.isArray(unused.dependencies) && unused.dependencies.length > 0;
+    const unusedDevDep = Array.isArray(unused.devDependencies) && unused.devDependencies.length > 0;
+    const missing = Object.keys(unused.missing).length > 0;
+    const hasErrors = unusedDep || unusedDevDep || missing;
+    console.log(chalk.bold.cyanBright(`# Dependencies results for ${pathToRoot}`));
+    console.log(chalk.bold.cyanBright(`[${pathToRoot}](${pathToRoot}package.json)`));
+    if (unusedDep) logUnusedDep(unused);
+    if (unusedDevDep) logUnusedDevDep(unused);
+    if (missing) logMissing(unused);
+    if (!hasErrors) console.log(chalk.bold.green(`no problems found!`));
+  });
+};

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

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

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

@@ -2,6 +2,7 @@ export const COMMANDS = {
   FIX_LEGACY_IMPORTS: 'fix-legacy-imports',
   FIX_LEGACY_IMPORTS_REVERT: 'fix-legacy-imports:revert',
   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 { getMissingPackagesQuestions } from './command-arguments/promptMissingPackages';
 
 async function promptForMissingScriptSpecificOptions({ originalOptions, promptOptions }) {
   const script = originalOptions.script || promptOptions.script;
@@ -14,6 +15,9 @@ async function promptForMissingScriptSpecificOptions({ originalOptions, promptOp
     case COMMANDS.CHECK_PACKAGES_INCONSISTENCIES:
       scriptQuestions.push(...getPackagesInconsistenciesQuestions(originalOptions));
       break;
+    case COMMANDS.CHECK_MISSING_PACKAGES:
+      scriptQuestions.push(...getMissingPackagesQuestions(originalOptions));
+      break;
     default:
       break;
   }

package/tsconfig.json

@@ -5,6 +5,6 @@
     "declarationDir": "dist/types",
     "baseUrl": "src"
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules"]
+  "include": ["src", "../../shared/typings"],
+  "exclude": ["node_modules", "dist/types"]
 }