🔨 Packages published to the community folder can now be run by the CLI! Loop closed!

danieldelcore · danieldelcore · commit ad7603939716 · 2021-09-03T21:43:08.000+10:00
diff --git a/.changeset/dull-rabbits-admire.md b/.changeset/dull-rabbits-admire.md
@@ -0,0 +1,5 @@
+---
+'@codeshift/cli': patch
+---
+
+CLI can now properly run packaged codemods without dangerously looking for files
diff --git a/community/@atlaskit__avatar/codeshift.config.js b/community/@atlaskit__avatar/codeshift.config.js
@@ -1,7 +1,7 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '18.0.0': require('./18.0.0/transform'),
-    '19.0.0': require('./19.0.0/transform'),
+    '18.0.0': require.resolve('./18.0.0/transform'),
+    '19.0.0': require.resolve('./19.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__breadcrumbs/codeshift.config.js b/community/@atlaskit__breadcrumbs/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '11.0.0': require('./11.0.0/transform'),
+    '11.0.0': require.resolve('./11.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__button/codeshift.config.js b/community/@atlaskit__button/codeshift.config.js
@@ -1,7 +1,7 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '15.0.0': require('./15.0.0/transform'),
-    '15.1.1': require('./15.1.1/transform'),
+    '15.0.0': require.resolve('./15.0.0/transform'),
+    '15.1.1': require.resolve('./15.1.1/transform'),
   },
 };
diff --git a/community/@atlaskit__calendar/codeshift.config.js b/community/@atlaskit__calendar/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '11.0.0': require('./11.0.0/transform'),
+    '11.0.0': require.resolve('./11.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__checkbox/codeshift.config.js b/community/@atlaskit__checkbox/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '12.0.0': require('./12.0.0/transform'),
+    '12.0.0': require.resolve('./12.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__icon/codeshift.config.js b/community/@atlaskit__icon/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '21.2.0': require('./21.2.0/transform'),
+    '21.2.0': require.resolve('./21.2.0/transform'),
   },
 };
diff --git a/community/@atlaskit__menu/codeshift.config.js b/community/@atlaskit__menu/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '0.7.0': require('./0.7.0/transform'),
+    '0.7.0': require.resolve('./0.7.0/transform'),
   },
 };
diff --git a/community/@atlaskit__popper/codeshift.config.js b/community/@atlaskit__popper/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '5.0.0': require('./5.0.0/transform'),
+    '5.0.0': require.resolve('./5.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__popup/codeshift.config.js b/community/@atlaskit__popup/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '1.0.0': require('./1.0.0/transform'),
+    '1.0.0': require.resolve('./1.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__progress-indicator/codeshift.config.js b/community/@atlaskit__progress-indicator/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '9.0.0': require('./9.0.0/transform'),
+    '9.0.0': require.resolve('./9.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__range/codeshift.config.js b/community/@atlaskit__range/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '4.0.0': require('./4.0.0/transform'),
+    '4.0.0': require.resolve('./4.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__section-message/codeshift.config.js b/community/@atlaskit__section-message/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '6.0.0': require('./6.0.0/transform'),
+    '6.0.0': require.resolve('./6.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__side-navigation/codeshift.config.js b/community/@atlaskit__side-navigation/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '0.8.0': require('./0.8.0/transform'),
+    '0.8.0': require.resolve('./0.8.0/transform'),
   },
 };
diff --git a/community/@atlaskit__spinner/codeshift.config.js b/community/@atlaskit__spinner/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '13.0.0': require('./13.0.0/transform'),
+    '13.0.0': require.resolve('./13.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__tag/codeshift.config.js b/community/@atlaskit__tag/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '11.0.0': require('./11.0.0/transform'),
+    '11.0.0': require.resolve('./11.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__textarea/codeshift.config.js b/community/@atlaskit__textarea/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '4.0.0': require('./4.0.0/transform'),
+    '4.0.0': require.resolve('./4.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__textfield/codeshift.config.js b/community/@atlaskit__textfield/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '5.0.0': require('./5.0.0/transform'),
+    '5.0.0': require.resolve('./5.0.0/transform'),
   },
 };
diff --git a/community/@atlaskit__toggle/codeshift.config.js b/community/@atlaskit__toggle/codeshift.config.js
@@ -1,7 +1,7 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '11.0.0': require('./11.0.0/transform'),
-    '12.0.0': require('./12.0.0/transform'),
+    '11.0.0': require.resolve('./11.0.0/transform'),
+    '12.0.0': require.resolve('./12.0.0/transform'),
   },
 };
diff --git a/community/@emotion__monorepo/codeshift.config.js b/community/@emotion__monorepo/codeshift.config.js
@@ -1,6 +1,6 @@
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '11.0.0': require('./11.0.0/transform'),
+    '11.0.0': require.resolve('./11.0.0/transform'),
   },
 };
