Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apsdehal/qunit-migrate
Migrate old QUnit tests to 2.x. Uses regex and ASTs to convert old QUnit code.
https://github.com/apsdehal/qunit-migrate
ast migrator qunit regex
Last synced: 15 days ago
JSON representation
Migrate old QUnit tests to 2.x. Uses regex and ASTs to convert old QUnit code.
- Host: GitHub
- URL: https://github.com/apsdehal/qunit-migrate
- Owner: apsdehal
- License: mit
- Created: 2015-07-03T22:15:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-21T18:27:29.000Z (about 8 years ago)
- Last Synced: 2024-10-12T02:54:37.852Z (about 1 month ago)
- Topics: ast, migrator, qunit, regex
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 17
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QUnit Migrate
[](https://www.npmjs.com/package/qunit-migrate)
[](https://travis-ci.org/apsdehal/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]
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 Config file for qunit-migrate
-P, --parser Parser to be used for parsing, Default: ast
-w, --write Pass if parsed files should be overwritten. Default: false
-p, --preset 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](examples/default.config.json)
[Sample config file](examples/sample.config.json)
[Config Rules](examples/rules.md)
## Example:
qunit-migrate tries to change old QUnit code to new QUnit specifications.
For e.g. following code will be converted as follows:
```js
// 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
```js
// 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
```js
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](https://apsdehal.in)