@wular/pnext 0.0.3 → 0.0.6

package/src/cli/migrate/{index.ts → run.ts}

@@ -4,93 +4,92 @@
 // pnext.config.ts, .gitignore, next-env.d.ts). Application source is never
 // rewritten: it is scanned and reported so the user stays in control.
 
-import { existsSync } from 'node:fs';
-import { appendFile, readFile, rm, writeFile } from 'node:fs/promises';
-import path from 'node:path';
-import { bold } from '../../utils/ansi';
-import { migratePackageJson, readPackageJson } from './package-json';
-import { emptyResult, printHeader, printResult, type MigrationResult } from './report';
-import { scanSources } from './scan';
-import { withSpinner } from './spinner';
-import { migrateTsconfig } from './tsconfig';
+import { existsSync } from 'node:fs'
+import { appendFile, readFile, rm, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+import { bold } from '../../utils/ansi'
+import { migratePackageJson, readPackageJson } from './package-json'
+import { emptyResult, printHeader, printResult, type MigrationResult } from './report'
+import { scanSources } from './scan'
+import { withSpinner } from './spinner'
+import { migrateTsconfig } from './tsconfig'
 
-const NEXT_CONFIG_FILES = ['next.config.ts', 'next.config.js', 'next.config.mjs', 'next.config.cjs'];
-const PNEXT_CONFIG_FILES = ['pnext.config.ts', 'pnext.config.js', 'pnext.config.mjs'];
+const NEXT_CONFIG_FILES = ['next.config.ts', 'next.config.js', 'next.config.mjs', 'next.config.cjs']
+const PNEXT_CONFIG_FILES = ['pnext.config.ts', 'pnext.config.js', 'pnext.config.mjs']
 
 export async function migrateApp(directory: string | undefined, options: { dryRun: boolean }) {
-  const root = path.resolve(directory ?? process.cwd());
-  const pkg = await readPackageJson(root);
+  const root = path.resolve(directory ?? process.cwd())
+  const pkg = await readPackageJson(root)
   const hasNextDependency = Boolean(
-    pkg &&
-      (hasDependency(pkg.dependencies, 'next') || hasDependency(pkg.devDependencies, 'next')),
-  );
-  const hasNextConfig = NEXT_CONFIG_FILES.some(name => existsSync(path.join(root, name)));
+    pkg && (hasDependency(pkg.dependencies, 'next') || hasDependency(pkg.devDependencies, 'next')),
+  )
+  const hasNextConfig = NEXT_CONFIG_FILES.some(name => existsSync(path.join(root, name)))
 
   if (!hasNextDependency && !hasNextConfig) {
     console.error(
       `${bold('Not a Next.js app')}: ${root}\n` +
         `  - ${pkg ? 'package.json has no "next" dependency' : 'no readable package.json'}\n` +
         '  - no next.config.{ts,js,mjs,cjs}',
-    );
-    return 1;
+    )
+    return 1
   }
 
-  printHeader(root, options.dryRun);
-  const result = emptyResult();
-  if (pkg) await migratePackageJson(root, pkg, result, options.dryRun);
-  await createPnextConfig(root, result, options.dryRun);
-  await migrateTsconfig(root, result, options.dryRun);
-  await removeNextEnv(root, result, options.dryRun);
-  await updateGitignore(root, result, options.dryRun);
-  await withSpinner('Scanning sources ...', () => scanSources(root, result));
+  printHeader(root, options.dryRun)
+  const result = emptyResult()
+  if (pkg) await migratePackageJson(root, pkg, result, options.dryRun)
+  await createPnextConfig(root, result, options.dryRun)
+  await migrateTsconfig(root, result, options.dryRun)
+  await removeNextEnv(root, result, options.dryRun)
+  await updateGitignore(root, result, options.dryRun)
+  await withSpinner('Scanning sources ...', () => scanSources(root, result))
 
