Remove references to Codeshift

Author: Daniel Del Core

.changeset/cool-snails-visit.md

@@ -0,0 +1,8 @@
+---
+'@hypermod/initializer': patch
+'@hypermod/validator': patch
+'@hypermod/fetcher': patch
+'@hypermod/cli': patch
+---
+
+Remove references to Codeshift

packages/cli/src/index.ts

@@ -14,7 +14,7 @@ const program = new Command();
 program
   .enablePositionalOptions()
   .version(packageJson.version, '-v, --version')
-  .name('codeshift')
+  .name('hypermod')
   .argument('[path...]')
   .usage('[global options] <file-paths>...')
   .option(
@@ -74,16 +74,16 @@ program
     `
 Examples:
   # Run a transform for "@mylib/button" version 3.0.0 only
-  $ codeshift --packages @mylib/button@3.0.0 /project/src
+  $ hypermod --packages @mylib/button@3.0.0 /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/button@3.0.0,@mylib/range@4.0.0 /project/src
+  $ hypermod --sequence --packages @mylib/button@3.0.0,@mylib/range@4.0.0 /project/src
 
   # Run the "my-custom-transform" transform
-  $ codeshift -t path/to/my-custom-transform /project/src
+  $ hypermod -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`,
+  # Display a prompt with a list of codemods from my local \`hypermod.config.js\` file(s).
+  $ hypermod /project/src`,
   )
   .action((path, options) => main(path, options));
 
@@ -96,15 +96,15 @@ program
     `
 Examples:
   # Print a list of available codemods for a single package
-  $ codeshift list mylib
+  $ hypermod list mylib
 
   # Print a list of available codemods for multiple packages
-  $ codeshift list @atlaskit/avatar @emotion/monorepo`,
+  $ hypermod list @atlaskit/avatar @emotion/monorepo`,
   );
 
 program
   .command('init [path]')
-  .description('creates a new codeshift package')
+  .description('creates a new hypermod package')
   .option('-c, --config-only', 'Output only a configuration file')
   .option('-t, --transform <value>', 'Transform version')
   .option('-p, --preset <value>', 'Preset transfrom')
@@ -115,32 +115,32 @@ program
     'after',
     `
 Examples:
-  # Initializes an empty codeshift package at the current directory
-  $ codeshift init --transform 10.0.0 my-codemod-package
+  # Initializes an empty hypermod package at the current directory
+  $ hypermod init --transform 10.0.0 my-codemod-package
 
-  # Initializes an empty codeshift package at the current directory
-  $ codeshift init --transform 10.0.0 .
+  # Initializes an empty hypermod package at the current directory
+  $ hypermod 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 hypermod package with a transform for 10.0.0 at the foobar dir
+  $ hypermod init --transform 10.0.0 ~/foobar
 
-  # Initializes a new codeshift package with a preset "update-imports"
-  $ codeshift init --package-name foobar --preset update-imports foobar
+  # Initializes a new hypermod package with a preset "update-imports"
+  $ hypermod init --package-name foobar --preset update-imports foobar
 
   # Initializes a configuration file only
-  $ codeshift init --config-only --preset update-imports path/to/src`,
+  $ hypermod init --config-only --preset update-imports path/to/src`,
   );
 
 program
   .command('validate [path]')
-  .description('validates if a codeshift package is publishable')
+  .description('validates if a hypermod package is publishable')
   .action(path => validate(path))
   .addHelpText(
     'after',
     `
 Examples:
