Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ijlee2 authored Aug 24, 2022
1 parent 6c293d2 commit 758ed3e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npx ember-codemod-pod-to-octane <arguments>

Step 2. Remove `podModulePrefix` from `config/environment.js` and `usePods` from `.ember-cli`.

Step 3. Update relative paths in `import` statements.
Step 3. Update references to the moved files (e.g. `import` statement, `composes` property from `ember-css-modules`).


### Arguments
Expand Down Expand Up @@ -45,19 +45,26 @@ npx ember-codemod-pod-to-octane --test
<details>
<summary>Optional: Specify the project root</summary>

Pass `--root` to run the codemod against (1) a project somewhere else or (2) multiple projects (assuming you have an automation script).
Pass `--root` to run the codemod against a project somewhere else.

```sh
npx ember-codemod-pod-to-octane --root=<your/project/path>
```

Note, you can use `--root` to un-pod the demo app of an Ember addon.

```sh
# If the current directory is the addon root
npx ember-codemod-pod-to-octane --root=tests/dummy/app --type=app
```

</details>


<details>
<summary>Optional: Specify the pod path</summary>

Pass `--pod-path` if `podModulePrefix` is set in `config/environment.js` and has a different value than `modulePrefix`. "Subtract" `modulePrefix` from `podModulePrefix` to get the pod path.
Pass `--pod-path` if `podModulePrefix` has been set in `config/environment.js`. "Subtract" `modulePrefix` from `podModulePrefix` to get the pod path.

```sh
# If modulePrefix is 'my-app' and podModulePrefix is 'my-app/pods'
Expand Down Expand Up @@ -122,4 +129,4 @@ Thanks goes to FlashRecruit, Imago, and CLARK, who gave me the necessary Ember e

## License

This project is licensed under the [MIT License](LICENSE.md).
This project is licensed under the [MIT License](LICENSE.md).

0 comments on commit 758ed3e

Please sign in to comment.