An open API service indexing awesome lists of open source software.

https://github.com/power-assert-js/espower-traceur


https://github.com/power-assert-js/espower-traceur

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

espower-traceur
========================

[![Build Status](https://travis-ci.org/yosuke-furukawa/espower-traceur.svg?branch=master)](https://travis-ci.org/yosuke-furukawa/espower-traceur)

power-assert instrumentor for [Traceur Compiler](https://github.com/google/traceur-compiler/)

DESCRIPTION
---------------------------------------
`espower-traceur` is a Node.js module loader that instruments [power-assert](http://github.com/twada/power-assert) feature into target ECMAScript6 sources on the fly.

Please note that `espower-traceur` is a beta version product. Pull-requests, issue reports and patches are always welcomed. See [power-assert](http://github.com/twada/power-assert) project for more documentation.

EXAMPLE
---------------------------------------

Given `test/demo_test.js`

```javascript
let assert = require('power-assert')

class Person {
constructor(name, age) {
this.name = name
this.age = age
}
getAge() {
return this.age
}
}

describe("Person", ()=>{
let alice = new Person("alice", 3)
let bob = new Person("bob", 5)
it("#getAge", ()=>{
assert(alice.getAge() === 3)
})
it("#name", ()=>{
assert(alice.name === "alice")
})
// failed
it("#mistake", ()=>{
assert(alice.name === bob.name)
})
})
```

Run mocha with `--require 'espower-traceur/guess'`

```
$ mocha --require 'espower-traceur/guess' test/demo_test.js

․․․

2 passing (17ms)
1 failing

1) Person #mistake:
AssertionError: # /Users/yosuke/go/src/github.com/yosuke-furukawa/espower-traceur/test/demo_test.js:24

assert(alice.name === bob.name)
| | | | |
| | | | "bob"
| | | Person{name:"bob",age:5}
| | false
| "alice"
Person{name:"alice",age:3}

--- [string] bob.name
+++ [string] alice.name
@@ -1,3 +1,5 @@
-bob
+alice
```

See the power-assert output appears!

INSTALL
---------------------------------------

$ npm install espower-traceur -D

HOW TO USE
---------------------------------------

### Zero-config mode

If your tests are located on `'test/**/*.js'`, just run mocha with `--require 'espower-traceur/guess'`

$ mocha --require 'espower-traceur/guess' test/**/*.js

### If your tests are not in test dir

You can set test directory in your `package.json`

```json
{
"name": "your-module",
"description": "Your module",
"version": "0.0.1",
"directories": {
"test": "spec/"
},
...
}
```

Then, run mocha with `--require 'espower-traceur/guess'`

$ mocha --require 'espower-traceur/guess' spec/**/*.js

Note: `'espower-traceur/guess'` is inspired by [intelli-espower-loader](https://github.com/azu/intelli-espower-loader)

### More customization

If you want to configure more explicitly, put `espower-traceur-loader.js` somewhere in your project.

```javascript
require('espower-traceur')({
// directory where match starts with
cwd: process.cwd(),

// glob pattern using minimatch module
pattern: 'spec/unit/**/*.js',

// options for espower module
espowerOptions: {
patterns: [
'assert(value, [message])',
'assert.ok(value, [message])',
'assert.equal(actual, expected, [message])',
'assert.notEqual(actual, expected, [message])',
'assert.strictEqual(actual, expected, [message])',
'assert.notStrictEqual(actual, expected, [message])',
'assert.deepEqual(actual, expected, [message])',
'assert.notDeepEqual(actual, expected, [message])'
]
}
});
```

Then, run mocha with `--require` option

$ mocha --require ./path/to/espower-traceur-loader spec/unit/some_test_using_powerassert.js

AUTHOR
---------------------------------------
* [Yosuke Furukawa](http://github.com/yosuke-furukawa)