Merge pull request #119 from CodeshiftCommunity/refactor-init-logic

Refactor init logic

Author: danieldelcore

.github/workflows/release-all-codemods.yml

@@ -22,8 +22,8 @@ jobs:
       - run: yarn install --frozen-lockfile
       - run: yarn validate
       - run: yarn test
-      - run: yarn validate:codemods
-      - run: yarn release-all:codemods
+      - run: yarn community:validate
+      - run: yarn community:release-all
         env:
           CI: true
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release-codemods.yml

@@ -24,8 +24,8 @@ jobs:
       - run: yarn install --frozen-lockfile
       - run: yarn validate
       - run: yarn test
-      - run: yarn validate:codemods
-      - run: yarn release:codemods
+      - run: yarn community:validate
+      - run: yarn community:release
         env:
           CI: true
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/validate-codmods.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: yarn install --frozen-lockfile
-      - run: yarn validate:codemods
+      - run: yarn community:validate
         env:
           CI: true
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -24,12 +24,13 @@
     "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",
-    "release:codemods": "ts-node scripts/publish.ts ./community .tmp",
-    "release-all:codemods": "ts-node scripts/publish-all.ts ./community .tmp",
-    "release-all-dry:codemods": "ts-node scripts/publish-all-dry.ts ./community .tmp",
+    "community:init": "ts-node scripts/initialize.ts",
+    "community:validate": "ts-node scripts/validate.ts ./community",
+    "community:release": "ts-node scripts/publish.ts ./community .tmp",
+    "community:release-all": "ts-node scripts/publish-all.ts ./community .tmp",
+    "community:release-all-dry": "ts-node scripts/publish-all-dry.ts ./community .tmp",
     "prerelease": "yarn validate && yarn test",
     "release": "yarn changeset publish"
   },

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.spec.ts

@@ -1,16 +1,9 @@
 jest.mock('fs-extra');
 jest.mock('@codeshift/fetcher');
 
-import fs from 'fs-extra';
-
 import { fetchConfig } from '@codeshift/fetcher';
 
-import {
-  isValidPackageName,
-  isValidConfig,
-  isValidConfigAtPath,
-  isValidPackageJson,
-} from '.';
+import { isValidPackageName, isValidConfig, isValidConfigAtPath } from '.';
 
 describe('validator', () => {
   describe('isValidPackageName', () => {
@@ -173,54 +166,4 @@ Please make sure all presets are kebab case and contain no spaces or special cha
       );
     });
   });
-
-  describe('isValidPackageJson', () => {
-    afterEach(() => jest.resetAllMocks());
-
-    it('should detect valid package.json', async () => {
-      (fs.readFile as jest.Mock).mockReturnValue(`{
-        "name": "codeshift-package",
-        "main": "dist/index.js",
-        "version": "0.0.1"
-      }`);
-
-      const result = await isValidPackageJson('path/to/');
-      expect(result).toEqual(true);
-      expect(fs.readFile).toHaveBeenCalledWith('path/to/package.json', 'utf8');
-    });
-
-    it('should detect invalid package.json', async () => {
-      expect.assertions(2);
-
-      {
-        (fs.readFile as jest.Mock).mockReturnValue(`{
-        "name": "codeshift-package"
-      }`);
-
-        try {
-          await isValidPackageJson('path/to/');
-        } catch (error) {
-          // @ts-ignore
-          expect(error.message).toMatch(
-            'No main entrypoint provided in package.json',
-          );
-        }
-      }
-
-      {
-        (fs.readFile as jest.Mock).mockReturnValue(`{
-            "main": "dist/index.js"
-          }`);
-
-        try {
-          await isValidPackageJson('path/to/');
-        } catch (error) {
-          // @ts-ignore
-          expect(error.message).toMatch(
-            'No package name provided in package.json',
-          );
-        }
-      }
-    });
-  });
 });