Skip to content

Commit ce72c5a

Browse files
committed
Update Readme
1 parent 7e0b94a commit ce72c5a

2 files changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ember-test-helpers-codemod
22

3-
[![Build Status](https://travis-ci.org/simonihmig/ember-test-helpers-codemod.svg?branch=master)](https://travis-ci.org/simonihmig/ember-test-helpers-codemod)
3+
[![Build Status](https://travis-ci.org/ember-codemods/ember-test-helpers-codemod.svg?branch=master)](https://travis-ci.org/ember-codemods/ember-test-helpers-codemod)
44
[![Build status](https://ci.appveyor.com/api/projects/status/fadn7iu9fl53qb6k/branch/master?svg=true)](https://ci.appveyor.com/project/simonihmig/ember-test-helpers-codemod/branch/master)
55
[![npm version](https://badge.fury.io/js/ember-test-helpers-codemod.svg)](https://badge.fury.io/js/ember-test-helpers-codemod)
66

@@ -28,7 +28,7 @@ npx ember-test-helpers-codemod native-dom tests
2828

2929
## Transformations
3030

31-
### Integrations tests
31+
### Integration tests
3232

3333
This addon will perform the following transformations suitable for integration tests:
3434

@@ -62,6 +62,8 @@ If you want to run only selected transforms on your code, you can pick just the
6262
jscodeshift -t path/to/ember-test-helpers-codemod/transforms/integration/transforms/click.js tests/integration
6363
```
6464

65+
See also docs for [`integration` transform](transforms/integration).
66+
6567
### Acceptance tests
6668

6769
These transformations are available for acceptance tests:
@@ -92,6 +94,8 @@ If you want to run only selected transforms on your code, you can pick just the
9294
jscodeshift -t ../ember-test-helpers-codemod/transforms/acceptance/transforms/click.js tests/integration
9395
```
9496

97+
See also docs for [`acceptance` transform](transforms/acceptance).
98+
9599
### ember-native-dom-helpers tests
96100

97101
These transformations are available for tests based on `ember-native-dom-helpers`:
@@ -104,7 +108,8 @@ These transformations are available for tests based on `ember-native-dom-helpers
104108
| `findAll('.foo', context)` | `context.querySelectorAll('.foo')` |
105109
| `click('.foo', context)` | `click(context.querySelector('.foo'))` |
106110
| `click('.foo', context, { shiftKey: true })` | `click(context.querySelector('.foo'), { shiftKey: true })` |
107-
111+
112+
See also docs for [`native-dom` transform](transforms/native-dom).
108113

109114
### Replace find/findAll
110115

@@ -124,3 +129,17 @@ npx ember-test-helpers-codemod find tests
124129
Note that this will require all instances of `find`/`findAll` to have the correct `this` context, otherwise you will run
125130
into `Cannot read property 'querySelector' of undefined` exceptions, as `this.element` will not be defined. This can
126131
happen outside of the main `test` function, for example inside of custom test helper functions.
132+
133+
See also docs for [`find` transform](transforms/find).
134+
135+
### Replace deprecated `ember-test-helpers` package
136+
137+
Replace all imports of `ember-test-helpers` to `@ember/test-helpers`.
138+
139+
See docs for [`ember-test-helper-api-migration` transform](transforms/ember-test-helper-api-migration).
140+
141+
### Replace deprecated `this.render()` with `render()`
142+
143+
Replace all uses of `this.render()` with `render()`.
144+
145+
See docs for [`this-render-migration` transform](transforms/this-render-migration).

transforms/ember-test-helper-api-migration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ember-test-helper-api-migration
2-
This codemod transfer is to migrate deprecated package `ember-test-helpers` to package `@ember/test-helpers`
2+
This codemod is to migrate deprecated package `ember-test-helpers` to package `@ember/test-helpers`
33

44
## Usage
55

0 commit comments

Comments
 (0)