Merge pull request #125 from CodeshiftCommunity/prompt

Adds default prompt

Author: danieldelcore

.changeset/tasty-pigs-own.md

@@ -0,0 +1,6 @@
+---
+'@codeshift/cli': minor
+'@codeshift/fetcher': minor
+---
+
+CLI now prompts users with codemods from their local codeshift.config.js files.

package.json

@@ -22,10 +22,10 @@
     "types:check": "tsc --noEmit --skipLibCheck",
     "monorepo:check": "manypkg check",
     "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",
+    "cli:start": "ts-node packages/cli/bin/codeshift-cli.js",
+    "cli:validate": "ts-node packages/cli/bin/codeshift-cli.js validate",
+    "cli:init": "ts-node packages/cli/bin/codeshift-cli.js init",
+    "cli:list": "ts-node packages/cli/bin/codeshift-cli.js list",
     "community:init": "ts-node scripts/initialize.ts",
     "community:validate": "ts-node scripts/validate.ts ./community",
     "community:release": "ts-node scripts/publish.ts ./community .tmp",
@@ -42,6 +42,7 @@
     "@changesets/cli": "^2.6.2",
     "@manypkg/cli": "^0.11.1",
     "@preconstruct/cli": "^2.0.0",
+    "@types/inquirer": "^8.2.1",
     "@types/jest": "^26.0.15",
     "@types/jscodeshift": "^0.11.0",
     "@types/tar": "^4.0.4",

packages/cli/package.json

@@ -21,7 +21,9 @@
     "@codeshift/validator": "^0.4.0",
     "chalk": "^4.1.0",
     "commander": "^8.2.0",
+    "find-up": "^5.0.0",
     "fs-extra": "^9.1.0",
+    "inquirer": "^8.2.4",
     "jscodeshift": "^0.13.1",
     "live-plugin-manager": "^0.15.1",
     "lodash": "^4.17.21",

packages/cli/src/fetch-package.ts

@@ -29,25 +29,25 @@ export async function fetchPackageConfig(
     );
     spinner.succeed(
       `${chalk.green(
-        `Found CodeshiftCommunity package: `,
+        'Found CodeshiftCommunity package:',
       )} ${getCodeshiftPackageName(packageName)}`,
     );
   } catch (error) {
     spinner.warn(
       `${chalk.yellow(
-        `Unable to locate CodeshiftCommunity package: `,
+        `Unable to locate CodeshiftCommunity package:`,
       )} ${getCodeshiftPackageName(packageName)}`,
     );
   }
 
   try {
     remoteConfig = await fetchRemotePackage(packageName, packageManager);
     spinner.succeed(
-      `${chalk.green(`Found codeshift package: `)} ${packageName}`,
+      `${chalk.green('Found codeshift package:')} ${packageName}`,
     );
   } catch (error) {
     spinner.warn(
-      `${chalk.yellow(`Unable to locate codeshift package: `)} ${packageName}`,
+      `${chalk.yellow('Unable to locate codeshift package:')} ${packageName}`,
     );
   }
 
