Skip to content

Commit

Permalink
gh-5: guides/setup section
Browse files Browse the repository at this point in the history
  • Loading branch information
silkentrance committed Mar 31, 2019
1 parent 4a837b6 commit 219b612
Showing 1 changed file with 70 additions and 13 deletions.
83 changes: 70 additions & 13 deletions pages/guide/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ With some limitations, you can always change the test framework later on. (limit
### Mocha

{% highlight shell %}
npm install @testdeck/mocha mocha @types/mocha
npm install --save-dev @testdeck/mocha mocha @types/mocha
{% endhighlight %}

Alternatively, you can clone the existing <a href="https://github.com/testdeck/testdeck-mocha-seed">mocha-seed</a> and start from there.

### Jasmine

{% highlight bash %}
npm install @testdeck/jasmine jasmine @types/jasmine
npm install --save-dev @testdeck/jasmine jasmine @types/jasmine
{% endhighlight %}

Alternatively, you can clone the existing <a href="https://github.com/testdeck/testdeck-jasmine-seed">jasmine-seed</a> and start from there.

### Jest

{% highlight bash %}
npm install @testdeck/jest jest @types/jest
npm install --save-dev @testdeck/jest jest @types/jest
{% endhighlight %}

Alternatively, you can clone the existing <a href="https://github.com/testdeck/testdeck-jest-seed">jest-seed</a> and start from there.
Expand All @@ -63,17 +63,34 @@ npm install --save-dev chai @types/chai
#### Example Code

{% highlight TypeScript linenos %}
import { suite, test } from '@testdeck/mocha';
import { suite, test } from '@testdeck/mocha'; // might as well use jasmine/jest here
import * as chai from 'chai';

// let's have chai should augmentations
chai.should();

@suite
class TestSuite {

@test
someTest() {
assertTest() {

chai.assert.isOk(false);
}

@test
expectTest() {

chai.expect(false).to.be.true;
}

@test
shouldTest() {

const val = false;

val.should.be.true;
}
}
{% endhighlight %}

Expand All @@ -87,9 +104,10 @@ class TestSuite {
{% highlight TypeScript linenos %}
{% endhighlight %}


### NodeJS assert

A simple assertion framework that is included with the standard NodeJS library.
A simple, no fuss, assertion framework that is included with the standard NodeJS library.

#### Setup

Expand All @@ -98,7 +116,7 @@ This is part of the standard NodeJS library.
#### Example Code

{% highlight TypeScript linenos %}
import { suite, test } from '@testdeck/mocha';
import { suite, test } from '@testdeck/mocha'; // might as well use jasmine/jest here
import * as assert from 'assert';

@suite
Expand All @@ -115,18 +133,57 @@ class TestSuite {

### Jasmine built-in

For Jasmine, we recommend the built-in expectation framework.

#### Setup

This is an integral part of Jasmine.

#### Example Code

{% highlight TypeScript linenos %}
import { suite, test } from '@testdeck/jasmine';

@suite
class TestSuite {

@test
someTest() {

expect(false).to.be.true;
}
}
{% endhighlight %}


### Jest built-in

For Jest, we recommend the built-in expectation framework.

<dt>assert</dt>
#### Setup

<dt>Jasmine built-in</dt>
<dd>For Jasmine, we recommend the built-in expectation framework.</dd>
This is an integral part of Jest.

<dt>Jest built-in</dt>
<dd>For Jest, we recommend the built-in expectation framework.</dd>
</dl>
#### Example Code

{% highlight TypeScript linenos %}
import { suite, test } from '@testdeck/jest';

@suite
class TestSuite {

@test
someTest() {

expect(false).to.be.true;
}
}
{% endhighlight %}


### Our Recommendation

For you to be able to switch between test frameworks easily, we recommend that you use the expectation style alone.


## Mocking Frameworks
Expand Down

0 comments on commit 219b612

Please sign in to comment.