@trpc/upgrade 0.0.0-alpha.27 → 0.0.0-alpha.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trpc/upgrade",
-  "version": "0.0.0-alpha.27",
+  "version": "0.0.0-alpha.28",
   "description": "Upgrade scripts for tRPC",
   "author": "juliusmarminge",
   "license": "MIT",

package/src/bin/index.ts

@@ -1,225 +1,98 @@
 #!/usr/bin/env node
-/* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable no-console */
-import * as CP from 'node:child_process';
-import * as Path from 'node:path';
-import * as Util from 'node:util';
-import * as Args from '@bomb.sh/args';
-import * as p from '@clack/prompts';
-import * as ts from 'typescript';
+import { parse } from '@bomb.sh/args';
+import { intro, isCancel, log, multiselect, outro } from '@clack/prompts';
 import { version } from '../../package.json';
-import { findTRPCImportReferences } from '../lib/ast/scanners';
-
-const execa = Util.promisify(CP.exec);
-
-function exitOnCancel<T>(value: T | symbol): asserts value is T {
-  if (p.isCancel(value)) {
-    process.exit(0);
-  }
-}
-
-async function getPackageManager() {
-  const userAgent = process.env.npm_config_user_agent;
-  if (userAgent?.startsWith('pnpm')) return 'pnpm';
-  if (userAgent?.startsWith('yarn')) return 'yarn';
-  if (userAgent?.startsWith('bun')) return 'bun';
-  return 'npm';
-}
+import { findTRPCImportReferences, getProgram } from '../lib/ast/scanners';
+import { assertCleanGitTree, filterIgnored } from '../lib/git';
+import { installPackage, uninstallPackage } from '../lib/pkgmgr';
+
+const args = parse(process.argv.slice(2), {
+  default: {
+    force: false,
+    skipTanstackQuery: false,
+    verbose: false,
+  },
+  alias: {
+    f: 'force',
+    h: 'help',
+    v: 'verbose',
+    q: 'skipTanstackQuery',
+  },
+  boolean: true,
+});
 
-async function assertCleanGitTree() {
-  const { stdout } = await execa('git status');
-  if (!stdout.includes('nothing to commit')) {
-    throw new Error(
-      'Git tree is not clean, please commit your changes and try again, or run with `--force`',
-    );
-  }
-}
+intro(`tRPC Upgrade CLI v${version}`);
 
-async function installPackage(packageName: string) {
-  const packageManager = await getPackageManager();
-  const { stdout } = await execa(`${packageManager} install ${packageName}`);
-  console.log(stdout);
-}
+if (args.help) {
+  log.info(
+    `
+Usage: upgrade [options]
 
-async function uninstallPackage(packageName: string) {
-  const packageManager = await getPackageManager();
-  const uninstallCmd = packageManager === 'yarn' ? 'remove' : 'uninstall';
-  const { stdout } = await execa(
-    `${packageManager} ${uninstallCmd} ${packageName}`,
+Options:
+  -f, --force             Skip git status check, use with caution
+  -q, --skipTanstackQuery Skip installing @trpc/tanstack-react-query package
+  -v, --verbose           Enable verbose logging
+  -h, --help              Show help
+      `.trim(),
   );
-  console.log(stdout);
+  process.exit(0);
 }
 
