Skip to content

Commit

Permalink
bumped to 1.0.11
Browse files Browse the repository at this point in the history
  • Loading branch information
sc0ttj committed Mar 10, 2020
1 parent b05564c commit b4ee1b5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ The following assertions are built into `tea`:
- `assert`
- `expect`
- `should` (alias of expect)
- `t`

#### Using `expect`

Expand Down Expand Up @@ -223,7 +224,7 @@ test("test using assert, object syntax", () => {
run()
```

### Using `t`
#### Using `t`

Usage:

Expand Down Expand Up @@ -286,6 +287,18 @@ Options:
```

### TAP output

To show test results in [TAP](https://testanything.org/tap-version-13-specification.html) format, use `--format=tap` on the command-line (or `tea.reportFormat = 'tap'` if in the browser/DevTools).

The TAP format is machine-readable, and you can pipe the results to other programs, to prettify it.

These TAP prettifiers work OK with the TAP output of `tea`:

- [tap-difflet](https://github.com/namuol/tap-difflet)
- [tap-diff](https://github.com/axross/tap-diff)
- [tap-nyan](https://github.com/calvinmetcalf/tap-nyan)

### BDD style tests

Tests can be grouped arbitrarily, using the `group` function. Example:
Expand Down Expand Up @@ -361,18 +374,6 @@ The test results output will be indented appropriately, like so:
<img src="https://i.imgur.com/bfHl4tO.png" alt="grouped and indented test results" />
</p>

## TAP output

If you need your test results printed in [TAP](https://testanything.org/tap-version-13-specification.html) format, then use `--format=tap` or `tea.reportFormat = 'tap'`.

The TAP format is machine-readable, and you can pipe the results to other programs, to process or prettify it.

Here are some TAP prettifiers that work OK with the TAP output of `tea`:

- [tap-difflet])(https://github.com/namuol/tap-difflet) - prettifier for TAP formatted test results, works with `tea`
- [tap-diff])(https://github.com/axross/tap-diff) - prettifier for TAP formatted test results, works with `tea`
- [tap-nyan])(https://github.com/calvinmetcalf/tap-nyan) - prettifier for TAP formatted test results, works with `tea`

## Integration tests

### Running in a real browser
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@scottjarvis/tea",
"version": "1.0.10",
"version": "1.0.11",
"description": "Test Environment Application",
"author": "sc0ttj",
"license": "MIT",
Expand Down

0 comments on commit b4ee1b5

Please sign in to comment.