diff --git a/packages/cli/src/main.spec.ts b/packages/cli/src/main.spec.ts
@@ -5,22 +5,29 @@ jest.mock('jscodeshift/src/Runner', () => ({
 jest.mock('live-plugin-manager', () => ({
   PluginManager: () => ({
     install: () => Promise.resolve(undefined),
-    getInfo: (name: string) =>
-      Promise.resolve({ location: `node_modules/${name}` }),
+    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`,
+        },
+      },
+    }),
     uninstallAll: () => Promise.resolve(),
   }),
 }));
 
-jest.mock('fs-extra', () => ({
-  readdir: () =>
-    Promise.resolve([
-      '18.0.0',
-      '19.0.0',
-      '20.0.0',
-      'codeshift.config.js',
-      'index.ts',
-    ]),
-}));
+// jest.mock('fs-extra', () => ({
+//   readdir: () =>
+//     Promise.resolve([
+//       '18.0.0',
+//       '19.0.0',
+//       '20.0.0',
+//       'codeshift.config.js',
+//       'index.ts',
+//     ]),
+// }));
 
 // @ts-ignore
 import * as jscodeshift from 'jscodeshift/src/Runner';
@@ -144,7 +151,7 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(1);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/18.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/18.js',
         expect.arrayContaining([mockPath]),
         expect.objectContaining({
           parser: 'babel',
@@ -163,20 +170,20 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(3);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/18.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/18.js',
         expect.arrayContaining([mockPath]),
         expect.objectContaining({
           parser: 'babel',
           extensions: 'js',
         }),
       );
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/19.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/19.js',
         expect.any(Array),
         expect.any(Object),
       );
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/20.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
@@ -190,7 +197,7 @@ describe('main', () => {
       });
 
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-myscope__mylib/src/19.0.0/transform.ts',
+        '@codeshift/mod-myscope__mylib/path/to/19.js',
         expect.any(Array),
         expect.any(Object),
       );
@@ -205,12 +212,12 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(2);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/20.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-myotherlib/src/20.0.0/transform.ts',
+        '@codeshift/mod-myotherlib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
@@ -225,12 +232,12 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(2);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-myscope__mylib/src/20.0.0/transform.ts',
+        '@codeshift/mod-myscope__mylib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-myotherscope__myotherlib/src/20.0.0/transform.ts',
+        '@codeshift/mod-myotherscope__myotherlib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
@@ -245,7 +252,7 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(1);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/20.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/20.js',
         expect.any(Array),
         expect.any(Object),
       );
@@ -278,7 +285,7 @@ describe('main', () => {
 
       expect(jscodeshift.run).toHaveBeenCalledTimes(2);
       expect(jscodeshift.run).toHaveBeenCalledWith(
-        'node_modules/@codeshift/mod-mylib/src/20.0.0/transform.ts',
+        '@codeshift/mod-mylib/path/to/20.js',
         expect.arrayContaining([mockPath]),
         expect.objectContaining({
           parser: 'babel',
diff --git a/packages/cli/src/main.ts b/packages/cli/src/main.ts
@@ -1,5 +1,4 @@
 import semver from 'semver';
-import fs from 'fs-extra';
 import chalk from 'chalk';
 import { PluginManager } from 'live-plugin-manager';
 // @ts-ignore Run transform(s) on path https://github.com/facebook/jscodeshift/issues/398
@@ -46,27 +45,20 @@ export default async function main(paths: string[], flags: Flags) {
       }
 
       const codemodName = `@codeshift/mod-${name}`;
-
       await packageManager.install(codemodName);
-      const info = await packageManager.getInfo(codemodName);
-
-      /**
-       * TODO: currently jscodeshift only accepts a path to a transform rather than a function or module.
-       * The below logic will need to be refactored once this is fixed
-       */
-      const modulePath = `${info?.location}/src`;
-      const directories = await fs.readdir(modulePath);
+      const { default: codeshiftConfig } = packageManager.require(codemodName);
 
-      directories
+      Object.entries(codeshiftConfig.transforms as Record<string, string>)
         .filter(
-          dir => semver.valid(dir) && semver.satisfies(dir, `>=${baseVersion}`),
+          ([key]) =>
+            semver.valid(key) && semver.satisfies(key, `>=${baseVersion}`),
         )
-        .filter(dir => {
+        .filter(([key]) => {
           if (flags.sequence) return true;
 
-          return baseVersion && semver.eq(dir, baseVersion);
+          return baseVersion && semver.eq(key, baseVersion);
         })
-        .forEach(dir => transforms.push(`${modulePath}/${dir}/transform.ts`));
+        .forEach(([, path]) => transforms.push(path));
     }
   }
 
diff --git a/website/docs/authoring.mdx b/website/docs/authoring.mdx
@@ -60,8 +60,8 @@ They typically look like this:
 export default {
   maintainers: ['danieldelcore'],
   transforms: {
-    '18.0.0': require('./18.0.0/transform'),
-    '19.0.0': require('./19.0.0/transform'),
+    '18.0.0': require.resolve('./18.0.0/transform'),
+    '19.0.0': require.resolve('./19.0.0/transform'),
   },
 };
 ```

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@codeshift/cli': patch
 +---
++
 +CLI can now properly run packaged codemods without dangerously looking for files