applyTransfrom now returns a promise

Author: danieldelcore

.changeset/large-tools-fly.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/test-utils': minor
+---
+
+applyTransfrom now returns a promise to support async transforms

community/@atlaskit__avatar/18.0.0/__tests__/transform.spec.ts

@@ -6,8 +6,8 @@ import * as transformer from '../transform';
 const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
 
 describe('Update Avatar props', () => {
-  it('should wrap avatar in a tooltip if name is defined', () => {
-    const result = applyTransform(
+  it('should wrap avatar in a tooltip if name is defined', async () => {
+    const result = await applyTransform(
       transformer,
       `
         import Avatar from '@atlaskit/avatar';

community/@emotion__monorepo/11.0.0/transform.spec.ts

@@ -2,8 +2,8 @@ import { applyTransform } from '@codeshift/test-utils';
 import * as transformer from './transform';
 
 describe('@emotion@11.0.0 transform', () => {
-  it('should transform imports correctly', () => {
-    const result = applyTransform(
+  it('should transform imports correctly', async () => {
+    const result = await applyTransform(
       transformer,
       `
         import * as core from '@emotion/core';

community/memoize-one/5.0.0/transform.spec.ts

@@ -17,8 +17,8 @@ function format(source: string): string {
 }
 
 describe('memoize-one@5.0.0 transform', () => {
-  it('should not touch usages that do not use a custom equality function', () => {
-    const result = applyTransform(
+  it('should not touch usages that do not use a custom equality function', async () => {
+    const result = await applyTransform(
       transformer,
       format(`
         import memoize from 'memoize-one';
@@ -45,8 +45,8 @@ describe('memoize-one@5.0.0 transform', () => {
     );
   });
 
-  it('should wrap inline equality arrow functions', () => {
-    const result = applyTransform(
+  it('should wrap inline equality arrow functions', async () => {
+    const result = await applyTransform(
       transformer,
       format(`
         import memoize from 'memoize-one';
@@ -85,8 +85,8 @@ describe('memoize-one@5.0.0 transform', () => {
     );
   });
 
-  it('should wrap inline equality function declarations', () => {
-    const result = applyTransform(
+  it('should wrap inline equality function declarations', async () => {
+    const result = await applyTransform(
       transformer,
       format(`
         import memoize from 'memoize-one';
@@ -125,8 +125,8 @@ describe('memoize-one@5.0.0 transform', () => {
     );
   });
 
-  it('should wrap function identifiers', () => {
-    const result = applyTransform(
+  it('should wrap function identifiers', async () => {
+    const result = await applyTransform(
       transformer,
       format(`
         import memoize from 'memoize-one';
@@ -162,8 +162,8 @@ describe('memoize-one@5.0.0 transform', () => {
     );
   });
 
-  it('should add a comment when an unsupported equality fn is encountered', () => {
-    const result = applyTransform(
+  it('should add a comment when an unsupported equality fn is encountered', async () => {
+    const result = await applyTransform(
       transformer,
       format(`
         import memoize from 'memoize-one';

packages/test-utils/src/apply-transform.ts

@@ -6,7 +6,7 @@ interface Options {
   parser?: Parser;
 }
 
-export default function applyTransform(
+export default async function applyTransform(
   transform: any,
   input: string,
   options: Options = {
@@ -15,7 +15,7 @@ export default function applyTransform(
 ) {
   // Handle ES6 modules using default export for the transform
   const transformer = transform.default ? transform.default : transform;
-  const output = transformer(
+  const output = await transformer(
     { source: input },
     {
       jscodeshift: jscodeshift.withParser(options.parser as string),

website/docs/api/codeshift-test-utils.mdx

@@ -25,16 +25,16 @@ We provide this method as opposed to [jscodeshift's test utils](https://github.c
 
 **Returns**
 
-`string`: Resulting file after transform has been applied
+`Promise<string>`: Resulting file after transform has been applied
 
 **Example**
 
 ```jsx
 import * as transformer from '../transform';
 import { applyTransform } from '@codeshift/test-utils';
 
-it('should wrap avatar in a tooltip if name is defined', () => {
-  const result = applyTransform(
+it('should wrap avatar in a tooltip if name is defined', async () => {
+  const result = await applyTransform(
     transformer,
     `
       import Avatar from 'avatar';

website/docs/testing.mdx

@@ -36,8 +36,8 @@ In this case, you would be able to write a simple test using `jest` & `@codeshif
 import * as transformer from '../transform';
 import { applyTransform } from '@codeshift/test-utils';
 
-it('should remove all deleted props', () => {
-  const result = applyTransform(
+it('should remove all deleted props', async () => {
+  const result = await applyTransform(
     transformer,
     `
       import Foo from '@mylib/foo';