-async function filterIgnored(files: readonly ts.SourceFile[]) {
-  const { stdout } = await execa('git check-ignore **/*');
-  const ignores = stdout.split('\n');
-
-  if (process.env.VERBOSE) {
-    console.debug('cwd:', process.cwd());
-    console.debug(
-      'All files in program:',
-      files.map((file) => file.fileName),
-    );
-    console.debug('Ignored files:', ignores);
-  }
-
-  // Ignore "common files"
-  const filteredSourcePaths = files
-    .filter(
-      (source) =>
-        source.fileName.startsWith(Path.resolve()) && // only look ahead of current directory
-        !source.fileName.includes('/trpc/packages/') && // relative paths when running codemod locally
-        !source.fileName.includes('/node_modules/') && // always ignore node_modules
-        !ignores.includes(source.fileName), // ignored files
-    )
-    .map((source) => source.fileName);
-
-  if (process.env.VERBOSE) {
-    console.debug('Filtered files:', filteredSourcePaths);
-  }
-
-  return filteredSourcePaths;
+if (args.verbose) {
+  log.info(`Running upgrade with args: ${JSON.stringify(args, null, 2)}`);
 }
 
-// FIXME :: hacky
-const transformPath = (path: string) =>
-  process.env.DEV ? path : path.replace('../', './').replace('.ts', '.cjs');
+if (!args.force) {
+  await assertCleanGitTree();
+}
 
-async function main() {
-  const args = Args.parse(process.argv.slice(2), {
-    default: {
-      force: false,
-      skipTanstackQuery: false,
-      verbose: false,
-      version: false,
+const transforms = await multiselect({
+  message: 'Select transforms to run',
+  options: [
+    {
+      value: require.resolve('@trpc/upgrade/transforms/hooksToOptions'),
+      label: 'Migrate Hooks to xxxOptions API',
     },
-    alias: {
-      f: 'force',
-      h: 'help',
-      v: 'verbose',
-      q: 'skipTanstackQuery',
+    {
+      value: require.resolve('@trpc/upgrade/transforms/provider'),
+      label: 'Migrate context provider setup',
     },
-    boolean: true,
-  });
-
-  if (args.version) {
-    console.log(`v${version}`);
-    process.exit(0);
-  }
-
-  if (args.help) {
-    console.log(
-      `
-      Usage: upgrade [options]
-
-      Options:
-        -f, --force             Skip git status check, use with caution
-        -q, --skipTanstackQuery Skip installing @trpc/tanstack-react-query package
-        -v, --verbose           Enable verbose logging
-        -h, --help              Show help
-      `.trim(),
-    );
-    process.exit(0);
-  }
-
-  if (args.verbose) {
-    console.log('Running upgrade with args:', args);
-  }
-
-  p.intro('tRPC Upgrade CLI');
-
-  if (!args.force) {
-    try {
-      await assertCleanGitTree();
-    } catch (error) {
-      console.error(error);
-      process.exit(1);
-    }
-  }
-
-  const transforms = await p.multiselect({
-    message: 'Select transforms to run',
-    options: [
-      {
-        value: require.resolve(
-          transformPath('../transforms/hooksToOptions.ts'),
-        ),
-        label: 'Migrate Hooks to xxxOptions API',
-      },
-      {
-        value: require.resolve(transformPath('../transforms/provider.ts')),
-        label: 'Migrate context provider setup',
-      },
-    ],
-  });
-  exitOnCancel(transforms);
-
-  if (!transforms || transforms.length === 0) {
-    console.error('Please select at least one transform to run');
-    process.exit(1);
-  }
-
-  // Make sure provider transform runs first if it's selected
-  const sortedTransforms = transforms.sort((a) =>
-    a.includes('provider.ts') ? -1 : 1,
-  );
-
-  const configFile = ts.findConfigFile(process.cwd(), ts.sys.fileExists);
-  if (!configFile) {
-    console.error('No tsconfig found');
-    process.exit(1);
-  }
-
-  if (process.env.VERBOSE) {
-    console.debug('Using tsconfig', configFile);
-  }
-
-  const { config } = ts.readConfigFile(configFile, ts.sys.readFile);
-  const parsedConfig = ts.parseJsonConfigFileContent(
-    config,
-    ts.sys,
-    process.cwd(),
-  );
-  const program = ts.createProgram({
-    options: parsedConfig.options,
-    rootNames: parsedConfig.fileNames,
-    configFileParsingDiagnostics: parsedConfig.errors,
+  ],
+});
+if (isCancel(transforms)) process.exit(0);
+
+// Make sure provider transform runs first if it's selected
+const sortedTransforms = transforms.sort((a) =>
+  a.includes('provider') ? -1 : 1,
+);
+
+const program = getProgram(args);
+const sourceFiles = program.getSourceFiles();
+const possibleReferences = findTRPCImportReferences(program);
+const trpcFile = possibleReferences.mostUsed.file;
+const trpcImportName = possibleReferences.importName;
+
+const commitedFiles = await filterIgnored(sourceFiles);
+
+for (const transform of sortedTransforms) {
+  log.info(`Running transform: ${transform}`);
+  const { run } = await import('jscodeshift/src/Runner.js');
+  await run(transform, commitedFiles, {
+    ...args,
+    trpcFile,
+    trpcImportName,
   });
+  log.info(`Transform ${transform} completed`);
+}
 
-  const sourceFiles = program.getSourceFiles();
-  const possibleReferences = findTRPCImportReferences(program);
-  const trpcFile = possibleReferences.mostUsed.file;
-  const trpcImportName = possibleReferences.importName;
-
-  const commitedFiles = await filterIgnored(sourceFiles);
-
-  for (const transform of sortedTransforms) {
-    console.log('Running transform', transform);
-    const { run } = await import('jscodeshift/src/Runner.js');
-    const result = await run(transform, commitedFiles, {
-      ...args,
-      trpcFile,
-      trpcImportName,
-    });
-    console.log('Transform result', result);
-  }
-
-  if (!args.skipTanstackQuery) {
-    console.log('Installing @trpc/tanstack-react-query');
-    await installPackage('@trpc/tanstack-react-query');
-
-    console.log('Uninstalling @trpc/react-query');
-    await uninstallPackage('@trpc/react-query');
-  }
+if (!args.skipTanstackQuery) {
+  log.info('Installing @trpc/tanstack-react-query');
+  await installPackage('@trpc/tanstack-react-query');
+  log.success('@trpc/tanstack-react-query installed');
 
-  p.outro('Upgrade complete! 🎉');
+  log.info('Uninstalling @trpc/react-query');
+  await uninstallPackage('@trpc/react-query');
+  log.success('@trpc/react-query uninstalled');
 }
 
-main().catch((error: unknown) => {
-  if (error instanceof Error) {
-    console.error(error.message);
-  } else {
-    console.error('An unknown error occurred:', error);
-  }
-  process.exit(1);
-});
+outro('Upgrade complete! 🎉');

package/src/lib/ast/scanners.ts

@@ -1,25 +1,45 @@
-import {
-  forEachChild,
-  isCallExpression,
-  isIdentifier,
-  isImportDeclaration,
-  isStringLiteral,
-  isVariableDeclaration,
-  isVariableStatement,
-  resolveModuleName,
-  sys,
-  type Program,
-} from 'typescript';
+import * as p from '@clack/prompts';
+import * as ts from 'typescript';
 
-export function findSourceAndImportName(program: Program) {
+export function getProgram(args: Record<string, unknown>) {
+  const configFile = ts.findConfigFile(process.cwd(), (filepath) =>
+    ts.sys.fileExists(filepath),
+  );
+  if (!configFile) {
+    p.log.error('No tsconfig found');
+    process.exit(1);
+  }
+
+  if (args.verbose) {
+    p.log.info(`Using tsconfig: ${configFile}`);
+  }
+
+  const { config } = ts.readConfigFile(configFile, (filepath) =>
+    ts.sys.readFile(filepath),
+  );
+  const parsedConfig = ts.parseJsonConfigFileContent(
+    config,
+    ts.sys,
+    process.cwd(),
+  );
+  const program = ts.createProgram({
+    options: parsedConfig.options,
+    rootNames: parsedConfig.fileNames,
+    configFileParsingDiagnostics: parsedConfig.errors,
+  });
+
+  return program;
+}
+
+export function findSourceAndImportName(program: ts.Program) {
   const files = program.getSourceFiles().filter((sourceFile) => {
     if (sourceFile.isDeclarationFile) return false;
     let found = false;
-    forEachChild(sourceFile, (node) => {
-      if (!found && isImportDeclaration(node)) {
+    ts.forEachChild(sourceFile, (node) => {
+      if (!found && ts.isImportDeclaration(node)) {
         const { moduleSpecifier } = node;
         if (
-          isStringLiteral(moduleSpecifier) &&
+          ts.isStringLiteral(moduleSpecifier) &&
           moduleSpecifier.text.includes('@trpc/react-query')
         ) {
           found = true;
@@ -31,17 +51,17 @@ export function findSourceAndImportName(program: Program) {
 
   let importName = 'trpc';
   files.forEach((sourceFile) => {
-    forEachChild(sourceFile, (node) => {
+    ts.forEachChild(sourceFile, (node) => {
       if (
-        isVariableStatement(node) &&
+        ts.isVariableStatement(node) &&
         node.modifiers?.some((mod) => mod.getText(sourceFile) === 'export')
       ) {
         node.declarationList.declarations.forEach((declaration) => {
           if (
-            isVariableDeclaration(declaration) &&
+            ts.isVariableDeclaration(declaration) &&
             declaration.initializer &&
-            isCallExpression(declaration.initializer) &&
-            isIdentifier(declaration.initializer.expression) &&
+            ts.isCallExpression(declaration.initializer) &&
+            ts.isIdentifier(declaration.initializer.expression) &&
             declaration.initializer.expression.getText(sourceFile) ===
               'createTRPCReact'
           ) {
@@ -58,20 +78,23 @@ export function findSourceAndImportName(program: Program) {
   };
 }
 
-export function findTRPCImportReferences(program: Program) {
+export function findTRPCImportReferences(program: ts.Program) {
   const { files: filesImportingTRPC, importName } =
     findSourceAndImportName(program);
   const trpcReferenceSpecifiers = new Map<string, string>();
 
   program.getSourceFiles().forEach((sourceFile) => {
     if (sourceFile.isDeclarationFile) return;
-    forEachChild(sourceFile, (node) => {
-      if (isImportDeclaration(node) && isStringLiteral(node.moduleSpecifier)) {
-        const resolved = resolveModuleName(
+    ts.forEachChild(sourceFile, (node) => {
+      if (
+        ts.isImportDeclaration(node) &&
+        ts.isStringLiteral(node.moduleSpecifier)
+      ) {
+        const resolved = ts.resolveModuleName(
           node.moduleSpecifier.text,
           sourceFile.fileName,
           program.getCompilerOptions(),
-          sys,
+          ts.sys,
         );
         if (
           resolved.resolvedModule &&

package/src/lib/execa.ts

@@ -0,0 +1,4 @@
+import * as CP from 'node:child_process';
+import * as Util from 'node:util';
+
+export const execa = Util.promisify(CP.exec);

package/src/lib/git.ts

@@ -0,0 +1,44 @@
+import * as Path from 'path';
+import * as p from '@clack/prompts';
+import type { SourceFile } from 'typescript';
+import { execa } from './execa';
+
+export async function assertCleanGitTree() {
+  const { stdout } = await execa('git status');
+  if (!stdout.includes('nothing to commit')) {
+    p.cancel(
+      'Git tree is not clean, please commit your changes and try again, or run with `--force`',
+    );
+    process.exit(1);
+  }
+}
+
+export async function filterIgnored(files: readonly SourceFile[]) {
+  const { stdout } = await execa('git check-ignore **/*');
+  const ignores = stdout.split('\n');
+
+  if (process.env.VERBOSE) {
+    p.log.info(`cwd: ${process.cwd()}`);
+    p.log.info(
+      `All files in program: ${files.map((file) => file.fileName).join(', ')}`,
+    );
+    p.log.info(`Ignored files: ${ignores.join(', ')}`);
+  }
+
+  // Ignore "common files"
+  const filteredSourcePaths = files
+    .filter(
+      (source) =>
+        source.fileName.startsWith(Path.resolve()) && // only look ahead of current directory
+        !source.fileName.includes('/trpc/packages/') && // relative paths when running codemod locally
+        !source.fileName.includes('/node_modules/') && // always ignore node_modules
+        !ignores.includes(source.fileName), // ignored files
+    )
+    .map((source) => source.fileName);
+
+  if (process.env.VERBOSE) {
+    p.log.info(`Filtered files: ${filteredSourcePaths.join(', ')}`);
+  }
+
+  return filteredSourcePaths;
+}

package/src/lib/pkgmgr.ts

@@ -0,0 +1,34 @@
+import * as p from '@clack/prompts';
+import { execa } from './execa';
+
+function getPackageManager() {
+  const userAgent = process.env.npm_config_user_agent;
+  if (userAgent?.startsWith('pnpm')) return 'pnpm';
+  if (userAgent?.startsWith('yarn')) return 'yarn';
+  if (userAgent?.startsWith('bun')) return 'bun';
+  return 'npm';
+}
+
+export async function installPackage(packageName: string) {
+  const packageManager = getPackageManager();
+  const installCmd = packageManager === 'yarn' ? 'add' : 'install';
+  const { stdout, stderr } = await execa(
+    `${packageManager} ${installCmd} ${packageName}`,
+  );
+  if (stderr) {
+    p.log.error(stderr);
+  }
+  p.log.info(stdout);
+}
+
+export async function uninstallPackage(packageName: string) {
+  const packageManager = getPackageManager();
+  const uninstallCmd = packageManager === 'yarn' ? 'remove' : 'uninstall';
+  const { stdout, stderr } = await execa(
+    `${packageManager} ${uninstallCmd} ${packageName}`,
+  );
+  if (stderr) {
+    p.log.error(stderr);
+  }
+  p.log.info(stdout);
+}