Codemod to transform your jQuery based ember tests to use ember-native-dom-helpers
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
__testfixtures__
__tests__
bin
lib
.gitignore
.npmignore
.travis.yml Travis setup Apr 30, 2017
LICENSE.md
README.md simplify instructions using npx Mar 20, 2018
index.js
package.json
yarn.lock

README.md

ember-native-dom-helpers-codemod

Build Status

A jscodeshift based codemod to help migrating your jQuery based Ember tests to ember-native-dom-helpers.

If you are looking for a way to transform your tests to Ember's latest testing APIs, specifically to the new helpers provided by @ember/test-helpers, then please use this codemod's successor:
ember-test-helpers-codemod!

Please note that this will not be able to cover all possible cases how jQuery based tests can be written. Given the dynamic nature of JavaScript and the extensive API and fluent interface of jQuery, this would be impossible. Instead this codemod focuses to cover the most common usages and do those transformations that it can safely do. So it is likely that you will have to manually migrate some usages this tool cannot cover!

Usage

This package requires Node 6 or later. Make sure you are using a newer version of Node before installing and running this package.

WARNING: jscodeshift, and thus this codemod, edit your files in place. It does not make a copy. Make sure your code is checked into a source control repository like Git and that you have no outstanding changes to commit before running this tool.

cd my-ember-app-or-addon
npx ember-native-dom-helpers-codemod --type=integration tests/integration
npx ember-native-dom-helpers-codemod --type=acceptance tests/acceptance

Transformations

Integrations tests

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

Before After Transform
this.$('.foo').attr('id') find('.foo').id attr.js
this.$('.foo').attr('data-test') find('.foo').getAttribute('data-test') attr.js
this.$('.foo').click() await click('.foo') click.js
this.$('.foo').change() (and more events) await triggerEvent('.foo', 'change') trigger-shortcut.js
this.$('.foo').trigger('input') await triggerEvent('.foo', 'input') trigger.js
this.$('.foo').focus() await focus('.foo') focus.js
this.$('.foo').val() find('.foo').value get-value.js
this.$('div').hasClass('foo') find('div').classList.contains('foo') has-class.js
this.$('.foo').trigger('click') await click('.foo') key-event.js
this.$('.foo').trigger('keydown', { keyCode: 13 }) await keyEvent('.foo', 'keydown', 13) key-event.js
this.$('.foo').length findAll('.foo').length length.js
this.$('.foo').prop('tagName') find('.foo').tagName prop.js
this.$('.foo').val('foo') await fillIn('.foo', 'foo') set-value.js
this.$('.foo').val('bar').change() await fillIn('.foo', 'foo'); await blur('.foo'); set-value.js
this.$('.foo').val('bar').trigger('input') await fillIn('.foo', 'foo') set-value.js
this.$('.foo').text() find('.foo').textContent text.js
this.$('.foo').html() find('.foo').innerHTML html.js
this.$('.foo').html('foo') find('.foo').innerHTML = 'foo' html.js
this.$('.foo').each((index, elem) => {...}) findAll('.foo').forEach((elem, index) => {...}) each.js
this.$('.foo').get(3) findAll('.foo')[3] get.js

If you want to run only selected transforms on your code, you can just the needed transform:

jscodeshift -t ../ember-native-dom-helpers-codemod/lib/transforms/click.js tests/integration

Acceptance tests

These transformations are available for acceptance tests:

Before After Transform
find('.foo').attr('id') find('.foo').id attr.js
find('.foo').attr('data-test') find('.foo').getAttribute('data-test') attr.js
click('.foo') await click('.foo') click.js
fillIn('#bar', 'baz') await fillIn('#bar', 'baz') fill-in.js
triggerEvent('input', 'focus') await focus('.foo') trigger-event.js
triggerEvent('input', 'blur') await blur('.foo') trigger-event.js
triggerEvent('input', 'mouseenter') await triggerEvent('input', 'mouseenter') trigger-event.js
find('.foo').val() find('.foo').value get-value.js
find('div').hasClass('foo') find('div').classList.contains('foo') has-class.js
keyEvent('#bar', 'keypress', 13); await keyEvent('.foo', 'keydown', 13) key-event.js
find('.foo').length findAll('.foo').length length.js
find('.foo').prop('tagName') find('.foo').tagName prop.js
find('.foo').text() find('.foo').textContent text.js
find('.foo').html() find('.foo').innerHTML html.js
find('.foo').html('foo') find('.foo').innerHTML = 'foo' html.js
find('.foo').each((index, elem) => {...}) findAll('.foo').forEach((elem, index) => {...}) each.js
find('.foo').get(3) findAll('.foo')[3] get.js

If you want to run only selected transforms on your code, you can just the needed transform:

jscodeshift -t ../ember-native-dom-helpers-codemod/lib/transforms/click.js tests/integration