@trpc/upgrade 0.0.0-alpha.0 → 0.0.0-alpha.10

package/README.md

@@ -2,6 +2,9 @@ run locally with source files
 
 ```sh
 DEV=1 pnpx tsx path/to/cli.ts
+
+# example
+cd examples/minimal-react/client && DEV=1 pnpx tsx ../../../packages/upgrade/src/bin/cli.ts --force --skipTanstackQuery --verbose
 ```
 
 or compiled

package/dist/cli.cjs

@@ -4,73 +4,100 @@ var cli$1 = require('@effect/cli');
 var platform = require('@effect/platform');
 var platformNode = require('@effect/platform-node');
 var effect = require('effect');
-var ignore = require('ignore');
 var typescript = require('typescript');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var path__default = /*#__PURE__*/_interopDefault(path);
-var ignore__default = /*#__PURE__*/_interopDefault(ignore);
 
-var version = "0.0.0-alpha.0";
+var version = "0.0.0-alpha.10";
 
-platform.Command.string(platform.Command.make('git', 'status')).pipe(effect.Effect.filterOrFail((status)=>status.includes('nothing to commit'), ()=>'Git tree is not clean, please commit your changes before running the migrator'));
+const MakeCommand = (command, ...args)=>{
+    console.log('MakeCommand', command, args, process.cwd());
+    return platform.Command.workingDirectory(process.cwd())(platform.Command.make(command, ...args));
+};
+const assertCleanGitTree = platform.Command.string(MakeCommand('git', 'status')).pipe().pipe(effect.Effect.filterOrFail(effect.String.includes('nothing to commit'), ()=>'Git tree is not clean, please commit your changes and try again, or run with `--force`'));
+const getPackageManager = ()=>effect.Match.value(process.env.npm_config_user_agent ?? 'npm').pipe(effect.Match.when(effect.String.startsWith('pnpm'), ()=>'pnpm'), effect.Match.when(effect.String.startsWith('yarn'), ()=>'yarn'), effect.Match.when(effect.String.startsWith('bun'), ()=>'bun'), effect.Match.orElse(()=>'npm'));
 const installPackage = (packageName)=>{
-    const packageManager = effect.Match.value(process.env.npm_config_user_agent ?? 'npm').pipe(effect.Match.when(effect.String.startsWith('pnpm'), ()=>'pnpm'), effect.Match.when(effect.String.startsWith('yarn'), ()=>'yarn'), effect.Match.when(effect.String.startsWith('bun'), ()=>'bun'), effect.Match.orElse(()=>'npm'));
-    return platform.Command.streamLines(platform.Command.make(packageManager, 'install', packageName)).pipe(effect.Stream.mapEffect(effect.Console.log), effect.Stream.runDrain);
+    const packageManager = getPackageManager();
+    return platform.Command.streamLines(MakeCommand(packageManager, 'install', packageName)).pipe(effect.Stream.mapEffect(effect.Console.log), effect.Stream.runDrain);
+};
+const uninstallPackage = (packageName)=>{
+    const packageManager = getPackageManager();
+    const uninstallCmd = packageManager === 'yarn' ? 'remove' : 'uninstall';
+    return platform.Command.streamLines(MakeCommand(packageManager, uninstallCmd, packageName)).pipe(effect.Stream.mapEffect(effect.Console.log), effect.Stream.runDrain);
 };
 const filterIgnored = (files)=>effect.Effect.gen(function*() {
-        const fs = yield* platform.FileSystem.FileSystem;
-        const ignores = yield* fs.readFileString(path__default.default.join(process.cwd(), '.gitignore')).pipe(effect.Effect.map((content)=>content.split('\n')), effect.Effect.map((patterns)=>ignore__default.default().add(patterns)));
+        const ignores = yield* platform.Command.string(MakeCommand('git', 'check-ignore', '**/*')).pipe(effect.Effect.tap(effect.Effect.log), effect.Effect.map((_)=>_.split('\n')));
+        yield* effect.Effect.logDebug('All files in program:', files.map((_)=>_.fileName));
+        yield* effect.Effect.logDebug('Ignored files:', ignores);
         // Ignore "common files"
-        const relativeFilePaths = files.filter((source)=>!source.fileName.includes('node_modules') && !source.fileName.includes('packages/')).map((file)=>path__default.default.relative(process.cwd(), file.fileName));
-        // As well as gitignored?
-        return ignores.filter(relativeFilePaths);
+        const filteredSourcePaths = files.filter((source)=>source.fileName.startsWith(path__default.default.resolve()) && // only look ahead of current directory
+            !source.fileName.includes('/trpc/packages/') && // relative paths when running codemod locally
+            !ignores.includes(source.fileName)).map((source)=>source.fileName);
+        yield* effect.Effect.logDebug('Filtered files:', filteredSourcePaths);
+        return filteredSourcePaths;
     });
