✨ Remote config file search

Author: danieldelcore

packages/cli/src/main.ts

@@ -2,51 +2,73 @@ import semver from 'semver';
 import chalk from 'chalk';
 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 { isValidConfig } from '@codeshift/validator';
+import { CodeshiftConfig } from '@codeshift/types';
 
 import { Flags } from './types';
 import { InvalidUserInputError } from './errors';
 
 const packageManager = new PluginManager();
 
-async function fetchPackageConfig(packageName: string) {
-  // Attempt to find package from the community folder
-  await packageManager.install(`@codeshift/mod-${packageName}`);
-  const commPkg = packageManager.require(packageName);
-  const commConfig = commPkg.default ? commPkg.default : commPkg;
+async function fetchCommunityPackageConfig(packageName: string) {
+  const commPackageName = `@codeshift/mod-${packageName}`;
+  await packageManager.install(commPackageName);
+  const pkg = packageManager.require(packageName);
+  const config: CodeshiftConfig = pkg.default ? pkg.default : pkg;
 
-  // if (!isValidConfig(commConfig)) {
-  // }
+  if (!isValidConfig(config)) {
+    throw new Error(`Invalid config found in module ${commPackageName}`);
+  }
 
-  // Attempt to find source package from npm
-  await packageManager.install(packageName);
-  // For source packages, fetching configs is a bit more elaborate
-  let config;
+  return config;
+}
 
-  // Attemp to fetch from the main entrypoint
-  const info = packageManager.getInfo(packageName);
+async function fetchRemotePackageConfig(packageName: string) {
+  await packageManager.install(packageName);
   const pkg = packageManager.require(packageName);
 
-  if (info || pkg) {
-    config = pkg.default ? pkg.default : pkg;
+  if (pkg) {
+    const config: CodeshiftConfig = pkg.default ? pkg.default : pkg;
 
-    if (config && isValidConfig) {
+    if (config && isValidConfig(config)) {
       // Found a config at the main entry-point
+      return config;
     }
+  }
 
-    config = require(path.join(info?.location, 'codeshift.config.js'));
-    config = require(path.join(info?.location, 'src', 'codeshift.config.js'));
-    config = require(path.join(
-      info?.location,
-      'codemods',
-      'codeshift.config.js',
-    ));
+  const info = packageManager.getInfo(packageName);
+
+  if (info) {
+    let config: any;
+
+    [
+      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;
   }
-  // if ()
 
-  return config;
+  throw new Error(
+    `Unable to locate a valid codeshift.config in package ${packageName}`,
+  );
 }
 
 export default async function main(paths: string[], flags: Flags) {
@@ -77,7 +99,9 @@ export default async function main(paths: string[], flags: Flags) {
         .filter(str => !!str)[0]
         .replace('/', '__');
 
-      const config = await fetchPackageConfig(pkgName);
+      const communityConfig = await fetchCommunityPackageConfig(pkgName);
+      const remoteConfig = await fetchRemotePackageConfig(pkgName);
+      const config: CodeshiftConfig = merge(communityConfig, remoteConfig);
 
       const rawTransformIds = pkg.split(/(?=[@#])/).filter(str => !!str);
       rawTransformIds.shift();

packages/types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codeshift/types",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "main": "dist/codeshift-types.cjs.js",
   "module": "dist/codeshift-types.esm.js",
   "types": "dist/codeshift-types.cjs.d.ts",

packages/validator/package.json

@@ -8,8 +8,12 @@
   "dependencies": {
     "@codeshift/types": "^0.0.1",
     "fs-extra": "^9.1.0",
+    "lodash": "^4.17.21",
     "recast": "^0.20.4",
     "semver": "^7.3.5",
     "ts-node": "^9.1.1"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.176"
   }
 }

packages/validator/src/index.ts

@@ -29,13 +29,13 @@ export function isValidPackageName(dir: string) {
   return dir.match(/^(@[a-z0-9-~][a-z0-9-._~]*__)?[a-z0-9-~][a-z0-9-._~]*$/);
 }
 
-export async function isValidConfig(config: CodeshiftConfig) {
+export function isValidConfig(config: CodeshiftConfig) {
   return (
     hasValidTransforms(config.transforms) || hasValidPresets(config.presets)
   );
 }
 
-export async function isValidConfigAtPath(filePath: string) {
+export function isValidConfigAtPath(filePath: string) {
   const config = getConfigFromPath(filePath);
 
   if (

yarn.lock

@@ -1722,6 +1722,11 @@
   resolved "https://registry.npmjs.org/@types/lockfile/-/lockfile-1.0.2.tgz#3f77e84171a2b7e3198bd5717c7547a54393baf8"
   integrity sha512-jD5VbvhfMhaYN4M3qPJuhMVUg3Dfc4tvPvLEAXn6GXbs/ajDFtCQahX37GIE65ipTI3I+hEvNaXS3MYAn9Ce3Q==
 
+"@types/lodash@^4.14.176":
+  version "4.14.176"
+  resolved "https://packages.atlassian.com/api/npm/npm-remote/@types/lodash/-/lodash-4.14.176.tgz#641150fc1cda36fbfa329de603bbb175d7ee20c0"
+  integrity sha1-ZBFQ/BzaNvv6Mp3mA7uxddfuIMA=
+
 "@types/minimatch@*":
   version "3.0.5"
   resolved "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz#1001cc5e6a3704b83c236027e77f2f58ea010f40"
@@ -5009,10 +5014,10 @@ lodash.unescape@4.0.1:
   resolved "https://registry.npmjs.org/lodash.unescape/-/lodash.unescape-4.0.1.tgz#bf2249886ce514cda112fae9218cdc065211fc9c"
   integrity sha1-vyJJiGzlFM2hEvrpIYzcBlIR/Jw=
 
-lodash@4.x, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.14, lodash@^4.7.0:
+lodash@4.x, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.14, lodash@^4.17.21, lodash@^4.7.0:
   version "4.17.21"
-  resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
-  integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
+  resolved "https://packages.atlassian.com/api/npm/npm-remote/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
+  integrity sha1-Z5WRxWTDv/quhFTPCz3zcMPWkRw=
 
 loud-rejection@^1.0.0:
   version "1.6.0"