@es-toolkit/codemod/bin/cli.js

A codemod to transform lodash imports to es-toolkit/compat imports

#!/usr/bin/env node

const { execSync } = require('child_process');
const path = require('path');
const fs = require('fs');

function showHelp() {
  console.log(`
🔧 es-toolkit codemod for lodash migration

Usage:
  npx @es-toolkit/codemod <path>

Options:
  <path>         Path to files or directory to transform
  --dry          Dry run (preview changes without applying)
  --help, -h     Show this help message

Examples:
  npx @es-toolkit/codemod src/
  npx @es-toolkit/codemod src/components/ --dry
  npx @es-toolkit/codemod src/utils/helpers.ts

Description:
  This codemod automatically transforms your lodash imports to es-toolkit/compat imports:
  
  • import _ from 'lodash' → import * as _ from 'es-toolkit/compat'
  • import { map } from 'lodash' → import { map } from 'es-toolkit/compat'  
  • import debounce from 'lodash/debounce' → import debounce from 'es-toolkit/compat/debounce'
  • import { map } from 'lodash-es' → import { map } from 'es-toolkit/compat'

Repository: https://github.com/toss/es-toolkit-codemod
  `);
}

function main() {
  const args = process.argv.slice(2);

  if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
    showHelp();
    return;
  }

  const targetPath = args[0];
  const isDryRun = args.includes('--dry');

  if (!fs.existsSync(targetPath)) {
    console.error(`❌ Error: Path "${targetPath}" does not exist.`);
    process.exit(1);
  }

  const transformPath = path.join(__dirname, '../dist/index.js');

  if (!fs.existsSync(transformPath)) {
    console.error(`❌ Error: Transform file not found. Please ensure the package is built correctly.`);
    console.log('💡 Try running: npm run build');
    process.exit(1);
  }

  console.log(`🚀 Running lodash → es-toolkit/compat codemod...`);
  console.log(`📁 Target: ${targetPath}`);
  console.log(`🔄 Mode: ${isDryRun ? 'Dry run (preview only)' : 'Apply changes'}`);
  console.log('');

  try {
    const cmd = [
      'npx',
      'jscodeshift',
      '-t',
      transformPath,
      targetPath,
      '--extensions=ts,tsx,js,jsx',
      '--parser=tsx',
      isDryRun ? '--dry' : '',
      isDryRun ? '--print' : '--silent',
    ]
      .filter(Boolean)
      .join(' ');

    const result = execSync(cmd, {
      encoding: 'utf8',
      stdio: isDryRun ? 'pipe' : 'inherit',
      env: {
        ...process.env,
        NODE_NO_WARNINGS: '1'
      }
    });

    if (isDryRun && result.trim()) {
      console.log('🔍 Preview of changes:');
      console.log('─'.repeat(50));
      console.log(result);
      console.log('─'.repeat(50));
      console.log('');
      console.log('💡 To apply these changes, run the command without --dry flag');
    } else if (!isDryRun) {
      console.log('✅ Transformation completed successfully!');
      console.log('');
      console.log('📝 Please review the changes and test your application.');
      console.log('🔗 Learn more about es-toolkit: https://es-toolkit.slash.page');
    } else {
      console.log('ℹ️  No lodash imports found to transform.');
    }
  } catch (error) {
    console.error('❌ Error running codemod:', error.message);
    process.exit(1);
  }
}

if (require.main === module) {
  main();
}

module.exports = { main };