From 758ed3e48e6bcb87f0b4a3d4180db83f6f8d18e0 Mon Sep 17 00:00:00 2001 From: Isaac Lee <16869656+ijlee2@users.noreply.github.com> Date: Wed, 24 Aug 2022 08:01:08 +0200 Subject: [PATCH] Updated README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 82ff2ce..672fe38 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ npx ember-codemod-pod-to-octane 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 @@ -45,19 +45,26 @@ npx ember-codemod-pod-to-octane --test
Optional: Specify the project root -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= ``` +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 +``` +
Optional: Specify the pod path -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' @@ -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). \ No newline at end of file +This project is licensed under the [MIT License](LICENSE.md).