@@ -62,7 +62,7 @@ Make sure the package name "${packageName}" is correct and try again.`,
 
   if (!isValidConfig(config)) {
     throw new Error(
-      `Unable to locate a valid codeshift.config in package ${packageName}`,
+      `Unable to locate a valid codeshift.config in package: ${packageName}`,
     );
   }
 

packages/cli/src/index.ts

@@ -72,7 +72,10 @@ Examples:
   $ codeshift --sequence --packages @mylib/[email protected],@mylib/[email protected] /project/src
 
   # Run the "my-custom-transform" transform
-  $ codeshift -t path/to/my-custom-transform /project/src`,
+  $ codeshift -t path/to/my-custom-transform /project/src
+
+  # Display a prompt with a list of codemods from my local \`codeshift.config.js\` file(s).
+  $ codeshift /project/src`,
   )
   .action((path, options) => main(path, options));
 

packages/cli/src/main.spec.ts

@@ -1,5 +1,6 @@
 jest.mock('globby');
 jest.mock('live-plugin-manager');
+jest.mock('find-up');
 jest.mock('jscodeshift/src/Runner', () => ({
   run: jest.fn().mockImplementation(() => Promise.resolve()),
 }));
@@ -34,7 +35,7 @@ describe('main', () => {
       }
     });
 
-    it('should exit early if nether a package or transform is supplied', async () => {
+    it('should throw if nether a package or transform is supplied and unable to find local config', async () => {
       expect.assertions(1);
 
       try {

packages/cli/src/main.ts

@@ -1,14 +1,18 @@
 import path from 'path';
 import semver from 'semver';
 import chalk from 'chalk';
-import { PluginManager } from 'live-plugin-manager';
+import findUp from 'find-up';
+import inquirer from 'inquirer';
 
+import { fetchConfigAtPath } from '@codeshift/fetcher';
+import { PluginManager } from 'live-plugin-manager';
 // @ts-ignore Run transform(s) on path https://github.com/facebook/jscodeshift/issues/398
 import * as jscodeshift from 'jscodeshift/src/Runner';
 
 import { Flags } from './types';
 import { InvalidUserInputError } from './errors';
 import { fetchPackageConfig } from './fetch-package';
+import { getTransformPrompt } from './prompt';
 
 export default async function main(paths: string[], flags: Flags) {
   const packageManager = new PluginManager({
@@ -18,9 +22,43 @@ export default async function main(paths: string[], flags: Flags) {
   let transforms: string[] = [];
 
   if (!flags.transform && !flags.packages) {
-    throw new InvalidUserInputError(
-      'No transform provided, please specify a transform with either the --transform or --packages flags',
+    console.log(
+      chalk.green(
+        'No transforms specified, attempting to find local codeshift.config file',
+      ),
+    );
+
+    const configFilePath = await findUp([
+      'codeshift.config.js',
+      'codeshift.config.ts',
+      'codeshift.config.tsx',
+      'src/codeshift.config.js',
+      'src/codeshift.config.ts',
+      'src/codeshift.config.tsx',
+      'codemods/codeshift.config.js',
+      'codemods/codeshift.config.ts',
+      'codemods/codeshift.config.tsx',
+    ]);
+
+    if (!configFilePath) {
+      throw new InvalidUserInputError(
+        'No transform provided, please specify a transform with either the --transform or --packages flags',
+      );
+    }
+
+    console.log(
+      chalk.green('Found local codeshift.config file at:'),
+      configFilePath,
     );
+
+    const config = await fetchConfigAtPath(configFilePath);
+    const answers = await inquirer.prompt([getTransformPrompt(config)]);
+
+    if (config.transforms && config.transforms[answers.transform]) {
+      transforms.push(config.transforms[answers.transform]);
+    } else if (config.presets && config.presets[answers.transform]) {
+      transforms.push(config.presets[answers.transform]);
+    }
   }
 
   if (paths.length === 0) {

packages/cli/src/prompt.ts

@@ -0,0 +1,22 @@
+import inquirer from 'inquirer';
+
+import { CodeshiftConfig } from '@codeshift/types';
+
+export const getTransformPrompt = (config: CodeshiftConfig) => {
+  const transforms = Object.keys(config.transforms || {});
+  const presets = Object.keys(config.presets || {});
+
+  const choices = [
+    transforms.length ? new inquirer.Separator('Transforms') : undefined,
+    ...transforms,
+    presets.length ? new inquirer.Separator('Presets') : undefined,
+    ...presets,
+  ].filter(item => item !== undefined);
+
+  return {
+    type: 'list',
+    name: 'transform',
+    message: 'Which transform would you like to run?',
+    choices,
+  };
+};

packages/fetcher/src/index.ts

@@ -9,6 +9,18 @@ function resolveConfigExport(pkg: any): CodeshiftConfig {
   return pkg.default ? pkg.default : pkg;
 }
 
+function requireConfig(filePath: string, resolvedPath: string) {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const pkg = require(resolvedPath);
+    return resolveConfigExport(pkg);
+  } catch (e) {
+    throw new Error(
+      `Found config file "${filePath}" but was unable to parse it. This can be caused when transform or preset paths are incorrect.`,
+    );
+  }
+}
+
 export async function fetchConfig(
   filePath: string,
 ): Promise<CodeshiftConfig | undefined> {
@@ -24,20 +36,25 @@ export async function fetchConfig(
 
     if (!exists) continue;
 
-    try {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const pkg = require(resolvedMatchedPath);
-      return resolveConfigExport(pkg);
-    } catch (e) {
-      throw new Error(
-        `Found config file "${matchedPath}" but was unable to parse it. This can be caused when transform or preset paths are incorrect.`,
-      );
-    }
+    return requireConfig(matchedPath, resolvedMatchedPath);
   }
 
   return undefined;
 }
 
+export async function fetchConfigAtPath(
+  filePath: string,
+): Promise<CodeshiftConfig> {
+  const resolvedFilePath = path.resolve(filePath);
+  const exists = fs.existsSync(resolvedFilePath);
+
+  if (!exists) {
+    throw new Error(`Unable to find config at path: ${filePath}`);
+  }
+
+  return requireConfig(filePath, resolvedFilePath);
+}
+
 export async function fetchPackage(
   packageName: string,
   packageManager: PluginManager,

website/docs/api/codeshift-cli.mdx

@@ -31,7 +31,44 @@ and run with:
 
 `$ codeshift` or `$ codeshift-cli`
 
-## Options
+## default
+
+The default CLI command (when no subcommand is specified,) will attempt to download and run transform(s) against the specified file path.
+
+In the majority of cases you want to be sure to either provide the `--packages` flag for running remote codemods, or the `--transform, -t` flag to run a local transform file.
+
+For running codemods as an end-user it's recommend to use the `--packages` flag, which accepts the following format: `--packages [package-name]@[semver-version]`. For example, running the codemod to migrate your codebase to `react` version `18.0.0` you would specify the following `--packages [email protected]`.
+
+In special cases, codeshift package authors may choose to also expose codemod "presets", which can be considered as utility codemods for that package. Presets are also run via the `--packages` flag like so: `--packages react#remove-spread-props`.
+Notice that we have switched to a hash `#` here to denote that we want to run a preset.
+
+Codeshift will then attempt to locate codemods from both the [community folder](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community) and the primary npm package ie [React – NPM](https://www.npmjs.com/package/react).
+(Note: Some packages wont have any codemods, you can use the [list](#list) subcommand to check if they exist.)
+
+Lastly, when authoring a package, it's possible to test your transforms by omitting both the `--packages` and `--transform` flags. In this interactive mode, the `codeshift/cli` will attempt to locate
+a local `codeshift.config.js` from the current or parent directories and present an interactive prompt for you to choose from.
+
+**example:**
+
+Run a transform for "@mylib/button" version 3.0.0 only
+
+- `$ codeshift --packages @mylib/[email protected] /project/src`
+
+Run a transform for "@mylib/button" preset `foo-bar` only
+
+- `$ codeshift --packages @mylib/button#foo-bar /project/src`
+
+Run all transforms for "@mylib/button" greater than version 3.0.0 and @mylib/range greater than 4.0.0
+
+- `$ codeshift --sequence --packages @mylib/[email protected],@mylib/[email protected] /project/src`
+
+Run the "my-custom-transform" transform
+
+- `$ codeshift -t path/to/my-custom-transform /project/src`
+
+Display a prompt with a list of codemods from my local `codeshift.config.js` file(s).
+
+- `$ codeshift /project/src`
 
 ### --transform, -t