-  printResult(result, { install: installCommand(root) });
-  return 0;
+  printResult(result, { install: installCommand(root) })
+  return 0
 }
 
 async function createPnextConfig(root: string, result: MigrationResult, dryRun: boolean) {
-  const existing = PNEXT_CONFIG_FILES.find(name => existsSync(path.join(root, name)));
+  const existing = PNEXT_CONFIG_FILES.find(name => existsSync(path.join(root, name)))
   if (existing) {
     result.reports.push({
       title: `${existing} already exists`,
       detail: 'Make sure it sets compat: { next: true }. See reference/compat.md.',
-    });
-    return;
+    })
+    return
   }
   if (!dryRun) {
     await writeFile(
       path.join(root, 'pnext.config.ts'),
       'export default { compat: { next: true } };\n',
-    );
+    )
   }
-  result.edits.push({ file: 'pnext.config.ts', description: 'created with compat.next enabled' });
+  result.edits.push({ file: 'pnext.config.ts', description: 'created with compat.next enabled' })
 }
 
 async function removeNextEnv(root: string, result: MigrationResult, dryRun: boolean) {
-  const file = path.join(root, 'next-env.d.ts');
-  if (!existsSync(file)) return;
-  if (!dryRun) await rm(file);
-  result.edits.push({ file: 'next-env.d.ts', description: 'deleted' });
+  const file = path.join(root, 'next-env.d.ts')
+  if (!existsSync(file)) return
+  if (!dryRun) await rm(file)
+  result.edits.push({ file: 'next-env.d.ts', description: 'deleted' })
 }
 
 async function updateGitignore(root: string, result: MigrationResult, dryRun: boolean) {
-  const file = path.join(root, '.gitignore');
-  if (!existsSync(file)) return;
-  const text = await readFile(file, 'utf8');
-  if (text.split(/\r?\n/).some(line => line.trim() === '.pnext/')) return;
-  if (!dryRun) await appendFile(file, `${text.endsWith('\n') || text === '' ? '' : '\n'}.pnext/\n`);
-  result.edits.push({ file: '.gitignore', description: 'appended .pnext/' });
+  const file = path.join(root, '.gitignore')
+  if (!existsSync(file)) return
+  const text = await readFile(file, 'utf8')
+  if (text.split(/\r?\n/).some(line => line.trim() === '.pnext/')) return
+  if (!dryRun) await appendFile(file, `${text.endsWith('\n') || text === '' ? '' : '\n'}.pnext/\n`)
+  result.edits.push({ file: '.gitignore', description: 'appended .pnext/' })
 }
 
 function installCommand(root: string) {
   if (existsSync(path.join(root, 'bun.lock')) || existsSync(path.join(root, 'bun.lockb'))) {
-    return 'bun install';
+    return 'bun install'
   }
-  if (existsSync(path.join(root, 'pnpm-lock.yaml'))) return 'pnpm install';
-  if (existsSync(path.join(root, 'yarn.lock'))) return 'yarn';
-  return 'npm install';
+  if (existsSync(path.join(root, 'pnpm-lock.yaml'))) return 'pnpm install'
+  if (existsSync(path.join(root, 'yarn.lock'))) return 'yarn'
+  return 'npm install'
 }
 
 function hasDependency(bucket: unknown, name: string) {
-  return typeof bucket === 'object' && bucket !== null && name in bucket;
+  return typeof bucket === 'object' && bucket !== null && name in bucket
 }

package/src/cli/migrate/scan.ts

@@ -2,12 +2,12 @@
 // from regexes over application code; text checks here only classify what to
 // report and never drive a rewrite.
 
-import { existsSync } from 'node:fs';
-import { readdir, readFile } from 'node:fs/promises';
-import path from 'node:path';
-import type { MigrationResult } from './report';
+import { existsSync } from 'node:fs'
+import { readdir, readFile } from 'node:fs/promises'
+import path from 'node:path'
+import type { MigrationResult } from './report'
 