-  $ codeshift validate
-  $ codeshift validate ./codemods/my-codemods`,
+  $ hypermod validate
+  $ hypermod validate ./codemods/my-codemods`,
   );
 
 (async function () {

packages/cli/src/init.ts

@@ -13,7 +13,7 @@ export default async function init(
   targetPath = '.',
 ) {
   const packageName =
-    targetPath !== '.' ? path.basename(targetPath) : 'codeshift-community';
+    targetPath !== '.' ? path.basename(targetPath) : 'Hypermod';
 
   if (configOnly) {
     initConfig(packageName, targetPath);
@@ -33,13 +33,13 @@ export default async function init(
   Inside that directory, you can run the following commands:
 
   ${chalk.blueBright('npm run dev')}
-  Starts the Codeshift cli
+  Starts the Hypermod CLI
 
   ${chalk.blueBright('npm run test')}
   Launches the test runner in watch mode.
 
   ${chalk.blueBright('npm run validate')}
-  Checks the validity of your \`codeshift.config.js\` file
+  Checks the validity of your \`hypermod.config.js\` file
 
   ${chalk.blueBright('npm run build')}
   Builds the app for production to the \`dist\` folder.
@@ -55,6 +55,6 @@ export default async function init(
   }
 
   console.log(
-    chalk.green(`🚚 New codeshift.config.js created at: ${targetPath}`),
+    chalk.green(`🚚 New hypermod.config.js created at: ${targetPath}`),
   );
 }

packages/cli/src/list.spec.ts

@@ -111,7 +111,7 @@ ${chalk.bold('@foo/bar')}
     await list(['bar']);
 
     expect(console.warn).toHaveBeenCalledWith(
-      chalk.red(`Unable to find codeshift package: ${chalk.bold('bar')}.`),
+      chalk.red(`Unable to find Hypermod package: ${chalk.bold('bar')}.`),
     );
     expect(console.warn).toHaveBeenCalledTimes(1);
   });
@@ -126,10 +126,10 @@ ${chalk.bold('@foo/bar')}
     await list(['bar', '@foo/bar']);
 
     expect(console.warn).toHaveBeenCalledWith(
-      chalk.red(`Unable to find codeshift package: ${chalk.bold('bar')}.`),
+      chalk.red(`Unable to find Hypermod package: ${chalk.bold('bar')}.`),
     );
     expect(console.warn).toHaveBeenCalledWith(
-      chalk.red(`Unable to find codeshift package: ${chalk.bold('@foo/bar')}.`),
+      chalk.red(`Unable to find Hypermod package: ${chalk.bold('@foo/bar')}.`),
     );
     expect(console.warn).toHaveBeenCalledTimes(2);
   });
@@ -183,10 +183,10 @@ ${chalk.bold('found2')}
    └─ sort-imports`);
 
     expect(console.warn).toHaveBeenCalledWith(
-      chalk.red(`Unable to find codeshift package: ${chalk.bold('unknown')}.`),
+      chalk.red(`Unable to find Hypermod package: ${chalk.bold('unknown')}.`),
     );
     expect(console.warn).toHaveBeenCalledWith(
-      chalk.red(`Unable to find codeshift package: ${chalk.bold('dunno')}.`),
+      chalk.red(`Unable to find Hypermod package: ${chalk.bold('dunno')}.`),
     );
     expect(console.warn).toHaveBeenCalledTimes(2);
   });

packages/cli/src/list.ts

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import { PluginManager } from 'live-plugin-manager';
 
 import { fetchPackages } from './utils/fetch-package';
-import { getCodeshiftPackageName } from './utils/package-names';
+import { getHypermodPackageName } from './utils/package-names';
 
 export default async function list(packages: string[]) {
   const packageManager = new PluginManager();
@@ -16,14 +16,14 @@ export default async function list(packages: string[]) {
       );
       community &&
         configs.push({
-          packageName: getCodeshiftPackageName(packageName),
+          packageName: getHypermodPackageName(packageName),
           config: community.config,
         });
       remote && configs.push({ packageName, config: remote.config });
     } catch (error) {
       console.warn(
         chalk.red(
-          `Unable to find codeshift package: ${chalk.bold(packageName)}.`,
+          `Unable to find Hypermod package: ${chalk.bold(packageName)}.`,
         ),
       );
 

packages/cli/src/main.ts

@@ -48,7 +48,7 @@ export default async function main(
   if (!flags.transform && !flags.packages) {
     console.log(
       chalk.green(
-        'No transforms specified, attempting to find local codeshift.config file(s)',
+        'No transforms specified, attempting to find local hypermod.config file(s)',
       ),
     );
 
@@ -115,6 +115,15 @@ export default async function main(
        * Otherwise, locate any config files in parent directories
        */
       const configFilePath = await findUp([
+        'hypermod.config.js',
+        'hypermod.config.ts',
+        'hypermod.config.tsx',
+        'src/hypermod.config.js',
+        'src/hypermod.config.ts',
+        'src/hypermod.config.tsx',
+        'codemods/hypermod.config.js',
+        'codemods/hypermod.config.ts',
+        'codemods/hypermod.config.tsx',
         'codeshift.config.js',
         'codeshift.config.ts',
         'codeshift.config.tsx',
@@ -133,7 +142,7 @@ export default async function main(
       }
 
       console.log(
-        chalk.green('Found local codeshift.config file at:'),
+        chalk.green('Found local hypermod.config file at:'),
         configFilePath,
       );
 

packages/cli/src/utils/fetch-package.ts

@@ -9,40 +9,36 @@ import {
 } from '@hypermod/fetcher';
 import { isValidConfig } from '@hypermod/validator';
 
-import { getCodeshiftPackageName } from './package-names';
+import { getHypermodPackageName } from './package-names';
 
 export async function fetchPackages(
   packageName: string,
   packageManager: PluginManager,
 ) {
-  const codeshiftPackageName = getCodeshiftPackageName(packageName);
-  let codeshiftPackage: ConfigMeta | undefined;
+  const hypermodPackageName = getHypermodPackageName(packageName);
+  let hypermodPackage: ConfigMeta | undefined;
   let remotePackage: ConfigMeta | undefined;
 
   const spinner = ora(
-    `${chalk.green(
-      'Attempting to download CodeshiftCommunity package:',
-    )} ${packageName}`,
+    `${chalk.green('Attempting to download Hypermod package:')} ${packageName}`,
   ).start();
 
   try {
-    codeshiftPackage = await fetchPackage(codeshiftPackageName, packageManager);
+    hypermodPackage = await fetchPackage(hypermodPackageName, packageManager);
     spinner.succeed(
-      `${chalk.green(
-        'Found CodeshiftCommunity package:',
-      )} ${codeshiftPackageName}`,
+      `${chalk.green('Found Hypermod package:')} ${hypermodPackageName}`,
     );
   } catch (error) {
     spinner.warn(
       `${chalk.yellow(
-        `Unable to locate CodeshiftCommunity package:`,
-      )} ${codeshiftPackageName}`,
+        `Unable to locate Hypermod package:`,
+      )} ${hypermodPackageName}`,
     );
   }
 
-  if (codeshiftPackage && !isValidConfig(codeshiftPackage.config)) {
+  if (hypermodPackage && !isValidConfig(hypermodPackage.config)) {
     throw new Error(
-      `Unable to locate a valid codeshift.config for Community package: ${packageName}`,
+      `Unable to locate a valid hypermod.config for community package: ${packageName}`,
     );
   }
 
@@ -51,30 +47,28 @@ export async function fetchPackages(
       `${chalk.green(`Attempting to download npm package:`)} ${packageName}`,
     );
     remotePackage = await fetchRemotePackage(packageName, packageManager);
-    spinner.succeed(
-      `${chalk.green('Found codeshift package:')} ${packageName}`,
-    );
+    spinner.succeed(`${chalk.green('Found hypermod package:')} ${packageName}`);
   } catch (error) {
     spinner.warn(
-      `${chalk.yellow('Unable to locate codeshift package:')} ${packageName}`,
+      `${chalk.yellow('Unable to locate hypermod package:')} ${packageName}`,
     );
   }
 
   if (remotePackage && !isValidConfig(remotePackage.config)) {
     throw new Error(
-      `Unable to locate a valid codeshift.config for remote package: ${packageName}`,
+      `Unable to locate a valid hypermod.config for remote package: ${packageName}`,
     );
   }
 
-  if (!codeshiftPackage && !remotePackage) {
+  if (!hypermodPackage && !remotePackage) {
     throw new Error(
-      `Unable to locate package from codeshift-community or NPM.
+      `Unable to locate package from Hypermod community or NPM.
 Make sure the package name "${packageName}" is correct and try again.`,
     );
   }
 
   return {
-    community: codeshiftPackage,
+    community: hypermodPackage,
     remote: remotePackage,
   };
 }

packages/cli/src/utils/package-names.ts

@@ -1,3 +1,3 @@
-export function getCodeshiftPackageName(packageName: string) {
+export function getHypermodPackageName(packageName: string) {
   return `@hypermod/mod-${packageName.replace('@', '').replace('/', '__')}`;
 }