remote module fetching

Author: danieldelcore

packages/cli/src/main.ts

@@ -1,12 +1,54 @@
 import semver from 'semver';
 import chalk from 'chalk';
+import path from 'path';
 import { PluginManager } from 'live-plugin-manager';
 // @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 { 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;
+
+  // if (!isValidConfig(commConfig)) {
+  // }
+
+  // Attempt to find source package from npm
+  await packageManager.install(packageName);
+  // For source packages, fetching configs is a bit more elaborate
+  let config;
+
+  // Attemp to fetch from the main entrypoint
+  const info = packageManager.getInfo(packageName);
+  const pkg = packageManager.require(packageName);
+
+  if (info || pkg) {
+    config = pkg.default ? pkg.default : pkg;
+
+    if (config && isValidConfig) {
+      // Found a config at the main entry-point
+    }
+
+    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',
+    ));
+  }
+  // if ()
+
+  return config;
+}
+
 export default async function main(paths: string[], flags: Flags) {
   let transforms: string[] = [];
 
@@ -26,8 +68,6 @@ export default async function main(paths: string[], flags: Flags) {
     transforms.push(flags.transform);
   }
 
-  const packageManager = new PluginManager();
-
   if (flags.packages) {
     const pkgs = flags.packages.split(',').filter(pkg => !!pkg);
 
@@ -36,14 +76,8 @@ export default async function main(paths: string[], flags: Flags) {
         .split(/[@#]/)
         .filter(str => !!str)[0]
         .replace('/', '__');
-      const packageName = `@codeshift/mod-${pkgName}`;
-
-      await packageManager.install(packageName);
-      const codeshiftPackage = packageManager.require(packageName);
 
-      const config = codeshiftPackage.default
-        ? codeshiftPackage.default
-        : codeshiftPackage;
+      const config = await fetchPackageConfig(pkgName);
 
       const rawTransformIds = pkg.split(/(?=[@#])/).filter(str => !!str);
       rawTransformIds.shift();

packages/cli/src/validate.ts

@@ -1,8 +1,8 @@
-import { isValidConfig, isValidPackageJson } from '@codeshift/validator';
+import { isValidConfigAtPath, isValidPackageJson } from '@codeshift/validator';
 
 export default async function validate(targetPath: string = '.') {
   try {
-    await isValidConfig(targetPath);
+    await isValidConfigAtPath(targetPath);
     await isValidPackageJson(targetPath);
   } catch (error) {
     console.warn(error);

packages/types/README.md

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

packages/types/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@codeshift/types",
+  "version": "0.0.0",
+  "main": "dist/codeshift-types.cjs.js",
+  "module": "dist/codeshift-types.esm.js",
+  "types": "dist/codeshift-types.cjs.d.ts",
+  "license": "MIT",
+  "repository": "https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/master/packages/types"
+}

packages/types/src/index.ts

@@ -0,0 +1,7 @@
+export interface CodeshiftConfig {
+  target?: string[];
+  maintainers?: string[];
+  description?: string;
+  transforms?: Record<string, string>;
+  presets?: Record<string, string>;
+}

packages/validator/package.json

@@ -6,6 +6,7 @@
   "license": "MIT",
   "repository": "https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/master/packages/validator",
   "dependencies": {
+    "@codeshift/types": "^0.0.1",
     "fs-extra": "^9.1.0",
     "recast": "^0.20.4",
     "semver": "^7.3.5",

packages/validator/src/index.ts

@@ -1,50 +1,69 @@
 import fs from 'fs-extra';
 import semver from 'semver';
 import path from 'path';
+import { CodeshiftConfig } from '@codeshift/types';
 
-export function isValidPackageName(dir: string) {
-  return dir.match(/^(@[a-z0-9-~][a-z0-9-._~]*__)?[a-z0-9-~][a-z0-9-._~]*$/);
-}
-
-export async function isValidConfig(filePath: string) {
+function getConfigFromPath(filePath: string): CodeshiftConfig {
   const configPath = path.join(process.cwd(), filePath, 'codeshift.config.js');
   // eslint-disable-next-line @typescript-eslint/no-var-requires
-  let config = require(configPath);
+  const config = require(configPath);
+
+  return !!config.default ? config.default : config;
+}
 
-  config = !!config.default ? config.default : config;
+function hasValidTransforms(transforms?: Record<string, string>) {
+  if (!transforms || !Object.keys(transforms).length) return false;
 
-  const invalidSemverIds = [];
-  const invalidPresetIds = [];
+  let isValid = true;
 
-  let hasTransforms = false;
+  Object.entries(transforms).forEach(([key]) => {
+    if (!semver.valid(key)) isValid = false;
+  });
 
-  if (config.transforms && Object.keys(config.transforms).length) {
-    Object.entries(config.transforms).forEach(([key]) => {
-      hasTransforms = true;
-      if (!semver.valid(key)) invalidSemverIds.push(key);
-    });
-  }
+  return isValid;
+}
 
-  if (config.presets && Object.keys(config.presets).length) {
-    hasTransforms = true;
-    Object.entries(config.presets).forEach(([key]) => {
-      if (key.includes(' ')) invalidPresetIds.push(key);
-    });
-  }
+function hasValidPresets(presets?: Record<string, string>) {
+  if (!presets || !Object.keys(presets).length) return false;
+
+  let isValid = true;
+
+  Object.entries(presets).forEach(([key]) => {
+    if (!key.match(/^[0-9a-zA-Z\-]+$/)) isValid = false;
+  });
+
+  return isValid;
+}
+
+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) {
+  return (
+    hasValidTransforms(config.transforms) || hasValidPresets(config.presets)
+  );
+}
+
+export async function isValidConfigAtPath(filePath: string) {
+  const config = getConfigFromPath(filePath);
 
-  if (!hasTransforms) {
+  if (
+    !hasValidTransforms(config.transforms) &&
+    !hasValidPresets(config.presets)
+  ) {
     throw new Error(
-      `At least one transform should be specified for config at "${configPath}"`,
+      `At least one transform should be specified for config at "${filePath}"`,
     );
   }
 
-  if (invalidSemverIds.length) {
-    throw new Error(`Invalid transform ids found for config at "${configPath}".
+  if (!hasValidTransforms(config.transforms)) {
+    throw new Error(`Invalid transform ids found for config at "${filePath}".
 Please make sure all transforms are identified by a valid semver version. ie 10.0.0`);
   }
 
-  if (invalidPresetIds.length) {
-    throw new Error(`Invalid preset ids found for config at "${configPath}".
+  if (!hasValidPresets(config.presets)) {
+    throw new Error(`Invalid preset ids found for config at "${filePath}".
 Please make sure all presets are kebab case and contain no spaces or special characters. ie sort-imports-by-scope`);
   }
 }

scripts/validate.ts

@@ -1,5 +1,5 @@
 import fs, { lstatSync, existsSync } from 'fs-extra';
-import { isValidPackageName, isValidConfig } from '@codeshift/validator';
+import { isValidPackageName, isValidConfigAtPath } from '@codeshift/validator';
 
 async function main(path: string) {
   const directories = await fs.readdir(path);
@@ -13,7 +13,7 @@ async function main(path: string) {
       );
     }
 
-    await isValidConfig(`${path}/${dir}`);
+    await isValidConfigAtPath(`${path}/${dir}`);
 
     const subDirectories = await fs.readdir(`${path}/${dir}`);
     subDirectories.forEach(async subDir => {