Skip to content

Commit a3c19ac

Browse files
committed
feat: update readme for 0.1 release
1 parent c9a4c7b commit a3c19ac

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

README.md

+37-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,41 @@ This assumes a few key assumptions and is highly opinionated (though PRs are wel
88
2. You're using [lint-to-the-future](https://github.com/mansona/lint-to-the-future) or heavy uses of Eslint Ignore to identify and address Deprecations
99
3. You're wanting to update to Native Classes (this isn't completely necessary for 4.x but makes addressing some of the deprecations a bit easier)
1010

11+
## Installation
12+
13+
Install this package from npm using
14+
15+
```sh
16+
npm install -g ember-pod-workflow-cli
17+
```
18+
19+
Then make sure you have installed/cached the various codemods (this prevents errors and speeds up execution of the workflow):
20+
21+
```sh
22+
npm install -g ember-angle-brackets-codemod ember-no-implicit-this-codemod ember-native-class-codemod
23+
npx github:ember-codemods/es5-getter-ember-codemod # This will ask to install from github: select y (the command will likely error after that)
24+
```
25+
26+
## Use
27+
28+
To use this CLI run:
29+
30+
```sh
31+
pod-workflow upgrade-pod
32+
```
33+
34+
This will interactively guide you through removing deprecations from a selected pod folder structure.
35+
36+
After completing work on deprecations in a pod you can create a quick PR template.
37+
38+
First set `POD_DASHBOARD` to the public URL of a pod workflow dashboard. Then run:
39+
40+
```sh
41+
pod-workflow pr-description
42+
```
43+
44+
This will copy a markdown flavored PR description with info about what has changed and what lint/deprecations are still left.
45+
1146
## Command Goals
1247

1348
1. [X] Prompt for pod to work on
@@ -23,7 +58,7 @@ This assumes a few key assumptions and is highly opinionated (though PRs are wel
2358
7. [X] Prompt For Commit
2459
8. [X] Show Remaining Lint Errors
2560
9. [ ] Show Components Used
26-
10. [ ] Prompt user to select which components they want to fix
61+
10. [X] Prompt user to select which components they want to fix
2762
* Figure out by getting component info
2863
* List places where it is used outside of selected pod
29-
11. [ ] Repeat 3-7 on selected component paths
64+
11. [X] Repeat 3-7 on selected component paths

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "pod-workflow-cli",
2+
"name": "ember-pod-workflow-cli",
33
"version": "0.1.0",
44
"main": "index.js",
55
"repository": "git@github.com:rtablada/pod-workflow-cli.git",

0 commit comments

Comments
 (0)