Skip to content

Commit 1063fd4

Browse files
committed
Updated README
1 parent 83ca676 commit 1063fd4

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
This codemod will co-locate component JS and HBS as described in the [Component Templates Co-location RFC](https://emberjs.github.io/rfcs/0481-component-templates-co-location.html).
44

5-
### Examples
5+
## Examples
66

77
* [Travis CI](https://github.com/GavinJoyce/travis-web/pull/1)
88
* [Ghost Admin](https://github.com/GavinJoyce/Ghost-Admin/pull/1)
99

10-
### Usage
10+
## Usage
1111

1212
To run the migrator on your app:
1313

@@ -16,6 +16,8 @@ cd your/project/path
1616
npx github:ember-codemods/ember-component-template-colocation-migrator
1717
```
1818

19+
### Flat component structure
20+
1921
By default, the migrator changes the **classic** component structure to the **flat** component structure.
2022

2123
```
@@ -30,6 +32,8 @@ your-project-name
3032
│ ...
3133
```
3234

35+
### Nested component structure
36+
3337
If you want to change from **classic** to **nested**, you can add the `-ns` flag:
3438

3539
```sh
@@ -53,6 +57,12 @@ your-project-name
5357
```
5458

5559

56-
### Running Tests
60+
## Running Tests
61+
62+
The tests were inspired by [ember-module-migrator](https://github.com/ember-codemods/ember-module-migrator/blob/master/test/engines/classic-test.js).
5763

58-
* `npm run test`
64+
If you are contributing to this codemod, please check that all tests pass by running,
65+
66+
```sh
67+
yarn test
68+
```

0 commit comments

Comments
 (0)