Merge pull request #96 from CodeshiftCommunity/validator-refactor

Validator refactor

Author: danieldelcore

.changeset/gentle-mugs-nail.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/validator': patch
+---
+
+Adds additional test coverage to the validator package

.changeset/hungry-badgers-return.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/cli': patch
+---
+
+Internal refactor, CLI now uses fetcher package

.changeset/selfish-wombats-peel.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/fetcher': patch
+---
+
+Initial release

packages/cli/package.json

@@ -15,7 +15,9 @@
     "start:dev": "ts-node src/index.ts"
   },
   "dependencies": {
+    "@codeshift/fetcher": "0.0.1",
     "@codeshift/initializer": "0.1.8",
+    "@codeshift/types": "*",
     "@codeshift/validator": "0.2.3",
     "chalk": "^4.1.0",
     "commander": "^8.2.0",

packages/cli/src/errors.ts

@@ -1 +1,2 @@
 export class InvalidUserInputError extends Error {}
+export class InvalidConfigError extends Error {}

packages/cli/src/index.ts

@@ -5,7 +5,7 @@ import main from './main';
 import list from './list';
 import init from './init';
 import validate from './validate';
-import { InvalidUserInputError } from './errors';
+import { InvalidUserInputError, InvalidConfigError } from './errors';
 
 import packageJson from '../package.json';
 
@@ -138,6 +138,11 @@ program.exitOverride();
       process.exit(9);
     }
 
+    if (error instanceof InvalidConfigError) {
+      console.warn(chalk.red(error.message));
+      process.exit(7);
+    }
+
     console.error(chalk.red(error));
     process.exit(1);
   }

packages/cli/src/main.spec.ts

@@ -1,11 +1,14 @@
+jest.mock('globby');
 jest.mock('live-plugin-manager');
 jest.mock('jscodeshift/src/Runner', () => ({
   run: jest.fn().mockImplementation(() => Promise.resolve()),
 }));
 
+import path from 'path';
 // @ts-ignore
 import * as jscodeshift from 'jscodeshift/src/Runner';
 import { PluginManager } from 'live-plugin-manager';
+import globby from 'globby';
 
 import main from './main';
 
