https://github.com/perguth/flip-tape
:microscope: Write eloquent tests: 'Tautology'.equals(true, true)
https://github.com/perguth/flip-tape
tape testing
Last synced: about 1 year ago
JSON representation
:microscope: Write eloquent tests: 'Tautology'.equals(true, true)
- Host: GitHub
- URL: https://github.com/perguth/flip-tape
- Owner: perguth
- License: mit
- Archived: true
- Created: 2016-12-10T05:46:56.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-06T02:12:28.000Z (over 8 years ago)
- Last Synced: 2024-11-13T10:41:06.109Z (over 1 year ago)
- Topics: tape, testing
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flip-tape
> Write eloquent tests: `'Tautology'.equals(true, true)`
More specific: **`flip-tape`** adds `'Two is less than three'.ok(2 < 3)` syntax to [tape](https://github.com/substack/tape) plus two further callback-executing methods. Original functionality is kept.
```bash
npm install flip-tape
```
## Usage
```js
var test = require('flip-tape')
test('Regular tape assertion group', t => {
t.plan(4)
t.ok(2 < 3, 'Regular tape syntax works as expected.')
// This is new:
'Two is less than three'.ok(2 < 3)
'Five equals five'.equals(5, 5)
'This string becomes a tape comment'.t(t => {
t.notOk(2 > 3, 'And both syntax types...')
'... still work'.notOk(2 > 3)
})
})
'You can also start a group of assertions this way...'.test(t => {
t.plan(1)
'... and everything works as expected!'.pass()
})
```
All of [tapes methods](https://github.com/substack/tape#methods) that print out `msg` to the command-line are usable with the flipped syntax.
## API
#### `var test = require('flip-tape')`
Attaches all tape-methods that print out to the command-line plus the `.t()` and `.test()` methods to the String prototype.
#### `'[message]'.test([opt], cb)`, `'[message]'.only([opt], cb)`
Calls the respective `tape` method: [`.test`](https://github.com/substack/tape#ttestname-opts-cb) or [`.only`](https://github.com/substack/tape#testonlyname-cb).
#### `'[message]'.t(cb)`
A [tape comment](https://github.com/substack/tape#tcommentmessage) containing the `message` is added. Then `cb(t)` gets called with the [test object t](https://github.com/substack/tape#tplann).
#### `'[message]'.tapeTestMethodName([actual, fn], [expected])`
Calls the according [tape method](https://github.com/substack/tape#methods) relaying the message string and the optional parameters.
## License
MIT