Use globby for config fetching

Author: danieldelcore

.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/src/main.ts

@@ -59,6 +59,9 @@ export default async function main(paths: string[], flags: Flags) {
           getCodeshiftPackageName(pkgName),
           packageManager,
         );
+      } catch (error) {}
+
+      try {
         remoteConfig = await fetchRemotePackage(pkgName, packageManager);
       } catch (error) {}
 

packages/fetcher/package.json

@@ -9,6 +9,7 @@
     "@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"
   }

packages/fetcher/src/index.ts

@@ -1,22 +1,24 @@
 import path from 'path';
+import globby from 'globby';
 import { PluginManager } from 'live-plugin-manager';
 
 import { CodeshiftConfig } from '@codeshift/types';
 
-export function fetchConfig(filePath: string): CodeshiftConfig | undefined {
+export async function fetchConfig(
+  filePath: string,
+): Promise<CodeshiftConfig | undefined> {
   let config: CodeshiftConfig | undefined;
 
-  [
-    path.join(filePath, 'codeshift.config.js'),
-    path.join(filePath, 'codeshift.config.ts'),
-    path.join(filePath, 'src', 'codeshift.config.js'),
-    path.join(filePath, 'src', 'codeshift.config.ts'),
-    path.join(filePath, 'codemods', 'codeshift.config.js'),
-    path.join(filePath, 'codemods', 'codeshift.config.ts'),
-  ].forEach(searchPath => {
+  const matchedPaths = await globby([
+    path.join(filePath, 'codeshift.config.(js|ts|tsx)'),
+    path.join(filePath, 'src', 'codeshift.config.(js|ts|tsx)'),
+    path.join(filePath, 'codemods', 'codeshift.config.(js|ts|tsx)'),
+  ]);
+
+  matchedPaths.forEach(matchedPath => {
     try {
       // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const pkg = require(searchPath);
+      const pkg = require(matchedPath);
       const searchConfig = pkg.default ? pkg.default : pkg;
       config = searchConfig;
     } catch (e) {}
@@ -39,13 +41,11 @@ export async function fetchRemotePackage(
   packageName: string,
   packageManager: PluginManager,
 ): Promise<CodeshiftConfig | undefined> {
-  let config = await fetchPackage(packageName, packageManager);
-
+  const config = await fetchPackage(packageName, packageManager);
   if (config) return config;
 
   const info = packageManager.getInfo(packageName);
-
   if (!info) return undefined;
 
-  return fetchConfig(info.location);
+  return await fetchConfig(info.location);
 }

packages/validator/package.json

@@ -6,6 +6,7 @@
   "license": "MIT",
   "repository": "https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/master/packages/validator",
   "dependencies": {
+    "@codeshift/fetcher": "^0.0.1",
     "@codeshift/types": "^0.0.5",
     "fs-extra": "^9.1.0",
     "lodash": "^4.17.21",

packages/validator/src/index.spec.ts

@@ -1,7 +1,9 @@
 jest.mock('fs-extra');
+jest.mock('@codeshift/fetcher');
 
 import fs from 'fs-extra';
-import path from 'path';
+
+import { fetchConfig } from '@codeshift/fetcher';
 
 import {
   isValidPackageName,
@@ -112,58 +114,38 @@ describe('validator', () => {
       jest.resetModules();
     });
 
-    it('should validate config', () => {
-      jest.mock(
-        path.join(__dirname, 'path', 'to', 'codeshift.config.js'),
-        () => ({
-          __esModule: true,
-          default: {
-            transforms: {
-              '10.0.0': 'path/to/transform.js',
-            },
-          },
-        }),
-        { virtual: true },
-      );
+    it('should validate config', async () => {
+      (fetchConfig as jest.Mock).mockResolvedValue({
+        transforms: {
+          '10.0.0': 'path/to/transform.js',
+        },
+      });
 
-      expect(isValidConfigAtPath('path/to/')).toEqual(true);
+      const result = await isValidConfigAtPath('path/to/');
+      expect(result).toEqual(true);
     });
 
-    it('should error if config contains invalid transforms', () => {
-      jest.mock(
-        path.join(__dirname, 'path', 'to', 'codeshift.config.js'),
-        () => ({
-          __esModule: true,
-          default: {
-            transforms: {
-              hello: '',
-            },
-          },
-        }),
-        { virtual: true },
-      );
+    it('should error if config contains invalid transforms', async () => {
+      (fetchConfig as jest.Mock).mockResolvedValue({
+        transforms: {
+          hello: '',
+        },
+      });
 
-      expect(() => isValidConfigAtPath('path/to/')).toThrowError(
+      await expect(isValidConfigAtPath('path/to/')).rejects.toThrowError(
         `Invalid transform ids found for config at "path/to/".
 Please make sure all transforms are identified by a valid semver version. ie 10.0.0`,
       );
     });
 
-    it('should error if config contains invalid presets', () => {
-      jest.mock(
-        path.join(__dirname, 'path', 'to', 'codeshift.config.js'),
-        () => ({
-          __esModule: true,
-          default: {
-            presets: {
-              'foo bar': '',
-            },
-          },
-        }),
-        { virtual: true },
-      );
+    it('should error if config contains invalid presets', async () => {
+      (fetchConfig as jest.Mock).mockResolvedValue({
+        presets: {
+          'foo bar': '',
+        },
+      });
 
-      expect(() => isValidConfigAtPath('path/to/')).toThrowError(
+      await expect(isValidConfigAtPath('path/to/')).rejects.toThrowError(
         `Invalid preset ids found for config at "path/to/".
 Please make sure all presets are kebab case and contain no spaces or special characters. ie sort-imports-by-scope`,
       );
@@ -196,6 +178,7 @@ Please make sure all presets are kebab case and contain no spaces or special cha
         try {
           await isValidPackageJson('path/to/');
         } catch (error) {
+          // @ts-ignore
           expect(error.message).toMatch(
             'No main entrypoint provided in package.json',
           );
@@ -210,6 +193,7 @@ Please make sure all presets are kebab case and contain no spaces or special cha
         try {
           await isValidPackageJson('path/to/');
         } catch (error) {
+          // @ts-ignore
           expect(error.message).toMatch(
             'No package name provided in package.json',
           );

packages/validator/src/index.ts

@@ -1,26 +1,20 @@
 import fs from 'fs-extra';
 import semver from 'semver';
 import path from 'path';
-import { CodeshiftConfig } from '@codeshift/types';
-
-function getConfigFromPath(filePath: string): CodeshiftConfig {
-  const configPath = path.join(__dirname, filePath, 'codeshift.config.js');
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const config = require(configPath);
 
-  return !!config.default ? config.default : config;
-}
+import { CodeshiftConfig } from '@codeshift/types';
+import { fetchConfig } from '@codeshift/fetcher';
 
-function hasValidTransforms(transforms?: Record<string, string>) {
-  if (!transforms) return true;
+function hasValidTransforms(config: CodeshiftConfig) {
+  if (!config.transforms) return true;
 
-  return Object.entries(transforms).every(([key]) => semver.valid(key));
+  return Object.entries(config.transforms).every(([key]) => semver.valid(key));
 }
 
-function hasValidPresets(presets?: Record<string, string>): boolean {
-  if (!presets) return true;
+function hasValidPresets(config: CodeshiftConfig): boolean {
+  if (!config.presets) return true;
 
-  return Object.entries(presets).every(([key]) =>
+  return Object.entries(config.presets).every(([key]) =>
     key.match(/^[0-9a-zA-Z\-]+$/),
   );
 }
@@ -30,20 +24,22 @@ export function isValidPackageName(dir: string): boolean {
 }
 
 export function isValidConfig(config: CodeshiftConfig) {
-  return (
-    hasValidTransforms(config.transforms) && hasValidPresets(config.presets)
-  );
+  return hasValidTransforms(config) && hasValidPresets(config);
 }
 
-export function isValidConfigAtPath(filePath: string) {
-  const config = getConfigFromPath(filePath);
+export async function isValidConfigAtPath(filePath: string) {
+  const config = await fetchConfig(filePath);
+
+  if (!config) {
+    throw new Error('Unable to locate config file');
+  }
 
-  if (!hasValidTransforms(config.transforms)) {
+  if (!hasValidTransforms(config)) {
     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 (!hasValidPresets(config.presets)) {
+  if (!hasValidPresets(config)) {
     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`);
   }

yarn.lock

@@ -3329,6 +3329,17 @@ fast-glob@^3.1.1, fast-glob@^3.2.4:
     merge2 "^1.3.0"
     micromatch "^4.0.4"
 
+fast-glob@^3.2.9:
+  version "3.2.10"
+  resolved "https://packages.atlassian.com/api/npm/npm-remote/fast-glob/-/fast-glob-3.2.10.tgz#2734f83baa7f43b7fd41e13bc34438f4ffe284ee"
+  integrity sha1-JzT4O6p/Q7f9QeE7w0Q49P/ihO4=
+  dependencies:
+    "@nodelib/fs.stat" "^2.0.2"
+    "@nodelib/fs.walk" "^1.2.3"
+    glob-parent "^5.1.2"
+    merge2 "^1.3.0"
+    micromatch "^4.0.4"
+
 fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0:
   version "2.1.0"
   resolved "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633"
@@ -3707,6 +3718,18 @@ globby@^11.0.0:
     merge2 "^1.3.0"
     slash "^3.0.0"
 
+globby@^11.1.0:
+  version "11.1.0"
+  resolved "https://packages.atlassian.com/api/npm/npm-remote/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b"
+  integrity sha1-vUvpi7BC+D15b344EZkfvoKg00s=
+  dependencies:
+    array-union "^2.1.0"
+    dir-glob "^3.0.1"
+    fast-glob "^3.2.9"
+    ignore "^5.2.0"
+    merge2 "^1.4.1"
+    slash "^3.0.0"
+
 globby@^9.2.0:
   version "9.2.0"
   resolved "https://registry.npmjs.org/globby/-/globby-9.2.0.tgz#fd029a706c703d29bdd170f4b6db3a3f7a7cb63d"
@@ -3901,6 +3924,11 @@ ignore@^5.1.4:
   resolved "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz#f150a8b50a34289b33e22f5889abd4d8016f0e57"
   integrity sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==
 
+ignore@^5.2.0:
+  version "5.2.0"
+  resolved "https://packages.atlassian.com/api/npm/npm-remote/ignore/-/ignore-5.2.0.tgz#6d3bac8fa7fe0d45d9f9be7bac2fc279577e345a"
+  integrity sha1-bTusj6f+DUXZ+b57rC/CeVd+NFo=
+
 import-fresh@^3.0.0:
   version "3.3.0"
   resolved "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz#37162c25fcb9ebaa2e6e53d5b4d88ce17d9e0c2b"
@@ -5165,7 +5193,7 @@ merge-stream@^2.0.0:
   resolved "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60"
   integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==
 
-merge2@^1.2.3, merge2@^1.3.0:
+merge2@^1.2.3, merge2@^1.3.0, merge2@^1.4.1:
   version "1.4.1"
   resolved "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae"
   integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==