Initial init refactor

Author: danieldelcore

package.json

@@ -24,6 +24,7 @@
     "monorepo:fix": "manypkg fix && preconstruct fix",
     "cli:start": "node packages/cli/bin/codeshift-cli.js",
     "cli:validate": "node packages/cli/bin/codeshift-cli.js validate",
+    "cli:init": "node packages/cli/bin/codeshift-cli.js init",
     "cli:list": "node packages/cli/bin/codeshift-cli.js list",
     "init:codemods": "ts-node scripts/initialize.ts",
     "validate:codemods": "ts-node scripts/validate.ts ./community",

packages/cli/src/index.ts

@@ -94,24 +94,30 @@ Examples:
 program
   .command('init [path]')
   .description('creates a new codeshift package')
-  .requiredOption('--package-name <value>', 'Name of the package')
+  .option('-c, --config-only', 'Output only a configuration file')
   .option('-t, --transform <value>', 'Transform version')
   .option('-p, --preset <value>', 'Preset transfrom')
   .action((path, options) =>
-    init(options.packageName, options.transform, options.preset, path),
+    init(options.transform, options.preset, options.configOnly, path),
   )
   .addHelpText(
     'after',
     `
 Examples:
-  # Initializes an empty codeshift package at the ~/Desktop directory
-  $ codeshift init --package-name foobar --transform 10.0.0 ~/Desktop
+  # Initializes an empty codeshift package at the current directory
+  $ codeshift init --transform 10.0.0 my-codemod-package
 
-  # Initializes a new codeshift package with a transform for 10.0.0
-  $ codeshift init --package-name foobar --transform 10.0.0 ~/Desktop
+  # Initializes an empty codeshift package at the current directory
+  $ codeshift init --transform 10.0.0 .
+
+  # Initializes a new codeshift package with a transform for 10.0.0 at the foobar dir
+  $ codeshift init --transform 10.0.0 ~/foobar
 
   # Initializes a new codeshift package with a preset "update-imports"
-  $ codeshift init --package-name foobar --preset update-imports ~/Desktop`,
+  $ codeshift init --package-name foobar --preset update-imports foobar
+
+  # Initializes a configuration file only
+  $ codeshift init --config-only --preset update-imports path/to/src`,
   );
 
 program

packages/cli/src/init.ts

@@ -1,18 +1,28 @@
 import path from 'path';
-import { initDirectory, initTransform } from '@codeshift/initializer';
+import chalk from 'chalk';
+import {
+  initConfig,
+  initDirectory,
+  initTransform,
+} from '@codeshift/initializer';
 
 export default async function init(
-  packageName: string,
   transform?: string,
   preset?: string,
+  configOnly?: boolean,
   targetPath = '.',
 ) {
-  initDirectory(packageName, targetPath);
+  const packageName =
+    targetPath !== '.' ? path.basename(targetPath) : 'codeshift-community';
+
+  if (configOnly) {
+    initConfig(packageName, targetPath);
+  } else {
+    initDirectory(packageName, targetPath);
+  }
 
   if (transform) initTransform(packageName, transform, 'version', targetPath);
   if (preset) initTransform(packageName, preset, 'preset', targetPath);
 
-  console.log(
-    `🚚 New codemod package created at: ${path.join(targetPath, packageName)}`,
-  );
+  console.log(chalk.green(`🚚 New codemod package created at: ${targetPath}`));
 }

packages/cli/src/validate.ts

@@ -1,8 +1,9 @@
-import { isValidConfigAtPath, isValidPackageJson } from '@codeshift/validator';
+import chalk from 'chalk';
+
+import { isValidConfigAtPath } from '@codeshift/validator';
 
 export default async function validate(targetPath = '.') {
   await isValidConfigAtPath(targetPath);
-  await isValidPackageJson(targetPath);
 
-  console.log('Valid ✅');
+  console.log(chalk.green('Valid ✅'));
 }

packages/initializer/src/index.ts

@@ -47,7 +47,7 @@ jest.config.js
 function getConfig(packageName: string, transform?: string, preset?: string) {
   return `module.exports = {
   maintainers: [],
-  target: [],
+  targets: [],
   description: 'Codemods for ${packageName}',
   transforms: {${
     transform
@@ -62,22 +62,24 @@ function getConfig(packageName: string, transform?: string, preset?: string) {
 }
 
 function updateConfig(
-  path: string,
+  targetPath: string,
   packageName: string,
   transformName: string,
   type: 'version' | 'preset',
+  isReduced = false,
 ) {
-  const source = fs.readFileSync(path, 'utf8');
+  const configPath = path.join(targetPath, 'codeshift.config.js');
+  const source = fs.readFileSync(configPath, 'utf8');
   const ast = recast.parse(source);
   const b = recast.types.builders;
   const key = type === 'version' ? 'transforms' : 'presets';
 
   recast.visit(ast, {
-    visitProperty(path) {
+    visitProperty(propertyPath) {
       // @ts-ignore
-      if (path.node.key.name !== key) return false;
+      if (propertyPath.node.key.name !== key) return false;
       // @ts-ignore
-      const properties = path.node.value.properties;
+      const properties = propertyPath.node.value.properties;
       // @ts-ignore
       properties.forEach(property => {
         if (property.key.value === transformName) {
@@ -87,6 +89,10 @@ function updateConfig(
         }
       });
 
+      const transformPath = `./${
+        !isReduced ? 'src/' : ''
+      }${transformName}/transform`;
+
       properties.push(
         b.property(
           'init',
@@ -96,7 +102,7 @@ function updateConfig(
               b.identifier('require'),
               b.identifier('resolve'),
             ),
-            [b.stringLiteral(`./${transformName}/transform`)],
+            [b.stringLiteral(transformPath)],
           ),
         ),
       );
@@ -105,41 +111,47 @@ function updateConfig(
     },
   });
 
-  return recast.prettyPrint(ast, { quote: 'single', trailingComma: true }).code;
+  fs.writeFileSync(
+    configPath,
+    recast.prettyPrint(ast, {
+      quote: 'single',
+      trailingComma: true,
+      tabWidth: 2,
+    }).code,
+  );
+}
+
+export function initConfig(packageName: string, targetPath = './') {
+  const configPath = path.join(targetPath, 'codeshift.config.js');
+
+  if (!fs.existsSync(configPath)) {
+    fs.writeFileSync(configPath, getConfig(packageName));
+  }
 }
 
 export function initDirectory(
   packageName: string,
   targetPath = './',
   isReduced = false,
 ) {
-  const basePath = path.join(targetPath, packageName.replace('/', '__'));
-  const configPath = path.join(
-    basePath,
-    !isReduced ? 'src' : '',
-    'codeshift.config.js',
-  );
-
   fs.copySync(
     path.join(__dirname, '..', 'template', isReduced ? 'src' : ''),
-    basePath,
+    targetPath,
     {
       filter: src => !src.includes('src/codemod'),
     },
   );
 
   if (!isReduced) {
     fs.writeFileSync(
-      path.join(basePath, 'package.json'),
+      path.join(targetPath, 'package.json'),
       getPackageJson(packageName),
     );
 
-    fs.writeFileSync(path.join(basePath, '.npmignore'), getNpmIgnore());
+    fs.writeFileSync(path.join(targetPath, '.npmignore'), getNpmIgnore());
   }
 
-  if (!fs.existsSync(configPath)) {
-    fs.writeFileSync(configPath, getConfig(packageName));
-  }
+  initConfig(packageName, targetPath);
 }
 
 export function initTransform(
@@ -153,26 +165,23 @@ export function initTransform(
     throw new Error(`Provided version ${id} is not a valid semver version`);
   }
 
-  const basePath = path.join(targetPath, packageName.replace('/', '__'));
-  const transformPath = path.join(basePath, !isReduced ? 'src' : '', id);
-  const configPath = path.join(
-    basePath,
-    !isReduced ? 'src' : '',
-    'codeshift.config.js',
-  );
+  const transformPath = path.join(targetPath, !isReduced ? 'src' : '', id);
 
   if (fs.existsSync(transformPath)) {
     throw new Error(`Codemod for ${type} "${id}" already exists`);
   }
 
-  fs.copySync(
-    path.join(__dirname, '..', 'template', isReduced ? 'src' : ''),
-    basePath,
+  const codemodTemplateDestinationPath = path.join(
+    targetPath,
+    !isReduced ? 'src' : '',
+    'codemod',
   );
-  fs.renameSync(
-    path.join(basePath, !isReduced ? 'src' : '', 'codemod'),
-    transformPath,
+
+  fs.copySync(
+    path.join(__dirname, '..', 'template', 'src', 'codemod'),
+    codemodTemplateDestinationPath,
   );
+  fs.renameSync(codemodTemplateDestinationPath, transformPath);
 
   const testFilePath = path.join(transformPath, 'transform.spec.ts');
   const testFile = fs
@@ -183,15 +192,5 @@ export function initTransform(
 
   fs.writeFileSync(testFilePath, testFile);
 
-  if (!isReduced) {
-    fs.writeFileSync(
-      path.join(basePath, 'package.json'),
-      getPackageJson(packageName),
-    );
-  }
-
-  fs.writeFileSync(
-    configPath,
-    updateConfig(configPath, packageName, id || '', type),
-  );
+  updateConfig(targetPath, packageName, id || '', type, isReduced);
 }

packages/validator/src/index.ts

@@ -1,6 +1,4 @@
-import fs from 'fs-extra';
 import semver from 'semver';
-import path from 'path';
 
 import { CodeshiftConfig } from '@codeshift/types';
 import { fetchConfig } from '@codeshift/fetcher';
@@ -65,21 +63,3 @@ Please make sure all presets are kebab case and contain no spaces or special cha
 
   return true;
 }
-
-export async function isValidPackageJson(targetPath: string) {
-  const packageJsonRaw = await fs.readFile(
-    path.join(targetPath, 'package.json'),
-    'utf8',
-  );
-  const packageJson = JSON.parse(packageJsonRaw);
-
-  if (!packageJson.name) {
-    throw new Error('No package name provided in package.json');
-  }
-
-  if (!packageJson.main) {
-    throw new Error('No main entrypoint provided in package.json');
-  }
-
-  return true;
-}

scripts/initialize.ts

@@ -1,18 +1,24 @@
+import chalk from 'chalk';
 import { initDirectory, initTransform } from '@codeshift/initializer';
+import path from 'path';
 
-const targetPath = `${__dirname}/../community`;
+const communityPath = `${__dirname}/../community`;
 
 export function main(packageName: string, transform?: string) {
   if (!packageName) throw new Error('Package name was not provided');
   if (!transform) throw new Error('Version was not provided');
 
+  const targetPath = path.join(communityPath, packageName.replace('/', '__'));
+
   if (transform) {
     initDirectory(packageName, targetPath, true);
     initTransform(packageName, transform, 'version', targetPath, true);
   }
 
   console.log(
-    `🚚 New codemod package created at: community/${packageName}/${transform}`,
+    chalk.green(
+      `🚚 New codemod package created at: ./community/${packageName}/${transform}`,
+    ),
   );
 }
 

website/docs/api/codeshift-cli.mdx

@@ -155,28 +155,19 @@ Subcommand that generates a new codemod at your desired path
 Create a new codeshift package called foobar with a transform for version 10
 on the Desktop
 
-- `$ codeshift init --package-name="foobar" --version="10.0.0" ~/Desktop`
+- `$ codeshift init --version="10.0.0" ~/Desktop/foobar`
 
-Create an empty codeshift package called foobar on the Desktop
+Create an empty codeshift package called on the Desktop
 
-- `$ codeshift init --package-name="foobar" ~/Desktop`
+- `$ codeshift init ~/Desktop/foobar`
 
 Create an empty codeshift package called foobar in the current directory
 
-- `$ codeshift init --package-name="foobar"`
-
-### --package-name
-
-The name of the package/directory to be created.
-
-**example:**
-
-Create an empty codemod package called foobar with a transform.
+- `$ codeshift init`
 
-When `--version` and `--preset` flags are omitted no transforms will be generated.
-To generate tranforms after already generating the directory, simply rerun the command with the necessary flags.
+Create a 'config only' codeshift package in the current
 
-- `$ codeshift init --package-name="foobar" ~/Desktop`
+- `$ codeshift init --config-only`
 
 ### --version (optional)