Make codegen directory output to codemods/

Author: danieldelcore

.changeset/long-lamps-reflect.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/initializer': minor
+---
+
+Codemods are now output to the codemods/ directory instead of src/ to be more flexible when working with both isolated packages and pre-existing packages such as monorepos etc. Tooling should continue to work as expected regardless

packages/initializer/README.md

@@ -1,3 +1,3 @@
 # @codeshift/initializer
 
-Initialize new codemod folders
+Codegens codeshift packages

packages/initializer/src/index.ts

@@ -43,6 +43,7 @@ export function getPackageJson(packageName: string, version = '0.0.0') {
 
 function getNpmIgnore() {
   return `src/
+codemods/
 **/__test__
 **/*.spec.(ts|js)
 .vscode
@@ -96,7 +97,7 @@ function updateConfig(
       });
 
       const transformPath = `./${
-        !isReduced ? 'src/' : ''
+        !isReduced ? 'codemods/' : ''
       }${transformName}/transform`;
 
       properties.push(
@@ -140,9 +141,13 @@ export function initDirectory(
   targetPath = './',
   isReduced = false,
 ) {
-  fs.copySync(path.join(TEMPLATE_PATH, isReduced ? 'src' : ''), targetPath, {
-    filter: src => !src.includes('src/codemod'),
-  });
+  fs.copySync(
+    path.join(TEMPLATE_PATH, isReduced ? 'codemods' : ''),
+    targetPath,
+    {
+      filter: src => !src.includes('codemods/codemod'),
+    },
+  );
 
   if (!isReduced) {
     fs.writeFileSync(
@@ -174,20 +179,20 @@ export function initTransform(
     throw new Error(`Provided version ${id} is not a valid semver version`);
   }
 
-  const transformPath = path.join(targetPath, !isReduced ? 'src' : '', id);
+  const transformPath = path.join(targetPath, !isReduced ? 'codemods' : '', id);
 
   if (fs.existsSync(transformPath)) {
     throw new Error(`Codemod for ${type} "${id}" already exists`);
   }
 
   const codemodTemplateDestinationPath = path.join(
     targetPath,
-    !isReduced ? 'src' : '',
+    !isReduced ? 'codemods' : '',
     'codemod',
   );
 
   fs.copySync(
-    path.join(TEMPLATE_PATH, 'src', 'codemod'),
+    path.join(TEMPLATE_PATH, 'codemods', 'codemod'),
     codemodTemplateDestinationPath,
   );
   fs.renameSync(codemodTemplateDestinationPath, transformPath);

packages/initializer/template/README.md

@@ -10,7 +10,9 @@ This project was bootstrapped with [CodeshiftCommunity 🚚](https://www.codeshi
 
 Runs the codeshift CLI useful for testing transform files as if they have been published
 
-**example:** `npm run dev -t src/10.0.0/transform.ts`
+**example:** `npm run dev -t codemods/10.0.0/transform.ts`
+
+Alternatively, you can run `npm run dev` to see an interactive list of codemods to choose from.
 
 See the [cli reference](https://www.codeshiftcommunity.com/docs/cli) for more information.
 

packages/initializer/template/src/codemod/motions/.gitkeep renamed to packages/initializer/template/codemods/codemod/motions/.gitkeep

@@ -1,5 +1,5 @@
 {
-  "include": ["src/**/*"],
+  "include": ["codemods/**/*"],
   "compilerOptions": {
     "outDir": "dist",
     "esModuleInterop": true,

packages/initializer/template/src/codemod/transform.spec.ts renamed to packages/initializer/template/codemods/codemod/transform.spec.ts

@@ -39,7 +39,7 @@ react-cool-library/
   package.json
   tsconfig.json
   jest.config.js
-  src/
+  codemods/
     10.0.0/ // semver version
       transform.ts // main logic (should contain a transformer)
       transform.spec.ts // main tests
@@ -57,3 +57,10 @@ See the [Testing guide](testing) for help getting started with unit tests.
 Since your new codeshift package can simply be treated as an NPM package you can simply run `npm version [patch\minor\major]` and `npm publish`.
 
 Your package will now be accessible via the `codeshift/cli`. Refer to the [Consuming guide](consuming) for information about how to run your new codemods.
+
+## Examples
+
+Here are some helpful example of this setup working in the wild:
+
+- [Compiled codemods](https://github.com/atlassian-labs/compiled/tree/master/packages/codemods)
+- [Webdriver.io codemods](https://github.com/webdriverio/codemod)

packages/initializer/template/src/codemod/transform.ts renamed to packages/initializer/template/codemods/codemod/transform.ts

@@ -57,7 +57,7 @@ points to them.
 
 See the [configuration guide](/docs/configuration) for help writing config files.
 
-## Initialization
+## Initializing
 
 Codeshift provides a CLI to quickly codegen a working codemod package around your existing source files. To do so, run `init` with the `--config-only` flag,
 which will output a bare-bones configuration. If you provide a `--transform` or `--preset` it will also generate empty transform files in addition.