ember-codemod-pod-to-octane
ember-codemod-pod-to-octane copied to clipboard
ijlee2
Codemod to un-pod Ember apps, addons, and engines
ember-codemod-pod-to-octane
Codemod to un-pod Ember apps, addons, and engines
Usage
Step 1. Quickly return to default Octane.
cd <your/project/path>
npx ember-codemod-pod-to-octane <arguments>
Step 2. Remove podModulePrefix from config/environment.js and usePods from .ember-cli.
Step 3. Update references originating from, as well as pointing to, the moved files. These can include import statement, composes property from ember-css-modules, etc.
Arguments
You must pass --type to indicate what type of project you have.
npx ember-codemod-pod-to-octane --type=app
npx ember-codemod-pod-to-octane --type=addon
npx ember-codemod-pod-to-octane --type=engine
Optional: Do a test run
Pass --test to preview how the codemod will move files around.
npx ember-codemod-pod-to-octane --test
Optional: Specify the project root
Pass --root to run the codemod against a project somewhere else.
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.
# If the current directory is the addon root
npx ember-codemod-pod-to-octane --type=app --root=tests/dummy
Optional: Specify the pod path
Pass --pod-path if podModulePrefix has been set in config/environment.js. "Subtract" modulePrefix from podModulePrefix to get the pod path.
# If modulePrefix is 'my-app' and podModulePrefix is 'my-app/pods'
npx ember-codemod-pod-to-octane --pod-path=pods
Limitations
The codemod is designed to cover typical uses of an Ember app, addon, and engine. It is not designed to cover one-off cases.
Apps
To account for a bug (found when Ember CLI is combined with Ember Data), the codemod doesn't consider unit tests for adapters, models, and serializers. You will need to manually move the test files.
Addons
The codemod assumes that an addon is used to define components (not models or routes).
Engines
The codemod assumes that an engine is used to define routes and route-specific components.
To better meet your needs, consider forking the repo and running the codemod locally.
cd <your/forked/repo>
./bin/ember-codemod-pod-to-octane.js <arguments>
Compatibility
- Node.js v16 or above
-
ember-css-modules
Contributing
To provide feedback, you can reach out to me on Discord at ijlee2. Please star this project so that I can gauge its importance to you and the Ember community. ⭐
Credits
Thanks goes to FlashRecruit, Imago, and CLARK, who gave me the necessary Ember experience. Some code is based on ember-component-template-colocation-migrator.
License
This project is licensed under the MIT License.
ijlee2