-const SKIP_DIRS = new Set(['node_modules', '.next', '.pnext', '.git', 'dist', 'build']);
+const SKIP_DIRS = new Set(['node_modules', '.next', '.pnext', '.git', 'dist', 'build'])
 const LOADERS: Record<string, 'ts' | 'tsx' | 'js' | 'jsx'> = {
   '.ts': 'ts',
   '.tsx': 'tsx',
@@ -15,39 +15,39 @@ const LOADERS: Record<string, 'ts' | 'tsx' | 'js' | 'jsx'> = {
   '.js': 'js',
   '.mjs': 'js',
   '.cjs': 'js',
-};
-const STREAMING_APIS = ['renderToReadableStream', 'renderToPipeableStream'];
-const SPECIAL_PAGES = ['_app', '_document', '_error'];
+}
+const STREAMING_APIS = ['renderToReadableStream', 'renderToPipeableStream']
+const SPECIAL_PAGES = ['_app', '_document', '_error']
 
 export async function scanSources(root: string, result: MigrationResult) {
-  const { SHIMMED_NEXT_DIST_PATHS } = await import('../../compat');
-  const shimmed = new Set<string>(SHIMMED_NEXT_DIST_PATHS);
-  const deepImports: string[] = [];
-  const streaming: string[] = [];
-  const headImports: string[] = [];
+  const { SHIMMED_NEXT_DIST_PATHS } = await import('../../compat/aliases')
+  const shimmed = new Set<string>(SHIMMED_NEXT_DIST_PATHS)
+  const deepImports: string[] = []
+  const streaming: string[] = []
+  const headImports: string[] = []
 
   for await (const file of walk(root)) {
-    const loader = LOADERS[path.extname(file)];
-    if (!loader) continue;
-    const text = await readFile(file, 'utf8');
-    let specifiers: string[];
+    const loader = LOADERS[path.extname(file)]
+    if (!loader) continue
+    const text = await readFile(file, 'utf8')
+    let specifiers: string[]
     try {
-      specifiers = new Bun.Transpiler({ loader }).scanImports(text).map(item => item.path);
+      specifiers = new Bun.Transpiler({ loader }).scanImports(text).map(item => item.path)
     } catch {
-      continue; // unparseable source is the app's problem, not migrate's
+      continue // unparseable source is the app's problem, not migrate's
     }
-    const relative = path.relative(root, file);
+    const relative = path.relative(root, file)
     for (const specifier of specifiers) {
       if (specifier.startsWith('next/dist/') && !shimmed.has(specifier.replace(/\.js$/, ''))) {
-        deepImports.push(`${relative} → ${specifier}`);
+        deepImports.push(`${relative} → ${specifier}`)
       }
       if (
         /^react-dom\/server(\.|\/|$)/.test(specifier) &&
         STREAMING_APIS.some(api => text.includes(api))
       ) {
-        streaming.push(relative);
+        streaming.push(relative)
       }
-      if (specifier === 'next/head') headImports.push(relative);
+      if (specifier === 'next/head') headImports.push(relative)
     }
   }
 
@@ -57,7 +57,7 @@ export async function scanSources(root: string, result: MigrationResult) {
       detail:
         'Only five next/dist paths are shimmed — replace these with public APIs. See reference/compat.md ("Smaller surfaces").',
       files: deepImports,
-    });
+    })
   }
   if (streaming.length > 0) {
     result.reports.push({
@@ -65,7 +65,7 @@ export async function scanSources(root: string, result: MigrationResult) {
       detail:
         'preact/compat does not provide renderToReadableStream/renderToPipeableStream — use pnext rendering instead. See reference/compat.md.',
       files: [...new Set(streaming)],
-    });
+    })
   }
 
   if (headImports.length > 0) {
@@ -74,62 +74,62 @@ export async function scanSources(root: string, result: MigrationResult) {
       detail:
         'Move these tags to metadata exports (or the root layout <head>) — next/head is a silent no-op under pnext. See reference/compat.md.',
       files: [...new Set(headImports)],
-    });
+    })
   }
 