-const Program = effect.Effect.succeed(typescript.findConfigFile(process.cwd(), typescript.sys.fileExists)).pipe(effect.Effect.filterOrFail(effect.Predicate.isNotNullable, ()=>'No tsconfig found'), effect.Effect.tap((_)=>effect.Effect.logDebug('Using tsconfig', _)), effect.Effect.map((_)=>typescript.readConfigFile(_, typescript.sys.readFile)), effect.Effect.map((_)=>typescript.parseJsonConfigFileContent(_.config, typescript.sys, process.cwd())), effect.Effect.map((_)=>typescript.createProgram({
+const TSProgram = effect.Effect.succeed(typescript.findConfigFile(process.cwd(), typescript.sys.fileExists)).pipe(effect.Effect.filterOrFail(effect.Predicate.isNotNullable, ()=>'No tsconfig found'), effect.Effect.tap((_)=>effect.Effect.logDebug('Using tsconfig', _)), effect.Effect.map((_)=>typescript.readConfigFile(_, typescript.sys.readFile)), effect.Effect.map((_)=>typescript.parseJsonConfigFileContent(_.config, typescript.sys, process.cwd())), effect.Effect.map((_)=>typescript.createProgram({
         options: _.options,
         rootNames: _.fileNames,
         configFileParsingDiagnostics: _.errors
     })));
+// FIXME :: hacky
 const transformPath = (path)=>process.env.DEV ? path : path.replace('../', './').replace('.ts', '.cjs');
-const prompts = cli$1.Command.prompt('transforms', cli$1.Prompt.multiSelect({
-    message: 'Select transforms to run',
-    choices: [
-        {
-            title: 'Migrate Hooks to xxxOptions API',
-            value: require.resolve(transformPath('../transforms/hooksToOptions.ts'))
-        },
-        {
-            title: 'Migrate context provider setup',
-            value: require.resolve(transformPath('../transforms/provider.ts'))
+const force = cli$1.Options.boolean('force').pipe(cli$1.Options.withAlias('f'), cli$1.Options.withDefault(false), cli$1.Options.withDescription('Skip git status check, use with caution'));
+/**
+ * TODO: Instead of default values these should be detected automatically from the TS program
+ */ const trpcFile = cli$1.Options.text('trpcFile').pipe(cli$1.Options.withAlias('f'), cli$1.Options.withDefault('~/trpc'), cli$1.Options.withDescription('Path to the trpc import file'));
+const trpcImportName = cli$1.Options.text('trpcImportName').pipe(cli$1.Options.withAlias('i'), cli$1.Options.withDefault('trpc'), cli$1.Options.withDescription('Name of the trpc import'));
+const skipTanstackQuery = cli$1.Options.boolean('skipTanstackQuery').pipe(cli$1.Options.withAlias('q'), cli$1.Options.withDefault(false), cli$1.Options.withDescription('Skip installing @trpc/tanstack-react-query package'));
+const verbose = cli$1.Options.boolean('verbose').pipe(cli$1.Options.withAlias('v'), cli$1.Options.withDefault(false), cli$1.Options.withDescription('Enable verbose logging'));
+const rootComamnd = cli$1.Command.make('upgrade', {
+    force,
+    trpcFile,
+    trpcImportName,
+    skipTanstackQuery,
+    verbose
+}, (args)=>effect.Effect.gen(function*() {
+        if (args.verbose) {
+            yield* effect.Effect.log('Running upgrade with args:', args);
         }
-    ]
-}), (_)=>effect.Effect.gen(function*() {
-        // yield* assertCleanGitTree;
-        const program = yield* Program;
+        if (!args.force) {
+            yield* assertCleanGitTree;
+        }
+        const transforms = yield* effect.pipe(cli$1.Prompt.multiSelect({
+            message: 'Select transforms to run',
+            choices: [
+                {
+                    title: 'Migrate Hooks to xxxOptions API',
+                    value: require.resolve(transformPath('../transforms/hooksToOptions.ts'))
+                },
+                {
+                    title: 'Migrate context provider setup',
+                    value: require.resolve(transformPath('../transforms/provider.ts'))
+                }
+            ]
+        }), effect.Effect.flatMap((selected)=>{
+            if (selected.length === 0) {
+                return effect.Effect.fail(new Error('Please select at least one transform to run'));
+            }
+            return effect.Effect.succeed(selected);
+        }), effect.Effect.map(// Make sure provider transform runs first if it's selected
+        effect.Array.sortWith((a)=>!a.includes('provider.ts'), effect.Order.boolean)));
+        const program = yield* TSProgram;
         const sourceFiles = program.getSourceFiles();
-        // Make sure provider transform runs first if it's selected
-        _.sort((a, b)=>a.includes('provider.ts') ? -1 : b.includes('provider.ts') ? 1 : 0);
-        /**
-       * TODO: Detect these automatically
-       */ const appRouterImportFile = '~/server/routers/_app';
-        const appRouterImportName = 'AppRouter';
-        const trpcFile = '~/lib/trpc';
-        const trpcImportName = 'trpc';
         const commitedFiles = yield* filterIgnored(sourceFiles);
-        yield* effect.Effect.forEach(_, (transform)=>{
-            return effect.pipe(effect.Effect.log('Running transform', transform), effect.Effect.flatMap(()=>effect.Effect.tryPromise(async ()=>import('jscodeshift/src/Runner.js').then(({ run })=>run(transform.replace('file://', ''), commitedFiles, {
-                            appRouterImportFile,
-                            appRouterImportName,
-                            trpcFile,
-                            trpcImportName
-                        })))), effect.Effect.map((res)=>effect.Effect.log('Transform result', res)));
+        yield* effect.Effect.forEach(transforms, (transform)=>{
+            return effect.pipe(effect.Effect.log('Running transform', transform), effect.Effect.flatMap(()=>effect.Effect.tryPromise(async ()=>import('jscodeshift/src/Runner.js').then(({ run })=>run(transform, commitedFiles, args)))), effect.Effect.map((_)=>effect.Effect.log('Transform result', _)));
         });
-        yield* effect.Effect.log('Installing @trpc/tanstack-react-query');
-        yield* installPackage('@trpc/tanstack-react-query');
-    // TODO: Format project
-    }));
-const cli = cli$1.Command.run(prompts, {
+        if (!args.skipTanstackQuery) {
+            yield* effect.Effect.log('Installing @trpc/tanstack-react-query');
+            yield* installPackage('@trpc/tanstack-react-query');
+            yield* effect.Effect.log('Uninstalling @trpc/react-query');
+            yield* uninstallPackage('@trpc/react-query');
+        }
+    }).pipe(effect.Logger.withMinimumLogLevel(args.verbose ? effect.LogLevel.Debug : effect.LogLevel.Info)));
+const cli = cli$1.Command.run(rootComamnd, {
     name: 'tRPC Upgrade CLI',
     version: `v${version}`
 });

package/dist/transforms/hooksToOptions.cjs

@@ -43,59 +43,50 @@ const utilMap = {
     getInfiniteData: 'getInfiniteQueryData'
 };
 function transform(file, api, options) {
-    const { trpcFile, trpcImportName } = options;
-    if (!trpcFile || !trpcImportName) {
-        throw new Error('trpcFile and trpcImportName are required');
+    const { trpcImportName } = options;
+    if (!trpcImportName) {
+        throw new Error('trpcImportName is required');
     }
     const j = api.jscodeshift;
     const root = j(file.source);
     let dirtyFlag = false;
     // Traverse all functions, and _do stuff_
     root.find(j.FunctionDeclaration).forEach((path)=>{
-        if (j(path).find(j.Identifier, {
-            name: trpcImportName
-        }).size() > 0) {
-            updateTRPCImport(path);
-        }
         replaceHooksWithOptions(path);
         removeSuspenseDestructuring(path);
         migrateUseUtils(path);
     });
     root.find(j.ArrowFunctionExpression).forEach((path)=>{
-        if (j(path).find(j.Identifier, {
-            name: trpcImportName
-        }).size() > 0) {
-            updateTRPCImport(path);
-        }
         replaceHooksWithOptions(path);
         removeSuspenseDestructuring(path);
         migrateUseUtils(path);
     });
+    if (dirtyFlag) {
+        updateTRPCImport();
+    }
     /**
    * === HELPER FUNCTIONS BELOW ===
-   */ function updateTRPCImport(path) {
-        const specifier = root.find(j.ImportDeclaration, {
-            source: {
-                value: trpcFile
-            }
-        }).find(j.ImportSpecifier, {
-            imported: {
-                name: trpcImportName
-            }
-        });
-        if (specifier.size() === 0) {
-            return;
-        }
-        specifier.replaceWith(j.importSpecifier(j.identifier('useTRPC')));
-        dirtyFlag = true;
+   */ function ensureUseTRPCCall(path) {
         const variableDeclaration = j.variableDeclaration('const', [
             j.variableDeclarator(j.identifier(trpcImportName), j.callExpression(j.identifier('useTRPC'), []))
         ]);
         if (j.FunctionDeclaration.check(path.node)) {
-            const body = path.node.body.body;
-            body.unshift(variableDeclaration);
+            path.node.body.body.unshift(variableDeclaration);
+            dirtyFlag = true;
         } else if (j.BlockStatement.check(path.node.body)) {
             path.node.body.body.unshift(variableDeclaration);
+            dirtyFlag = true;
+        }
+    }
+    function updateTRPCImport() {
+        const specifier = root.find(j.ImportSpecifier, {
+            imported: {
+                name: trpcImportName
+            }
+        });
+        if (specifier.size() > 0) {
+            specifier.replaceWith(j.importSpecifier(j.identifier('useTRPC')));
+            dirtyFlag = true;
         }
     }
     function ensureImported(lib, specifier) {
@@ -114,10 +105,11 @@ function transform(file, api, options) {
             dirtyFlag = true;
         }
     }
-    function replaceHooksWithOptions(path) {
+    function replaceHooksWithOptions(fnPath) {
         // REplace proxy-hooks with useX(options())
+        let hasInserted = false;
         for (const [hook, { fn, lib }] of Object.entries(hookToOptions)){
-            j(path).find(j.CallExpression, {
+            j(fnPath).find(j.CallExpression, {
                 callee: {
                     property: {
                         name: hook
@@ -131,6 +123,10 @@ function transform(file, api, options) {
                 }
                 // Rename the hook to the options function
                 memberExpr.property.name = fn;
+                if (!hasInserted) {
+                    ensureUseTRPCCall(fnPath);
+                    hasInserted = true;
+                }
                 // Wrap it in the hook call
                 j(path).replaceWith(j.callExpression(j.identifier(hook), [
                     path.node
@@ -172,7 +168,7 @@ function transform(file, api, options) {
                         }
                         // Replace util.PATH.proxyMethod() with trpc.PATH.queryFilter()
                         const proxyMethod = memberExpr.property.name;
-                        memberExpr.object.object = j.identifier('trpc');
+                        memberExpr.object.object = j.identifier(trpcImportName);
                         memberExpr.property = j.identifier('queryFilter');
                         // Wrap it in queryClient.utilMethod()
                         j(callExprPath).replaceWith(j.memberExpression(j.identifier('queryClient'), j.callExpression(j.identifier(utilMap[proxyMethod]), [
@@ -198,11 +194,10 @@ function transform(file, api, options) {
             ].includes(declarator.init.callee.name)) {
                 return;
             }
-            console.log(declarator.init.callee.name);
             const tuple = j.ArrayPattern.check(declarator?.id) ? declarator.id : null;
             const dataName = j.Identifier.check(tuple?.elements?.[0]) ? tuple.elements[0].name : null;
             const queryName = j.Identifier.check(tuple?.elements?.[1]) ? tuple.elements[1].name : null;
-            if (declarator && queryName) {
+            if (queryName) {
                 declarator.id = j.identifier(queryName);
                 dirtyFlag = true;
                 if (dataName) {
@@ -210,12 +205,18 @@ function transform(file, api, options) {
                         j.variableDeclarator(j.identifier(dataName), j.memberExpression(declarator.id, j.identifier('data')))
                     ]));
                 }
+            } else if (dataName) {
+                // const [dataName] = ... => const { data: dataName } = ...
+                declarator.id = j.objectPattern([
+                    j.property('init', j.identifier('data'), j.identifier(dataName))
+                ]);
+                dirtyFlag = true;
             }
         });
     }
     return dirtyFlag ? root.toSource() : undefined;
 }
-const parser = 'tsx'; // https://go.codemod.com/ddX54TM
+const parser = 'tsx';
 
 exports.default = transform;
 exports.parser = parser;

package/dist/transforms/provider.cjs

@@ -1,26 +1,18 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 function transform(file, api, options) {
-    const { trpcFile, trpcImportName, appRouterImportFile, appRouterImportName } = options;
+    const { trpcImportName } = options;
+    let routerName = undefined;
     const j = api.jscodeshift;
     const root = j(file.source);
     let dirtyFlag = false;
-    function upsertAppRouterImport() {
-        if (root.find(j.ImportDeclaration, {
-            source: {
-                value: appRouterImportFile
-            }
-        }).size() === 0) {
-            root.find(j.ImportDeclaration).at(-1).insertAfter(j.importDeclaration([
-                j.importSpecifier(j.identifier(appRouterImportName))
-            ], j.literal(appRouterImportFile), 'type'));
-        }
-    }
     // Find the variable declaration for `trpc`
     root.find(j.VariableDeclaration).forEach((path)=>{
         const declaration = path.node.declarations[0];
         if (j.Identifier.check(declaration.id) && declaration.id.name === trpcImportName) {
             if (j.CallExpression.check(declaration.init) && j.Identifier.check(declaration.init.callee) && declaration.init.callee.name === 'createTRPCReact') {
+                // Get router name ( TODO : should probably get this from the TS compiler along with the import path)
+                routerName = declaration.init.original?.typeParameters?.params?.[0]?.typeName?.name;
                 // Replace the `createTRPCReact` call with `createTRPCContext`
                 declaration.init.callee.name = 'createTRPCContext';
                 // Destructure the result into `TRPCProvider` and `useTRPC`
@@ -57,7 +49,7 @@ function transform(file, api, options) {
             });
         });
     }
-    // Replace trpc.createClient with createTRPCClient
+    // Replace trpc.createClient with createTRPCClient<TRouter>
     root.find(j.CallExpression, {
         callee: {
             object: {
@@ -69,12 +61,12 @@ function transform(file, api, options) {
         }
     }).forEach((path)=>{
         path.node.callee = j.identifier('createTRPCClient');
-        // Add the type parameter `<AppRouter>`
-        path.node.typeParameters = j.tsTypeParameterInstantiation([
-            j.tsTypeReference(j.identifier(appRouterImportName))
-        ]);
-        upsertAppRouterImport();
         dirtyFlag = true;
+        if (routerName) {
+            path.node.typeParameters = j.tsTypeParameterInstantiation([
+                j.tsTypeReference(j.identifier(routerName))
+            ]);
+        }
     });
     // Replace <trpc.Provider client={...} with <TRPCProvider trpcClient={...}
     root.find(j.JSXElement, {
@@ -112,14 +104,12 @@ function transform(file, api, options) {
             path.node.specifiers?.push(createTRPCClientImport);
         });
         // Replace trpc import with TRPCProvider
-        root.find(j.ImportDeclaration, {
-            source: {
-                value: trpcFile
+        root.find(j.ImportSpecifier, {
+            imported: {
+                name: trpcImportName
             }
         }).forEach((path)=>{
-            path.node.specifiers = [
-                j.importSpecifier(j.identifier('TRPCProvider'))
-            ];
+            path.node.name = j.identifier('TRPCProvider');
         });
     }
     return dirtyFlag ? root.toSource() : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trpc/upgrade",
-  "version": "0.0.0-alpha.0",
+  "version": "0.0.0-alpha.10",
   "description": "Upgrade scripts for tRPC",
   "author": "juliusmarminge",
   "license": "MIT",
@@ -28,11 +28,10 @@
     "!**/__tests__"
   ],
   "dependencies": {
-    "@effect/cli": "0.48.25",
-    "@effect/platform": "0.69.25",
-    "@effect/platform-node": "0.64.27",
-    "effect": "3.10.16",
-    "ignore": "^6.0.2",
+    "@effect/cli": "0.54.4",
+    "@effect/platform": "0.75.4",
+    "@effect/platform-node": "0.71.4",
+    "effect": "3.12.10",
     "jscodeshift": "17.1.1",
     "typescript": "^5.6.2"
   },

package/src/bin/cli.ts

@@ -1,18 +1,21 @@
 /* eslint-disable @typescript-eslint/unbound-method */
 import path from 'path';
-import { Command as CLICommand, Prompt } from '@effect/cli';
-import { Command, FileSystem } from '@effect/platform';
+import { Command as CLICommand, Options, Prompt } from '@effect/cli';
+import { Command } from '@effect/platform';
 import { NodeContext, NodeRuntime } from '@effect/platform-node';
 import {
+  Array,
   Console,
   Effect,
+  Logger,
+  LogLevel,
   Match,
+  Order,
   pipe,
   Predicate,
   Stream,
   String,
 } from 'effect';
-import ignore from 'ignore';
 import type { SourceFile } from 'typescript';
 import {
   createProgram,
@@ -23,52 +26,76 @@ import {
 } from 'typescript';
 import { version } from '../../package.json';
 
-const assertCleanGitTree = Command.string(Command.make('git', 'status')).pipe(
-  Effect.filterOrFail(
-    (status) => status.includes('nothing to commit'),
-    () =>
-      'Git tree is not clean, please commit your changes before running the migrator',
-  ),
-);
+const MakeCommand = (command: string, ...args: string[]) => {
+  console.log('MakeCommand', command, args, process.cwd());
+  return Command.workingDirectory(process.cwd())(
+    Command.make(command, ...args),
+  );
+};
 
-const installPackage = (packageName: string) => {
-  const packageManager = Match.value(
-    process.env.npm_config_user_agent ?? 'npm',
-  ).pipe(
+const assertCleanGitTree = Command.string(MakeCommand('git', 'status'))
+  .pipe()
+  .pipe(
+    Effect.filterOrFail(
+      String.includes('nothing to commit'),
+      () =>
+        'Git tree is not clean, please commit your changes and try again, or run with `--force`',
+    ),
+  );
+const getPackageManager = () =>
+  Match.value(process.env.npm_config_user_agent ?? 'npm').pipe(
     Match.when(String.startsWith('pnpm'), () => 'pnpm'),
     Match.when(String.startsWith('yarn'), () => 'yarn'),
     Match.when(String.startsWith('bun'), () => 'bun'),
     Match.orElse(() => 'npm'),
   );
+
+const installPackage = (packageName: string) => {
+  const packageManager = getPackageManager();
   return Command.streamLines(
-    Command.make(packageManager, 'install', packageName),
+    MakeCommand(packageManager, 'install', packageName),
+  ).pipe(Stream.mapEffect(Console.log), Stream.runDrain);
+};
+
+const uninstallPackage = (packageName: string) => {
+  const packageManager = getPackageManager();
+  const uninstallCmd = packageManager === 'yarn' ? 'remove' : 'uninstall';
+  return Command.streamLines(
+    MakeCommand(packageManager, uninstallCmd, packageName),
   ).pipe(Stream.mapEffect(Console.log), Stream.runDrain);
 };
 
 const filterIgnored = (files: readonly SourceFile[]) =>
   Effect.gen(function* () {
-    const fs = yield* FileSystem.FileSystem;
-    const ignores = yield* fs
-      .readFileString(path.join(process.cwd(), '.gitignore'))
-      .pipe(
-        Effect.map((content) => content.split('\n')),
-        Effect.map((patterns) => ignore().add(patterns)),
-      );
+    const ignores = yield* Command.string(
+      MakeCommand('git', 'check-ignore', '**/*'),
+    ).pipe(
+      Effect.tap(Effect.log),
+      Effect.map((_) => _.split('\n')),
+    );
+
+    yield* Effect.logDebug(
+      'All files in program:',
+      files.map((_) => _.fileName),
+    );
+    yield* Effect.logDebug('Ignored files:', ignores);
 
     // Ignore "common files"
-    const relativeFilePaths = files
+    const filteredSourcePaths = files
       .filter(
         (source) =>
-          !source.fileName.includes('node_modules') &&
-          !source.fileName.includes('packages/'),
+          source.fileName.startsWith(path.resolve()) && // only look ahead of current directory
+          !source.fileName.includes('/trpc/packages/') && // relative paths when running codemod locally
+          !ignores.includes(source.fileName), // ignored files
       )
-      .map((file) => path.relative(process.cwd(), file.fileName));
+      .map((source) => source.fileName);
+
+    yield* Effect.logDebug('Filtered files:', filteredSourcePaths);
 
-    // As well as gitignored?
-    return ignores.filter(relativeFilePaths);
+    return filteredSourcePaths;
   });
 
-const Program = Effect.succeed(
+const TSProgram = Effect.succeed(
   findConfigFile(process.cwd(), sys.fileExists),
 ).pipe(
   Effect.filterOrFail(Predicate.isNotNullable, () => 'No tsconfig found'),
@@ -84,73 +111,123 @@ const Program = Effect.succeed(
   ),
 );
 
+// FIXME :: hacky
 const transformPath = (path: string) =>
   process.env.DEV ? path : path.replace('../', './').replace('.ts', '.cjs');
 
-const prompts = CLICommand.prompt(
-  'transforms',
-  Prompt.multiSelect({
-    message: 'Select transforms to run',
-    choices: [
-      {
-        title: 'Migrate Hooks to xxxOptions API',
-        value: require.resolve(
-          transformPath('../transforms/hooksToOptions.ts'),
-        ),
-      },
-      {
-        title: 'Migrate context provider setup',
-        value: require.resolve(transformPath('../transforms/provider.ts')),
-      },
-    ],
-  }),
-  (_) =>
-    Effect.gen(function* () {
-      // yield* assertCleanGitTree;
-      const program = yield* Program;
-      const sourceFiles = program.getSourceFiles();
+const force = Options.boolean('force').pipe(
+  Options.withAlias('f'),
+  Options.withDefault(false),
+  Options.withDescription('Skip git status check, use with caution'),
+);
+
+/**
+ * TODO: Instead of default values these should be detected automatically from the TS program
+ */
+const trpcFile = Options.text('trpcFile').pipe(
+  Options.withAlias('f'),
+  Options.withDefault('~/trpc'),
+  Options.withDescription('Path to the trpc import file'),
+);
+
+const trpcImportName = Options.text('trpcImportName').pipe(
+  Options.withAlias('i'),
+  Options.withDefault('trpc'),
+  Options.withDescription('Name of the trpc import'),
+);
+
+const skipTanstackQuery = Options.boolean('skipTanstackQuery').pipe(
+  Options.withAlias('q'),
+  Options.withDefault(false),
+  Options.withDescription('Skip installing @trpc/tanstack-react-query package'),
+);
 
-      // Make sure provider transform runs first if it's selected
-      _.sort((a, b) =>
-        a.includes('provider.ts') ? -1 : b.includes('provider.ts') ? 1 : 0,
+const verbose = Options.boolean('verbose').pipe(
+  Options.withAlias('v'),
+  Options.withDefault(false),
+  Options.withDescription('Enable verbose logging'),
+);
+
+const rootComamnd = CLICommand.make(
+  'upgrade',
+  {
+    force,
+    trpcFile,
+    trpcImportName,
+    skipTanstackQuery,
+    verbose,
+  },
+  (args) =>
+    Effect.gen(function* () {
+      if (args.verbose) {
+        yield* Effect.log('Running upgrade with args:', args);
+      }
+      if (!args.force) {
+        yield* assertCleanGitTree;
+      }
+      const transforms = yield* pipe(
+        Prompt.multiSelect({
+          message: 'Select transforms to run',
+          choices: [
+            {
+              title: 'Migrate Hooks to xxxOptions API',
+              value: require.resolve(
+                transformPath('../transforms/hooksToOptions.ts'),
+              ),
+            },
+            {
+              title: 'Migrate context provider setup',
+              value: require.resolve(
+                transformPath('../transforms/provider.ts'),
+              ),
+            },
+          ],
+        }),
+        Effect.flatMap((selected) => {
+          if (selected.length === 0) {
+            return Effect.fail(
+              new Error('Please select at least one transform to run'),
+            );
+          }
+          return Effect.succeed(selected);
+        }),
+        Effect.map(
+          // Make sure provider transform runs first if it's selected
+          Array.sortWith((a) => !a.includes('provider.ts'), Order.boolean),
+        ),
       );
 
-      /**
-       * TODO: Detect these automatically
-       */
-      const appRouterImportFile = '~/server/routers/_app';
-      const appRouterImportName = 'AppRouter';
-      const trpcFile = '~/lib/trpc';
-      const trpcImportName = 'trpc';
+      const program = yield* TSProgram;
+      const sourceFiles = program.getSourceFiles();
 
       const commitedFiles = yield* filterIgnored(sourceFiles);
-      yield* Effect.forEach(_, (transform) => {
+      yield* Effect.forEach(transforms, (transform) => {
         return pipe(
           Effect.log('Running transform', transform),
           Effect.flatMap(() =>
             Effect.tryPromise(async () =>
               import('jscodeshift/src/Runner.js').then(({ run }) =>
-                run(transform.replace('file://', ''), commitedFiles, {
-                  appRouterImportFile,
-                  appRouterImportName,
-                  trpcFile,
-                  trpcImportName,
-                }),
+                run(transform, commitedFiles, args),
               ),
             ),
           ),
-          Effect.map((res) => Effect.log('Transform result', res)),
+          Effect.map((_) => Effect.log('Transform result', _)),
         );
       });
 
-      yield* Effect.log('Installing @trpc/tanstack-react-query');
-      yield* installPackage('@trpc/tanstack-react-query');
+      if (!args.skipTanstackQuery) {
+        yield* Effect.log('Installing @trpc/tanstack-react-query');
+        yield* installPackage('@trpc/tanstack-react-query');
 
-      // TODO: Format project
-    }),
+        yield* Effect.log('Uninstalling @trpc/react-query');
+        yield* uninstallPackage('@trpc/react-query');
+      }
+    }).pipe(
+      Logger.withMinimumLogLevel(args.verbose ? LogLevel.Debug : LogLevel.Info),
+    ),
 );
 
-const cli = CLICommand.run(prompts, {
+const cli = CLICommand.run(rootComamnd, {
   name: 'tRPC Upgrade CLI',
   version: `v${version}`,
 });

package/src/transforms/hooksToOptions.ts

@@ -13,7 +13,6 @@ import type {
 } from 'jscodeshift';
 
 interface TransformOptions extends Options {
-  trpcFile?: string;
   trpcImportName?: string;
 }
 
@@ -61,9 +60,9 @@ export default function transform(
   api: API,
   options: TransformOptions,
 ) {
-  const { trpcFile, trpcImportName } = options;
-  if (!trpcFile || !trpcImportName) {
-    throw new Error('trpcFile and trpcImportName are required');
+  const { trpcImportName } = options;
+  if (!trpcImportName) {
+    throw new Error('trpcImportName is required');
   }
 
   const j = api.jscodeshift;
@@ -72,44 +71,27 @@ export default function transform(
 
   // Traverse all functions, and _do stuff_
   root.find(j.FunctionDeclaration).forEach((path) => {
-    if (j(path).find(j.Identifier, { name: trpcImportName }).size() > 0) {
-      updateTRPCImport(path);
-    }
-
     replaceHooksWithOptions(path);
     removeSuspenseDestructuring(path);
     migrateUseUtils(path);
   });
   root.find(j.ArrowFunctionExpression).forEach((path) => {
-    if (j(path).find(j.Identifier, { name: trpcImportName }).size() > 0) {
-      updateTRPCImport(path);
-    }
-
     replaceHooksWithOptions(path);
     removeSuspenseDestructuring(path);
     migrateUseUtils(path);
   });
 
+  if (dirtyFlag) {
+    updateTRPCImport();
+  }
+
   /**
    * === HELPER FUNCTIONS BELOW ===
    */
 
-  function updateTRPCImport(
+  function ensureUseTRPCCall(
     path: ASTPath<FunctionDeclaration | ArrowFunctionExpression>,
   ) {
-    const specifier = root
-      .find(j.ImportDeclaration, {
-        source: { value: trpcFile },
-      })
-      .find(j.ImportSpecifier, { imported: { name: trpcImportName } });
-
-    if (specifier.size() === 0) {
-      return;
-    }
-
-    specifier.replaceWith(j.importSpecifier(j.identifier('useTRPC')));
-    dirtyFlag = true;
-
     const variableDeclaration = j.variableDeclaration('const', [
       j.variableDeclarator(
         j.identifier(trpcImportName!),
@@ -118,10 +100,21 @@ export default function transform(
     ]);
 
     if (j.FunctionDeclaration.check(path.node)) {
-      const body = path.node.body.body;
-      body.unshift(variableDeclaration);
+      path.node.body.body.unshift(variableDeclaration);
+      dirtyFlag = true;
     } else if (j.BlockStatement.check(path.node.body)) {
       path.node.body.body.unshift(variableDeclaration);
+      dirtyFlag = true;
+    }
+  }
+
+  function updateTRPCImport() {
+    const specifier = root.find(j.ImportSpecifier, {
+      imported: { name: trpcImportName },
+    });
+    if (specifier.size() > 0) {
+      specifier.replaceWith(j.importSpecifier(j.identifier('useTRPC')));
+      dirtyFlag = true;
     }
   }
 
@@ -148,11 +141,12 @@ export default function transform(
   }
 
   function replaceHooksWithOptions(
-    path: ASTPath<FunctionDeclaration | ArrowFunctionExpression>,
+    fnPath: ASTPath<FunctionDeclaration | ArrowFunctionExpression>,
   ) {
     // REplace proxy-hooks with useX(options())
+    let hasInserted = false;
     for (const [hook, { fn, lib }] of Object.entries(hookToOptions)) {
-      j(path)
+      j(fnPath)
         .find(j.CallExpression, {
           callee: {
             property: { name: hook },
@@ -171,6 +165,11 @@ export default function transform(
           // Rename the hook to the options function
           memberExpr.property.name = fn;
 
+          if (!hasInserted) {
+            ensureUseTRPCCall(fnPath);
+            hasInserted = true;
+          }
+
           // Wrap it in the hook call
           j(path).replaceWith(
             j.callExpression(j.identifier(hook), [path.node]),
@@ -237,7 +236,7 @@ export default function transform(
 
                 // Replace util.PATH.proxyMethod() with trpc.PATH.queryFilter()
                 const proxyMethod = memberExpr.property.name as ProxyMethod;
-                memberExpr.object.object = j.identifier('trpc');
+                memberExpr.object.object = j.identifier(trpcImportName!);
                 memberExpr.property = j.identifier('queryFilter');
 
                 // Wrap it in queryClient.utilMethod()
@@ -285,8 +284,6 @@ export default function transform(
           return;
         }
 
-        console.log(declarator.init.callee.name);
-
         const tuple = j.ArrayPattern.check(declarator?.id)
           ? declarator.id
           : null;
@@ -297,7 +294,7 @@ export default function transform(
           ? tuple.elements[1].name
           : null;
 
-        if (declarator && queryName) {
+        if (queryName) {
           declarator.id = j.identifier(queryName);
           dirtyFlag = true;
 
@@ -311,6 +308,12 @@ export default function transform(
               ]),
             );
           }
+        } else if (dataName) {
+          // const [dataName] = ... => const { data: dataName } = ...
+          declarator.id = j.objectPattern([
+            j.property('init', j.identifier('data'), j.identifier(dataName)),
+          ]);
+          dirtyFlag = true;
         }
       });
   }
@@ -319,5 +322,3 @@ export default function transform(
 }
 
 export const parser = 'tsx';
-
-// https://go.codemod.com/ddX54TM

package/src/transforms/provider.ts

@@ -1,7 +1,6 @@
 import type { API, FileInfo, Options } from 'jscodeshift';
 
 interface TransformOptions extends Options {
-  trpcFile?: string;
   trpcImportName?: string;
 }
 
@@ -10,32 +9,13 @@ export default function transform(
   api: API,
   options: TransformOptions,
 ) {
-  const { trpcFile, trpcImportName, appRouterImportFile, appRouterImportName } =
-    options;
+  const { trpcImportName } = options;
+  let routerName: string | undefined = undefined;
 
   const j = api.jscodeshift;
   const root = j(file.source);
   let dirtyFlag = false;
 
-  function upsertAppRouterImport() {
-    if (
-      root
-        .find(j.ImportDeclaration, { source: { value: appRouterImportFile } })
-        .size() === 0
-    ) {
-      root
-        .find(j.ImportDeclaration)
-        .at(-1)
-        .insertAfter(
-          j.importDeclaration(
-            [j.importSpecifier(j.identifier(appRouterImportName))],
-            j.literal(appRouterImportFile),
-            'type',
-          ),
-        );
-    }
-  }
-
   // Find the variable declaration for `trpc`
   root.find(j.VariableDeclaration).forEach((path) => {
     const declaration = path.node.declarations[0];
@@ -48,6 +28,11 @@ export default function transform(
         j.Identifier.check(declaration.init.callee) &&
         declaration.init.callee.name === 'createTRPCReact'
       ) {
+        // Get router name ( TODO : should probably get this from the TS compiler along with the import path)
+        routerName =
+          declaration.init.original?.typeParameters?.params?.[0]?.typeName
+            ?.name;
+
         // Replace the `createTRPCReact` call with `createTRPCContext`
         declaration.init.callee.name = 'createTRPCContext';
 
@@ -89,7 +74,7 @@ export default function transform(
       });
   }
 
-  // Replace trpc.createClient with createTRPCClient
+  // Replace trpc.createClient with createTRPCClient<TRouter>
   root
     .find(j.CallExpression, {
       callee: {
@@ -99,12 +84,13 @@ export default function transform(
     })
     .forEach((path) => {
       path.node.callee = j.identifier('createTRPCClient');
-      // Add the type parameter `<AppRouter>`
-      path.node.typeParameters = j.tsTypeParameterInstantiation([
-        j.tsTypeReference(j.identifier(appRouterImportName)),
-      ]);
-      upsertAppRouterImport();
       dirtyFlag = true;
+
+      if (routerName) {
+        (path.node as any).typeParameters = j.tsTypeParameterInstantiation([
+          j.tsTypeReference(j.identifier(routerName)),
+        ]);
+      }
     });
 
   // Replace <trpc.Provider client={...} with <TRPCProvider trpcClient={...}
@@ -146,13 +132,11 @@ export default function transform(
 
     // Replace trpc import with TRPCProvider
     root
-      .find(j.ImportDeclaration, {
-        source: { value: trpcFile },
+      .find(j.ImportSpecifier, {
+        imported: { name: trpcImportName },
       })
       .forEach((path) => {
-        path.node.specifiers = [
-          j.importSpecifier(j.identifier('TRPCProvider')),
-        ];
+        path.node.name = j.identifier('TRPCProvider');
       });
   }