temp

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.

packages/cli/package.json

@@ -15,7 +15,6 @@
     "start:dev": "ts-node src/index.ts"
   },
   "dependencies": {
-    "@codemod/cli": "^3.1.2",
     "@codeshift/fetcher": "^0.0.3",
     "@codeshift/initializer": "^0.3.0",
     "@codeshift/types": "*",

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

@@ -32,6 +32,12 @@ export default async function main(paths: string[], flags: Flags) {
       '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) {

packages/fetcher/src/index.ts

@@ -9,16 +9,16 @@ function resolveConfigExport(pkg: any): CodeshiftConfig {
   return pkg.default ? pkg.default : pkg;
 }
 
-function requireConfig(filePath: string, resolvedPath: string ) {
+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.`,
-      );
-    }
+    // 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(
@@ -49,10 +49,8 @@ export async function fetchConfigAtPath(
   const exists = fs.existsSync(resolvedFilePath);
 
   if (!exists) {
-    throw new Error(
-      `Unable to find config at path: ${filePath}`,
-    );
-  };
+    throw new Error(`Unable to find config at path: ${filePath}`);
+  }
 
   return requireConfig(filePath, resolvedFilePath);
 }

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