Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajasegar/app-to-addon-migrator
Ember app to addon migrator with Yarn workspaces
https://github.com/rajasegar/app-to-addon-migrator
cli ember ember-engines migration-tool
Last synced: 8 days ago
JSON representation
Ember app to addon migrator with Yarn workspaces
- Host: GitHub
- URL: https://github.com/rajasegar/app-to-addon-migrator
- Owner: rajasegar
- Created: 2020-05-04T05:05:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T06:38:25.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T21:21:16.851Z (29 days ago)
- Topics: cli, ember, ember-engines, migration-tool
- Language: JavaScript
- Size: 2.59 MB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# app-to-addon-migrator
[](https://coveralls.io/github/rajasegar/app-to-addon-migrator?branch=master)
[](https://github.com/semantic-release/semantic-release)
[](https://npmjs.org/package/app-to-addon-migrator "View this project on npm")
An opinionated cli tool to migrate Ember components from app to addons within a Yarn workspace.
*NOTE:* This cli tool works only with the following conventional folder structure for your Ember app.
```
|-app
|-packages
| |-addons
| |-engines
| | |-dashboards-engine
| | |-tickets-engine
```
## Assumptions made by this tool
- Your Ember app lives in the root of your project folder.
- Engines live under `packages/engines` folder.
- Addons live under `packages/addons` folder.
- You are using [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
- You are using [POD](https://cli.emberjs.com/release/advanced-use/project-layouts/#podslayout) structure for your components.
## Install
```
npm i -g app-to-addon-migrator
```
## Usage
### 1. ateam (wizard UI)
```
ateam
```
[](https://asciinema.org/a/364494)
### 2. atam (classic CLI)
```
atam [entity] [entity-name] [dest-folder]
atam route default packages/engines/dashboards-engine
```
After running the above command, the route `default` from `app/routes/default.js` will be
moved to `packages/engines/dashboards-engine/addon/routes/default.js`
### Dry-run
If you just want to see/verify the movement use the `--dry-run` or `-d` option.
```
atam route default packages/engines/dashboards-engine -d
```
This will print something like (without actually copying the files):
```
Moving route.js
---------------
app/routes/helpdesk/default.js
packages/engines/dashboards-engine/addon/routes/default.js
Moving route template.hbs
-------------------------
app/templates/helpdeskdefault.hbs
packages/engines/dashboards-engine/addon/templates/default.hbs
...
```
### Folder namespace
If your source entities are namespaced within a folder you can use the `-f` option to specify the same
before copying.
Say for example you want to move a component called `widget` from `app/components/dashboards`
```
atam component widget packages/engines/dashboards-engine -f dashboards
```
## Commands:
```
atam adapter [adapter-name] Copy an adapter from app to addon
[destination]
atam component [component-name] Copy a component from app to addon
[destination]
atam constant [constant-name] Copy a constant from app to addon
[destination]
atam helper [helper-name] [destination] Copy a helper from app to addon
atam mixin [mixin-name] [destination] Copy a mixin from app to addon
atam model [model-name] [destination] Copy a model from app to addon
atam route [route-name] [destination] Copy a route with controller from
app to addon
atam routex [route-name] [destination] Copy a route and its dependent
components from app to addon
atam service [storage-name] Copy a storage from app to addon
[destination]
atam storage [storage-name] Copy a storage from app to addon
[destination]
atam util [util-name] [destination] Copy a util from app to addon
atam validator [validator-name] Copy a validator from app to addon
[destination]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--dry-run, -d Dry Run: Verify the movement without executing [boolean]
--pods, -p Specify that the source components use PODS structure
[boolean] [default: true]
```
## References
- http://ember-engines.com/
- https://developer.squareup.com/blog/ember-and-yarn-workspaces/
- https://medium.com/@lukedeniston/how-to-write-a-really-really-ambitious-spa-in-2019-60fc38de89db
- https://github.com/lennyburdette/ember-monorepo-demo
- https://discuss.emberjs.com/t/yarn-workspaces-and-ember/15672/13
- https://github.com/habdelra/yarn-workface