-  scanSpecialPages(root, result);
-  await scanNextConfig(root, result);
+  scanSpecialPages(root, result)
+  await scanNextConfig(root, result)
 }
 
 function scanSpecialPages(root: string, result: MigrationResult) {
-  const found: string[] = [];
+  const found: string[] = []
   for (const base of ['pages', path.join('src', 'pages')]) {
     for (const name of SPECIAL_PAGES) {
       for (const extension of ['.tsx', '.ts', '.jsx', '.js']) {
-        const relative = path.join(base, `${name}${extension}`);
-        if (existsSync(path.join(root, relative))) found.push(relative);
+        const relative = path.join(base, `${name}${extension}`)
+        if (existsSync(path.join(root, relative))) found.push(relative)
       }
     }
   }
-  if (found.length === 0) return;
+  if (found.length === 0) return
   result.reports.push({
     title: 'pages/_app, _document and _error are ignored',
     detail:
       'Move this setup into the app-router root layout — pnext never loads these files. See reference/compat.md.',
     files: found,
-  });
+  })
 }
 
 async function scanNextConfig(root: string, result: MigrationResult) {
   for (const name of ['next.config.ts', 'next.config.js', 'next.config.mjs', 'next.config.cjs']) {
-    const file = path.join(root, name);
-    if (!existsSync(file)) continue;
-    const text = await readFile(file, 'utf8');
-    if (!text.includes('webpack:') && !text.includes('webpack(')) return;
-    const svgr = text.includes('@svgr/webpack');
+    const file = path.join(root, name)
+    if (!existsSync(file)) continue
+    const text = await readFile(file, 'utf8')
+    if (!text.includes('webpack:') && !text.includes('webpack(')) return
+    const svgr = text.includes('@svgr/webpack')
     result.reports.push({
       title: `${name} defines a webpack function`,
       detail: svgr
         ? 'The webpack function is never executed; SVGR is auto-detected from @svgr/webpack, so SVG imports keep working. See reference/compat.md.'
         : 'The webpack function is never executed — port any custom loaders/plugins to pnext config. See reference/compat.md.',
-    });
-    return;
+    })
+    return
   }
 }
 
 async function* walk(dir: string): AsyncGenerator<string> {
-  let entries: import('node:fs').Dirent[];
+  let entries: import('node:fs').Dirent[]
   try {
-    entries = await readdir(dir, { withFileTypes: true });
+    entries = await readdir(dir, { withFileTypes: true })
   } catch {
-    return;
+    return
   }
   for (const entry of entries) {
     if (entry.isDirectory()) {
-      if (SKIP_DIRS.has(entry.name)) continue;
-      yield* walk(path.join(dir, entry.name));
+      if (SKIP_DIRS.has(entry.name)) continue
+      yield* walk(path.join(dir, entry.name))
     } else if (entry.isFile()) {
-      yield path.join(dir, entry.name);
+      yield path.join(dir, entry.name)
     }
   }
 }

package/src/cli/migrate/spinner.ts

@@ -1,20 +1,20 @@
 // Minimal braille spinner for the one step that can take a while (the source
 // scan over a large app). TTY-only, so piped/CI output stays clean.
 
-const FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+const FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
 
 export async function withSpinner<T>(label: string, run: () => Promise<T>): Promise<T> {
-  if (!process.stdout.isTTY) return run();
+  if (!process.stdout.isTTY) return run()
 
-  let frame = 0;
+  let frame = 0
   const timer = setInterval(() => {
-    process.stdout.write(`\r${FRAMES[frame % FRAMES.length]} ${label}`);
-    frame += 1;
-  }, 80);
+    process.stdout.write(`\r${FRAMES[frame % FRAMES.length]} ${label}`)
+    frame += 1
+  }, 80)
   try {
-    return await run();
+    return await run()
   } finally {
-    clearInterval(timer);
-    process.stdout.write('\r\x1b[2K');
+    clearInterval(timer)
+    process.stdout.write('\r\x1b[2K')
   }
 }

package/src/cli/migrate/tsconfig.ts

@@ -3,75 +3,75 @@
 // never rewritten — the same bail compat/tsconfig-defaults.ts takes, since a
 // JSON round-trip would strip the user's comments.
 
