apsdehal / qunit-migrate

Migrate old QUnit tests to 2.x. Uses regex and ASTs to convert old QUnit code.

QUnit Migrate

Migrate old QUnit code to 2.x.

Features

• JSCS support
• Custom config support for defining rules
• Supports conversion of Async tests
• Support for globbing patterns
• Both regex and ast parser supported

Install

npm install --global qunit-migrate

Usage

  qunit-migrate -h

  Usage: qunit-migrate [options] <file ...>

  QUnit Migrate: A tool to migrate your files to QUnit 2.0 API

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -c, --config <path>       Config file for qunit-migrate
    -P, --parser <regex|ast>  Parser to be used for parsing, Default: ast
    -w, --write               Pass if parsed files should be overwritten. Default: false
    -p, --preset <string>     Preset rule for jscs config. Default: jquery
    -j, --no-jscs             Pass if jscs fix should not be applied. Default: true

  Globbing is supported in files

  Examples:

    $ qunit-migrate "./**/*.js" -w --preset "google" -c "config.json"
    $ # This will migrate all js files in subdirectories using google
    $ # preset and config as config.json

Information: AST parser is more robust than regex parser

Configuration

Various rules can be toggled through use of custom config which can be passed via -c option.

Default config file

Sample config file

Config Rules

Example:

qunit-migrate tries to change old QUnit code to new QUnit specifications.

For e.g. following code will be converted as follows:

// Taken directly from jquery-globalize
// file1.js
define([
  "cldr",
  "src/core",
  "json!cldr-data/supplemental/likelySubtags.json",
  "cldr/event"
], function( Cldr, Globalize, likelySubtags ) {
Cldr.load( likelySubtags );
module( "Globalize.locale" );
ssyncTest( "should allow String locale", function() {
  stop();
  Globalize.locale( "en" );
  ok( Globalize.cldr instanceof Cldr );
  equal( Globalize.cldr.locale, "en" );
  start();
});
});

$ qunit-migrate "file1.js" -w

to

// Taken directly from jquery-globalize
// file1.js
define( [ 
  "qunit",
  "cldr",
  "src/core",
  "json!cldr-data/supplemental/likelySubtags.json",
  "cldr/event"
], function( QUnit, Cldr, Globalize, likelySubtags ) {
Cldr.load( likelySubtags );
QUnit.module( "Globalize.locale" );
QUnit.test( "should allow String locale", function( assert ) {
  var ready = assert.async();
  Globalize.locale( "en" );
  assert.ok( Globalize.cldr instanceof Cldr );
  assert.equal( Globalize.cldr.locale, "en" );
  ready();
});
});

API

$ npm install --save qunit-migrate

var qunitMigrate = require('qunit-migrate');
var qmAst = qunitMigrate.ast;
var qmRegex = qunitMigrate.regex;
var data = 'Some old qunit code';

var modifiedDataAST = qmAst(data); // Fixed code through AST
var modifiedDataRegex = qmRegex(data); // Fixed code through AST

Information: qunit-migrate api doesn't fix source with jscs

Accuracy & Limitations

QUnit migrate tries its best to upgrade your API, but there are still some limitations.

For e.g.

• If you are encapsulating some of your logic in a function and using assertions in that, it is your responsibility to pass assert into function parameters. API of qunit-migrate can also be upgraded to do this, but it doesn't support it at the moment
• There might be issues with require definitions some time if they are not in the start and encapsulated somewhere.
• QUnit.reset is not supported as of now

All these are fixable through AST. Pull requests are welcome

License

MIT © Amanpreet Singh

qunit-migrate's Issues

how to glob files

Hi, Glad you made this migration runner, because it is helpful.
Strangely, I can't get globbing to work.

I can run single files no problem though.

let's say I have tests in => tests/unit/models directory
and there are files in there like user-test.js , etc

say I am on tests/ directory

if I do:

 qunit-migrate './unit/**/*.js'   // get error ( can't find any files )  
 qunit-migrate './unit/models/*.js'   // get error ( can't find any files )  
 qunit-migrate './unit/models/user-test.js'   // works fine ( only does one file thought .. kinda boring ) 

I am kinda puzzled cause it seems to easy .. am I missing something?

Error running tool

I get an error after installing and running

% /home/bpant/local/bin/qunit-migrate test/componenttests.html --no-jscs -w --preset "google"
✖ Error occured while fixing file: test/componenttests.html
Error: Line 1: Unexpected token <
Following files were not converted:
✖ test/componenttests.html

The file exists there, and I also tried with -c "default.json" where default.json was downloaded from the default config json provided

Not sure if this has to do with how my qunit-migrate was installed

% ls -al /home/bpant/local/bin/qunit-migrate
lrwxrwxrwx 1 bpant users 51 Aug 3 10:07 /home/bpant/local/bin/qunit-migrate -> ../lib/node_modules/qunit-migrate/bin/qunit-migrate*

Support for string type

Currently, migrates to single quote we need to support double quotes also.

Can we combine our efforts?

I'm working on a tool platinumazure/qunit2-migrator. Is it worth combining our efforts somehow?

Modular code

Currently, there is a lot of repetition in code including tests. It needs to be more modular.

Use recast for parsing code and modifications

Certainly, the current situation with regex is working fine, but it is not a long term solution for migrations.
As the API is modifying day by day, it would be better to use recast and use AST to migrate.

https://github.com/benjamn/recast can help in achieving this.

Convert asyncTest()/start() to test()/assert.async()/done()

asyncTest(), stop() and start() (as used in tests) are deprecated: http://api.qunitjs.com/QUnit.asyncTest/

Noticed this while reviewing jquery/jquery-ui#1577 - but addressing that will affect other projects as well.

Support for different conventions

Currently, qunit-migrate migrate to jQuery convention of code. We should strict type check the coding type.