✨ CLI now supports configs using cjs export schemes

danieldelcore · danieldelcore · commit 7f1e99c481aa · 2021-10-05T09:15:45.000+11:00
diff --git a/.changeset/great-frogs-refuse.md b/.changeset/great-frogs-refuse.md
@@ -0,0 +1,5 @@
+---
+'@codeshift/cli': minor
+---
+
+CLI now supports configs exported with cjs and es module types
diff --git a/packages/cli/src/main.spec.ts b/packages/cli/src/main.spec.ts
@@ -15,16 +15,14 @@ describe('main', () => {
     (PluginManager as jest.Mock).mockReturnValue({
       install: () => Promise.resolve(undefined),
       require: (codemodName: string) => ({
-        default: {
-          transforms: {
-            '18.0.0': `${codemodName}/path/to/18.js`,
-            '19.0.0': `${codemodName}/path/to/19.js`,
-            '20.0.0': `${codemodName}/path/to/20.js`,
-          },
-          presets: {
-            'update-formatting': `${codemodName}/path/to/update-formatting.js`,
-            'update-imports': `${codemodName}/path/to/update-imports.js`,
-          },
+        transforms: {
+          '18.0.0': `${codemodName}/path/to/18.js`,
+          '19.0.0': `${codemodName}/path/to/19.js`,
+          '20.0.0': `${codemodName}/path/to/20.js`,
+        },
+        presets: {
+          'update-formatting': `${codemodName}/path/to/update-formatting.js`,
+          'update-imports': `${codemodName}/path/to/update-imports.js`,
         },
       }),
       uninstallAll: () => Promise.resolve(),
@@ -333,10 +331,8 @@ describe('main', () => {
       (PluginManager as jest.Mock).mockReturnValue({
         install: () => Promise.resolve(undefined),
         require: (codemodName: string) => ({
-          default: {
-            presets: {
-              'update-formatting': `${codemodName}/path/to/update-formatting.js`,
-            },
+          presets: {
+            'update-formatting': `${codemodName}/path/to/update-formatting.js`,
           },
         }),
         uninstallAll: () => Promise.resolve(),
@@ -360,10 +356,8 @@ describe('main', () => {
         install: () => Promise.resolve(undefined),
         // @ts-ignore
         require: (codemodName: string) => ({
-          default: {
-            presets: {
-              'update-formatting': `${codemodName}/path/to/update-formatting.js`,
-            },
+          presets: {
+            'update-formatting': `${codemodName}/path/to/update-formatting.js`,
           },
         }),
         uninstallAll: () => Promise.resolve(),
@@ -472,10 +466,8 @@ describe('main', () => {
         install: () => Promise.resolve(undefined),
         // @ts-ignore
         require: (codemodName: string) => ({
-          default: {
-            transforms: {
-              '20.0.0': `${codemodName}/path/to/20.js`,
-            },
+          transforms: {
+            '20.0.0': `${codemodName}/path/to/20.js`,
           },
         }),
         uninstallAll: () => Promise.resolve(),
@@ -499,10 +491,8 @@ describe('main', () => {
         install: () => Promise.resolve(undefined),
         // @ts-ignore
         require: (codemodName: string) => ({
-          default: {
-            transforms: {
-              '20.0.0': `${codemodName}/path/to/20.js`,
-            },
+          transforms: {
+            '20.0.0': `${codemodName}/path/to/20.js`,
           },
         }),
         uninstallAll: () => Promise.resolve(),
@@ -517,4 +507,37 @@ describe('main', () => {
       ).resolves.not.toThrow();
     });
   });
+
+  describe('when reading configs using non-cjs exports', () => {
+    it('should read configs exported with export default', async () => {
+      (PluginManager as jest.Mock).mockReturnValue({
+        install: () => Promise.resolve(undefined),
+        // @ts-ignore
+        require: (codemodName: string) => ({
+          default: {
+            transforms: {
+              '18.0.0': `${codemodName}/path/to/18.js`,
+            },
+          },
+        }),
+        uninstallAll: () => Promise.resolve(),
+      });
+
+      await main([mockPath], {
+        packages: 'mylib@18.0.0',
+        parser: 'babel',
+        extensions: 'js',
+      });
+
+      expect(jscodeshift.run).toHaveBeenCalledTimes(1);
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/18.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+    });
+  });
 });
diff --git a/packages/cli/src/main.ts b/packages/cli/src/main.ts
@@ -36,16 +36,19 @@ export default async function main(paths: string[], flags: Flags) {
         .split(/[@#]/)
         .filter(str => !!str)[0]
         .replace('/', '__');
-      const codemodName = `@codeshift/mod-${pkgName}`;
+      const packageName = `@codeshift/mod-${pkgName}`;
 
-      await packageManager.install(codemodName);
-      // TODO: check if default exists first. module.exports might not have it
-      const { default: codeshiftConfig } = packageManager.require(codemodName);
+      await packageManager.install(packageName);
+      const codeshiftPackage = packageManager.require(packageName);
 
-      const codemodIds = pkg.split(/(?=[@#])/).filter(str => !!str);
-      codemodIds.shift();
+      const config = codeshiftPackage.default
+        ? codeshiftPackage.default
+        : codeshiftPackage;
 
-      const transformIds = codemodIds
+      const rawTransformIds = pkg.split(/(?=[@#])/).filter(str => !!str);
+      rawTransformIds.shift();
+
+      const transformIds = rawTransformIds
         .filter(id => id.startsWith('@'))
         .map(id => id.substring(1))
         .sort((idA, idB) => {
@@ -54,7 +57,7 @@ export default async function main(paths: string[], flags: Flags) {
           return 0;
         });
 
-      const presetIds = codemodIds
+      const presetIds = rawTransformIds
         .filter(id => id.startsWith('#'))
         .map(id => id.substring(1));
 
@@ -66,47 +69,47 @@ export default async function main(paths: string[], flags: Flags) {
           );
         }
 
-        if (!codeshiftConfig.transforms || !codeshiftConfig.transforms[id]) {
+        if (!config.transforms || !config.transforms[id]) {
           throw new InvalidUserInputError(
             `Invalid version provided to the --packages flag. Unable to resolve version "${id}" for package "${pkgName}"`,
           );
         }
       });
 
       presetIds.forEach(id => {
-        if (!codeshiftConfig.presets || !codeshiftConfig.presets[id]) {
+        if (!config.presets || !config.presets[id]) {
           throw new InvalidUserInputError(
             `Invalid preset provided to the --packages flag. Unable to resolve preset "${id}" for package "${pkgName}"`,
           );
         }
       });
 
       // Get transform file paths
-      if (codeshiftConfig.transforms) {
+      if (config.transforms) {
         if (flags.sequence) {
-          Object.entries(codeshiftConfig.transforms as Record<string, string>)
+          Object.entries(config.transforms as Record<string, string>)
             .filter(([key]) => semver.satisfies(key, `>=${transformIds[0]}`))
             .forEach(([, path]) => transforms.push(path));
         } else {
-          Object.entries(
-            codeshiftConfig.transforms as Record<string, string>,
-          ).forEach(([id, path]) => {
-            if (transformIds.includes(id)) {
-              transforms.push(path);
-            }
-          });
+          Object.entries(config.transforms as Record<string, string>).forEach(
+            ([id, path]) => {
+              if (transformIds.includes(id)) {
+                transforms.push(path);
+              }
+            },
+          );
         }
       }
 
       // Get preset file paths
-      if (codeshiftConfig.presets) {
-        Object.entries(
-          codeshiftConfig.presets as Record<string, string>,
-        ).forEach(([id, path]) => {
-          if (presetIds.includes(id)) {
-            transforms.push(path);
-          }
-        });
+      if (config.presets) {
+        Object.entries(config.presets as Record<string, string>).forEach(
+          ([id, path]) => {
+            if (presetIds.includes(id)) {
+              transforms.push(path);
+            }
+          },
+        );
       }
     }
   }
diff --git a/packages/cli/src/types.ts b/packages/cli/src/types.ts
@@ -6,9 +6,6 @@ export type Transform = (
   options: Options,
 ) => string;
 
-export class ValidationError extends Error {}
-export class NoTransformsExistError extends Error {}
-
 export interface Flags {
   /**
    * The transform to run

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@codeshift/cli': minor
 +---
++
 +CLI now supports configs exported with cjs and es module types