-import { existsSync } from 'node:fs';
-import { readFile, writeFile } from 'node:fs/promises';
-import path from 'node:path';
-import type { MigrationResult } from './report';
+import { existsSync } from 'node:fs'
+import { readFile, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+import type { MigrationResult } from './report'
 
 const MANUAL_STEPS =
-  'remove { "name": "next" } from compilerOptions.plugins and replace ".next/types" includes with ".pnext/types/**/*.ts".';
+  'remove { "name": "next" } from compilerOptions.plugins and replace ".next/types" includes with ".pnext/types/**/*.ts".'
 
 export async function migrateTsconfig(root: string, result: MigrationResult, dryRun: boolean) {
-  const file = path.join(root, 'tsconfig.json');
-  if (!existsSync(file)) return;
-  const text = await readFile(file, 'utf8');
+  const file = path.join(root, 'tsconfig.json')
+  if (!existsSync(file)) return
+  const text = await readFile(file, 'utf8')
 
-  let config: Record<string, unknown>;
+  let config: Record<string, unknown>
   try {
-    config = JSON.parse(text) as Record<string, unknown>;
+    config = JSON.parse(text) as Record<string, unknown>
   } catch {
     result.reports.push({
       title: 'tsconfig.json has comments (JSONC) — not edited',
       detail: `Apply by hand: ${MANUAL_STEPS}`,
-    });
-    return;
+    })
+    return
   }
-  if (typeof config !== 'object' || config === null) return;
+  if (typeof config !== 'object' || config === null) return
 
-  const changes: string[] = [];
-  const compilerOptions = config.compilerOptions;
+  const changes: string[] = []
+  const compilerOptions = config.compilerOptions
   if (isObject(compilerOptions) && Array.isArray(compilerOptions.plugins)) {
     const kept = compilerOptions.plugins.filter(
       plugin => !(isObject(plugin) && plugin.name === 'next'),
-    );
+    )
     if (kept.length !== compilerOptions.plugins.length) {
-      if (kept.length === 0) delete compilerOptions.plugins;
-      else compilerOptions.plugins = kept;
-      changes.push('next TypeScript plugin removed');
+      if (kept.length === 0) delete compilerOptions.plugins
+      else compilerOptions.plugins = kept
+      changes.push('next TypeScript plugin removed')
     }
   }
 
   if (Array.isArray(config.include)) {
-    const seen = new Set<string>();
-    const include: unknown[] = [];
-    let repointed = false;
+    const seen = new Set<string>()
+    const include: unknown[] = []
+    let repointed = false
     for (const entry of config.include) {
       if (typeof entry !== 'string') {
-        include.push(entry);
-        continue;
+        include.push(entry)
+        continue
       }
       const next =
         entry.includes('.next/types') || entry.includes('.next/dev/types')
           ? '.pnext/types/**/*.ts'
-          : entry;
-      if (next !== entry) repointed = true;
-      if (seen.has(next)) continue;
-      seen.add(next);
-      include.push(next);
+          : entry
+      if (next !== entry) repointed = true
+      if (seen.has(next)) continue
+      seen.add(next)
+      include.push(next)
     }
     if (repointed) {
-      config.include = include;
-      changes.push('type includes repointed at .pnext/types');
+      config.include = include
+      changes.push('type includes repointed at .pnext/types')
     }
   }
 
-  if (changes.length === 0) return;
-  if (!dryRun) await writeFile(file, `${JSON.stringify(config, null, 2)}\n`);
+  if (changes.length === 0) return
+  if (!dryRun) await writeFile(file, `${JSON.stringify(config, null, 2)}\n`)
   for (const change of changes) {
-    result.edits.push({ file: 'tsconfig.json', description: change });
+    result.edits.push({ file: 'tsconfig.json', description: change })
   }
 }
 
 function isObject(value: unknown): value is Record<string, unknown> {
-  return typeof value === 'object' && value !== null && !Array.isArray(value);
+  return typeof value === 'object' && value !== null && !Array.isArray(value)
 }