@@ -532,28 +535,45 @@ describe('main', () => {
   });
 
   describe('when running transforms from NPM with the -p flag', () => {
+    const mockMatchedPath = path.join(
+      __dirname,
+      'path',
+      'to',
+      'codeshift.config.js',
+    );
+
     beforeEach(() => {
+      ((globby as unknown) as jest.Mock).mockImplementation(() =>
+        Promise.resolve([mockMatchedPath]),
+      );
+
       (PluginManager as jest.Mock).mockImplementation(() => ({
         install: jest.fn().mockResolvedValue(undefined),
-        require: jest.fn().mockImplementation((codemodName: string) => {
-          if (codemodName.startsWith('@codeshift')) {
-            throw new Error('Attempted to fetch codemod from community folder');
-          }
+        require: jest.fn(),
+        getInfo: jest
+          .fn()
+          .mockReturnValue({ location: path.join(__dirname, 'path', 'to') }),
+        uninstallAll: jest.fn().mockResolvedValue(undefined),
+      }));
+    });
 
-          return {
+    it('should run package transform for single version', async () => {
+      jest.mock(
+        mockMatchedPath,
+        () => ({
+          __esModule: true,
+          default: {
             transforms: {
-              '18.0.0': `${codemodName}/path/to/18.js`,
+              '18.0.0': 'mylib/path/to/18.js',
             },
             presets: {
-              'update-formatting': `${codemodName}/path/to/update-formatting.js`,
+              'update-formatting': 'mylib/path/to/update-formatting.js',
             },
-          };
+          },
         }),
-        uninstallAll: jest.fn().mockResolvedValue(undefined),
-      }));
-    });
+        { virtual: true },
+      );
 
-    it('should run package transform for single version', async () => {
       await main([mockPath], {
         packages: 'mylib@18.0.0',
         parser: 'babel',

packages/cli/src/main.ts

@@ -1,80 +1,20 @@
 import semver from 'semver';
 import chalk from 'chalk';
-import path from 'path';
+// import path from 'path';
 import { PluginManager } from 'live-plugin-manager';
 import merge from 'lodash/merge';
 // @ts-ignore Run transform(s) on path https://github.com/facebook/jscodeshift/issues/398
 import * as jscodeshift from 'jscodeshift/src/Runner';
+
+import { fetchPackage, fetchRemotePackage } from '@codeshift/fetcher';
 import { isValidConfig } from '@codeshift/validator';
 import { CodeshiftConfig } from '@codeshift/types';
 
 import { Flags } from './types';
 import { InvalidUserInputError } from './errors';
 
-async function fetchCommunityPackageConfig(
-  packageName: string,
-  packageManager: PluginManager,
-) {
-  const pkgName = packageName.replace('@', '').replace('/', '__');
-  const commPackageName = `@codeshift/mod-${pkgName}`;
-
-  await packageManager.install(commPackageName);
-  const pkg = packageManager.require(commPackageName);
-  const config: CodeshiftConfig = pkg.default ? pkg.default : pkg;
-
-  if (!isValidConfig(config)) {
-    throw new Error(`Invalid config found in module ${commPackageName}`);
-  }
-
-  return config;
-}
-
-async function fetchRemotePackageConfig(
-  packageName: string,
-  packageManager: PluginManager,
-) {
-  await packageManager.install(packageName);
-  const pkg = packageManager.require(packageName);
-
-  if (pkg) {
-    const config: CodeshiftConfig = pkg.default ? pkg.default : pkg;
-
-    if (config && isValidConfig(config)) {
-      // Found a config at the main entry-point
-      return config;
-    }
-  }
-
-  const info = packageManager.getInfo(packageName);
-
-  if (info) {
-    let config: CodeshiftConfig | undefined;
-
-    [
-      path.join(info?.location, 'codeshift.config.js'),
-      path.join(info?.location, 'codeshift.config.ts'),
-      path.join(info?.location, 'src', 'codeshift.config.js'),
-      path.join(info?.location, 'src', 'codeshift.config.ts'),
-      path.join(info?.location, 'codemods', 'codeshift.config.js'),
-      path.join(info?.location, 'codemods', 'codeshift.config.ts'),
-    ].forEach(searchPath => {
-      try {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const pkg = require(searchPath);
-        const searchConfig: CodeshiftConfig = pkg.default ? pkg.default : pkg;
-
-        if (isValidConfig(searchConfig)) {
-          config = searchConfig;
-        }
-      } catch (e) {}
-    });
-
-    if (config) return config;
-  }
-
-  throw new Error(
-    `Unable to locate a valid codeshift.config in package ${packageName}`,
-  );
+function getCodeshiftPackageName(packageName: string) {
+  return `@codeshift/mod-${packageName.replace('@', '').replace('/', '__')}`;
 }
 
 export default async function main(paths: string[], flags: Flags) {
@@ -109,30 +49,47 @@ export default async function main(paths: string[], flags: Flags) {
       const pkgName =
         shouldPrependAtSymbol + pkg.split(/[@#]/).filter(str => !!str)[0];
 
-      let communityConfig;
-      let remoteConfig;
-
       console.log(chalk.green('Attempting to download package:'), pkgName);
 
+      let codeshiftConfig: CodeshiftConfig | undefined;
+      let remoteConfig: CodeshiftConfig | undefined;
+
       try {
-        communityConfig = await fetchCommunityPackageConfig(
-          pkgName,
+        codeshiftConfig = await fetchPackage(
+          getCodeshiftPackageName(pkgName),
           packageManager,
         );
       } catch (error) {}
 
       try {
-        remoteConfig = await fetchRemotePackageConfig(pkgName, packageManager);
+        remoteConfig = await fetchRemotePackage(pkgName, packageManager);
       } catch (error) {}
 
-      if (!communityConfig && !remoteConfig) {
+      if (!codeshiftConfig && !remoteConfig) {
         throw new Error(
-          `Unable to locate package from the codeshift-community packages or as a standalone NPM package.
-Make sure the package name ${pkgName} has been spelled correctly and exists before trying again.`,
+          `Unable to locate package from codeshift-community or NPM.
+Make sure the package name "${pkgName}" is correct and try again.`,
+        );
+      }
+
+      if (codeshiftConfig) {
+        console.log(
+          chalk.green(`Found codeshift package:`),
+          getCodeshiftPackageName(pkgName),
         );
       }
 
-      const config: CodeshiftConfig = merge({}, communityConfig, remoteConfig);
+      if (remoteConfig) {
+        console.log(chalk.green(`Found codeshift package:`), pkgName);
+      }
+
+      const config: CodeshiftConfig = merge({}, remoteConfig, codeshiftConfig);
+
+      if (!isValidConfig(config)) {
+        throw new Error(
+          `Unable to locate a valid codeshift.config in package ${pkgName}`,
+        );
+      }
 
       const rawTransformIds = pkg.split(/(?=[@#])/).filter(str => !!str);
       rawTransformIds.shift();

packages/fetcher/CHANGELOG.md

@@ -0,0 +1 @@
+# @codeshift/fetcher

packages/fetcher/README.md

@@ -0,0 +1,3 @@
+# @codeshift/fetcher
+
+Responsible for fetching codemod packages and associated files.

packages/fetcher/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@codeshift/fetcher",
+  "version": "0.0.1",
+  "main": "dist/codeshift-fetcher.cjs.js",
+  "types": "dist/codeshift-fetcher.cjs.d.ts",
+  "license": "MIT",
+  "repository": "https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/master/packages/fetcher",
+  "dependencies": {
+    "@codeshift/types": "*",
+    "chalk": "^4.1.0",
+    "fs-extra": "^9.1.0",
+    "globby": "^11.1.0",
+    "live-plugin-manager": "^0.15.1",
+    "ts-node": "^9.1.1"
+  }
+}