Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

conflict

TJ Holowaychukff4c09491f5d
diff --cc index.html
index da67e376,2eae1ec6..c9b0e4a9
--- a/index.html
+++ b/index.html
@@@ -18,8 -18,8 +18,9 @@@
<p id="tag"><em>simple</em>, <em>flexible</em>, <em>fun</em></p>
<p>Mocha is a feature-rich JavaScript test framework running on <a href="http://nodejs.org">node</a> and the browser, making asynchronous testing simple and fun. Mocha tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases. Hosted on <a href="http://github.com/visionmedia/mocha">GitHub</a>.</p>
- <h2>Features</h2>
+ <h2 id="features">Features</h2>
+
+
<ul>
<li>browser support</li>
<li>simple async support</li>
@@@ -51,17 -51,16 +52,19 @@@
<li>and more!</li>
</ul>
+
- <h2>Installation</h2>
+ <h2 id="installation">Installation</h2>
+
-<p>Install with <a href="http://npmjs.org">npm</a>:</p>
+
+<p> Install with <a href="http://npmjs.org">npm</a>:</p>
<pre><code>$ npm install -g mocha
</code></pre>
- <h2>Assertions</h2>
+ <h2 id="assertions">Assertions</h2>
+
-<p>Mocha allows you to use any assertion library you want, if it throws an error, it will work! This means you can utilize libraries such as <a href="http://github.com/visionmedia/should.js">should.js</a>, node's regular <code>assert</code> module, or others. The following is a list of known assertion libraries for node and/or the browser:</p>
+
+<p>Mocha allows you to use any assertion library you want, if it throws an error, it will work! This means you can utilize libraries such as <a href="http://github.com/visionmedia/should.js">should.js</a>, node&rsquo;s regular <code>assert</code> module, or others. The following is a list of known assertion libraries for node and/or the browser:</p>
<ul>
<li><a href="http://github.com/visionmedia/should.js">should.js</a> BDD style shown throughout these docs</li>
@@@ -69,10 -68,9 +72,11 @@@
<li><a href="http://chaijs.com/">chai</a> expect(), assert() and should style assertions</li>
</ul>
+
- <h2>Synchronous code</h2>
+ <h2 id="synchronous-code">Synchronous code</h2>
+
-<p>When testing synchronous code, omit the callback and Mocha will automatically continue on to the next test.</p>
+
+<p> When testing synchronous code, omit the callback and Mocha will automatically continue on to the next test.</p>
<pre><code>describe('Array', function(){
describe('#indexOf()', function(){
@@@ -84,8 -82,8 +88,9 @@@
})
</code></pre>
- <h2>Asynchronous code</h2>
+ <h2 id="asynchronous-code">Asynchronous code</h2>
+
+
<p>Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete:</p>
<pre><code>describe('User', function(){
@@@ -140,9 -138,9 +145,10 @@@
})
</code></pre>
- <h2>Pending tests</h2>
+ <h2 id="pending-tests">Pending tests</h2>
+
-<p>Pending test-cases are simply those without a callback:</p>
+
+<p> Pending test-cases are simply those without a callback:</p>
<pre><code>describe('Array', function(){
describe('#indexOf()', function(){
@@@ -151,25 -149,25 +157,28 @@@
})
</code></pre>
- <h2>Test duration</h2>
+ <h2 id="test-duration">Test duration</h2>
+
-<p>Most of the reporters support some form of displaying
+
+<p> Most of the reporters support some form of displaying
test duration, as well as flagging tests that are slow,
- as shown here with the "spec" reporter:</p>
+ as shown here with the &ldquo;spec&rdquo; reporter:</p>
-<p><img src="images/reporter-spec-duration.png" alt="test duration" title="" /></p>
+<p> <img src="images/reporter-spec-duration.png" alt="test duration" /></p>
- <h2>String diffs</h2>
+ <h2 id="string diffs">String diffs</h2>
+
-<p>Mocha supports the <code>err.expected</code>, and <code>err.actual</code> properties
+
+<p> Mocha supports the <code>err.expected</code>, and <code>err.actual</code> properties
when available to present expectations to the developer. Currently
Mocha provides string diffs, however in the future object diffs and
others may be provided.</p>
-<p><img src="http://f.cl.ly/items/3L0T1A0h2N1J3G021i0F/Screen%20Shot%202012-03-01%20at%202.31.31%20PM.png" alt="string diffs" title="" /></p>
+<p> <img src="http://f.cl.ly/items/3L0T1A0h2N1J3G021i0F/Screen%20Shot%202012-03-01%20at%202.31.31%20PM.png" alt="string diffs" /></p>
- <h2>mocha(1)</h2>
+ <h2 id="usage">mocha(1)</h2>
+
+
<pre><code> Usage: mocha [debug] [options] [files]
Options:
@@@ -196,57 -194,57 +205,69 @@@
--compilers &lt;ext&gt;:&lt;module&gt;,... use the given module(s) to compile files
</code></pre>
- <h3>-w, &ndash;watch</h3>
+ <h3 id="watch-option">-w, --watch</h3>
+
-<p>Executes tests on changes to JavaScript in the CWD, and once initially.</p>
+
+<p> Executes tests on changes to JavaScript in the CWD, and once initially.</p>
- <h3>&ndash;compilers</h3>
+ <h3 id="compilers-option">--compilers</h3>
+
-<p>coffee-script is no longer supported out of the box. CS and similar transpilers
- may be used by mapping the file extensions (for use with --watch) and the module
+
+<p> coffee-script is no longer supported out of the box. CS and similar transpilers
+ may be used by mapping the file extensions (for use with &ndash;watch) and the module
name. For example <code>--compilers coffee:coffee-script</code>.</p>
- <h3>-b, &ndash;bail</h3>
+ <h3 id="bail-option">-b, --bail</h3>
+
-<p>Only interested in the first exception? use <code>--bail</code> !</p>
+
+<p> Only interested in the first exception? use <code>--bail</code> !</p>
- <h3>-d, &ndash;debug</h3>
+ <h3 id="debug-option">-d, --debug</h3>
+
-<p>Enables node's debugger support, this executes your script(s) with <code>node debug &lt;file ...&gt;</code> allowing you to step through code and break with the <strong>debugger</strong> statement.</p>
+
+<p> Enables node&rsquo;s debugger support, this executes your script(s) with <code>node debug &lt;file ...&gt;</code> allowing you to step through code and break with the <strong>debugger</strong> statement.</p>
- <h3>&ndash;globals &lt;names&gt;</h3>
+ <h3 id="globals-option">--globals &lt;names&gt;</h3>
+
-<p>Accepts a comma-delimited list of accepted global variable names. For example suppose your app deliberately exposes a global named <code>app</code> and <code>YUI</code>, you may want to add <code>--globals app,YUI</code>.</p>
+
+<p> Accepts a comma-delimited list of accepted global variable names. For example suppose your app deliberately exposes a global named <code>app</code> and <code>YUI</code>, you may want to add <code>--globals app,YUI</code>.</p>
- <h3>&ndash;ignore-leaks</h3>
+ <h3 id="ignore-leaks-option">--ignore-leaks</h3>
+
-<p>By default Mocha will fail when global variables are introduced, you may use <code>--globals</code> to specify a few, or use <code>--ignore-leaks</code> to disable this functionality. </p>
+
+<p> By default Mocha will fail when global variables are introduced, you may use <code>--globals</code> to specify a few, or use <code>--ignore-leaks</code> to disable this functionality.</p>
- <h3>-r, &ndash;require &lt;name&gt;</h3>
+ <h3 id="require-option">-r, --require &lt;name&gt;</h3>
+
-<p>The <code>--require</code> option is useful for libraries such as <a href="http://github.com/visionmedia/should.js">should.js</a>, so you may simply <code>--require should</code> instead of manually invoking <code>require('should')</code> within each test file. Note that this works well for <code>should</code> as it augments <code>Object.prototype</code>, however if you wish to access a module's exports you will have to require them, for example <code>var should = require('should')</code>.</p>
+
+<p> The <code>--require</code> option is useful for libraries such as <a href="http://github.com/visionmedia/should.js">should.js</a>, so you may simply <code>--require should</code> instead of manually invoking <code>require('should')</code> within each test file. Note that this works well for <code>should</code> as it augments <code>Object.prototype</code>, however if you wish to access a module&rsquo;s exports you will have to require them, for example <code>var should = require('should')</code>.</p>
- <h3>-u, &ndash;ui &lt;name&gt;</h3>
+ <h3 id="ui-option">-u, --ui &lt;name&gt;</h3>
+
-<p>The <code>--ui</code> option lets you specify the interface to use, defaulting to "bdd".</p>
+
+<p> The <code>--ui</code> option lets you specify the interface to use, defaulting to &ldquo;bdd&rdquo;.</p>
- <h3>-R, &ndash;reporter &lt;name&gt;</h3>
+ <h3 id="reporter-option">-R, --reporter &lt;name&gt;</h3>
+
-<p>The <code>--reporter</code> option allows you to specify the reporter that will be used, defaulting to "dot".</p>
+
+<p> The <code>--reporter</code> option allows you to specify the reporter that will be used, defaulting to &ldquo;dot&rdquo;.</p>
- <h3>-t, &ndash;timeout &lt;ms&gt;</h3>
+ <h3 id="timeout-option">-t, --timeout &lt;ms&gt;</h3>
+
-<p>Specifies the test-case timeout, defaulting to 2 seconds. To override you may pass the timeout in milliseconds, or a value with the <code>s</code> suffix, ex: <code>--timeout 2s</code> or <code>--timeout 2000</code> would be equivalent.</p>
+
+<p> Specifies the test-case timeout, defaulting to 2 seconds. To override you may pass the timeout in milliseconds, or a value with the <code>s</code> suffix, ex: <code>--timeout 2s</code> or <code>--timeout 2000</code> would be equivalent.</p>
- <h3>-s, &ndash;slow &lt;ms&gt;</h3>
+ <h3 id="slow-option">-s, --slow &lt;ms&gt;</h3>
+
-<p>Specify the "slow" test threshold, defaulting to 75ms. Mocha uses this to highlight test-cases that are taking too long.</p>
+
+<p> Specify the &ldquo;slow&rdquo; test threshold, defaulting to 75ms. Mocha uses this to highlight test-cases that are taking too long.</p>
- <h3>-g, &ndash;grep &lt;pattern&gt;</h3>
+ <h3 id="grep-option">-g, --grep &lt;pattern&gt;</h3>
+
-<p>The <code>--grep</code> option when specified will trigger mocha to only run tests matching the given <code>pattern</code> which is internally compiled to a <code>RegExp</code>. </p>
-<p>Suppose for example you have "api" related tests, as well as "app" related tests, as shown in the following snippet; One could use <code>--grep api</code> or <code>--grep app</code> to run one or the other. The same goes for any other part of a suite or test-case title, <code>--grep users</code> would be valid as well, or even <code>--grep GET</code>.</p>
+<p> The <code>--grep</code> option when specified will trigger mocha to only run tests matching the given <code>pattern</code> which is internally compiled to a <code>RegExp</code>.</p>
+
+<p> Suppose for example you have &ldquo;api&rdquo; related tests, as well as &ldquo;app&rdquo; related tests, as shown in the following snippet; One could use <code>--grep api</code> or <code>--grep app</code> to run one or the other. The same goes for any other part of a suite or test-case title, <code>--grep users</code> would be valid as well, or even <code>--grep GET</code>.</p>
<pre><code>describe('api', function(){
describe('GET /api/users', function(){
@@@ -261,13 -259,13 +282,15 @@@ describe('app', function()
})
</code></pre>
- <h2>Interfaces</h2>
+ <h2 id="interfaces">Interfaces</h2>
+
-<p>Mocha "interface" system allows developers to choose their style of DSL. Shipping with <strong>BDD</strong>, <strong>TDD</strong>, and <strong>exports</strong> flavoured interfaces.</p>
+
+<p> Mocha &ldquo;interface&rdquo; system allows developers to choose their style of DSL. Shipping with <strong>BDD</strong>, <strong>TDD</strong>, and <strong>exports</strong> flavoured interfaces.</p>
- <h3>BDD</h3>
+ <h3 id="bdd-interface">BDD</h3>
+
-<p>The "<strong>BDD</strong>" interface provides <code>describe()</code>, <code>it()</code>, <code>before()</code>, <code>after()</code>, <code>beforeEach()</code>, and <code>afterEach()</code>: </p>
+
+<p> The &ldquo;<strong>BDD</strong>&rdquo; interface provides <code>describe()</code>, <code>it()</code>, <code>before()</code>, <code>after()</code>, <code>beforeEach()</code>, and <code>afterEach()</code>:</p>
<pre><code>describe('Array', function(){
before(function(){
@@@ -282,9 -280,9 +305,10 @@@
});
</code></pre>
- <h3>TDD</h3>
+ <h3 id="tdd-interface">TDD</h3>
+
-<p>The "<strong>TDD</strong>" interface provides <code>suite()</code>, <code>test()</code>, <code>setup()</code>, and <code>teardown()</code>.</p>
+
+<p> The &ldquo;<strong>TDD</strong>&rdquo; interface provides <code>suite()</code>, <code>test()</code>, <code>setup()</code>, and <code>teardown()</code>.</p>
<pre><code>suite('Array', function(){
setup(function(){
@@@ -299,9 -297,9 +323,10 @@@
});
</code></pre>
- <h3>Exports</h3>
+ <h3 id="exports-interface">Exports</h3>
+
-<p>The "<strong>exports</strong>" interface is much like Mocha's predecessor <a href="http://github.com/visionmedia/expresso">expresso</a>. The keys <code>before</code>, <code>after</code>, <code>beforeEach</code>, and <code>afterEach</code> are special-cased, object values
+
+<p> The &ldquo;<strong>exports</strong>&rdquo; interface is much like Mocha&rsquo;s predecessor <a href="http://github.com/visionmedia/expresso">expresso</a>. The keys <code>before</code>, <code>after</code>, <code>beforeEach</code>, and <code>afterEach</code> are special-cased, object values
are suites, and function values are test-cases.</p>
<pre><code>module.exports = {
@@@ -319,9 -317,9 +344,10 @@@
};
</code></pre>
- <h3>QUnit</h3>
+ <h3 id="qunit-interface">QUnit</h3>
+
-<p>The qunit-inspired interface matches the "flat" look of QUnit where the test suite title is simply defined before the test-cases.</p>
+
+<p> The qunit-inspired interface matches the &ldquo;flat&rdquo; look of QUnit where the test suite title is simply defined before the test-cases.</p>
<pre><code>function ok(expr, msg) {
if (!expr) throw new Error(msg);
@@@ -348,92 -346,92 +374,105 @@@ test('#length', function()
});
</code></pre>
- <h2>Reporters</h2>
+ <h2 id="reporters">Reporters</h2>
+
-<p>Mocha reporters adjust to the terminal window,
+
+<p> Mocha reporters adjust to the terminal window,
and always disable ansi-escape colouring when
the stdio streams are not associated with a tty.</p>
- <h3>Dot Matrix</h3>
+ <h3 id="dot-matrix-reporter">Dot Matrix</h3>
+
-<p>The "dot" matrix reporter is simply a series of dots
+
+<p> The &ldquo;dot&rdquo; matrix reporter is simply a series of dots
that represent test cases, failures highlight in red,
pending in blue, slow as yellow.</p>
-<p><img src="images/reporter-dot.png" alt="dot matrix reporter" title="" /></p>
+<p> <img src="images/reporter-dot.png" alt="dot matrix reporter" /></p>
- <h3>Spec</h3>
+ <h3 id="spec-reporter">Spec</h3>
+
-<p>The "spec" reporter outputs a hierarchical view
+
+<p> The &ldquo;spec&rdquo; reporter outputs a hierarchical view
nested just as the test cases are.</p>
-<p><img src="images/reporter-spec.png" alt="spec reporter" title="" />
- <img src="images/reporter-spec-fail.png" alt="spec reporter with failure" title="" /></p>
+<p> <img src="images/reporter-spec.png" alt="spec reporter" />
+ <img src="images/reporter-spec-fail.png" alt="spec reporter with failure" /></p>
- <h3>TAP</h3>
+ <h3 id="tap-reporter">TAP</h3>
+
-<p>The TAP reporter emits lines for a <a href="http://en.wikipedia.org/wiki/Test_Anything_Protocol">Test-Anything-Protocol</a> consumer.</p>
-<p><img src="images/reporter-tap.png" alt="test anything protocol" title="" /></p>
+<p> The TAP reporter emits lines for a <a href="http://en.wikipedia.org/wiki/Test_Anything_Protocol">Test-Anything-Protocol</a> consumer.</p>
+
+<p> <img src="images/reporter-tap.png" alt="test anything protocol" /></p>
- <h3>Landing Strip</h3>
+ <h3 id="landing-strip-reporter">Landing Strip</h3>
+
-<p>The Landing Strip reporter is a gimmicky test reporter simulating
+
+<p> The Landing Strip reporter is a gimmicky test reporter simulating
a plane landing :) unicode ftw</p>
-<p><img src="images/reporter-landing.png" alt="landing strip plane reporter" title="" />
- <img src="images/reporter-landing-fail.png" alt="landing strip with failure" title="" /></p>
+<p> <img src="images/reporter-landing.png" alt="landing strip plane reporter" />
+ <img src="images/reporter-landing-fail.png" alt="landing strip with failure" /></p>
- <h3>List</h3>
+ <h3 id="list-reporter">List</h3>
+
-<p>The "List" reporter outputs a simple specifications list as
- test cases pass or fail, outputting the failure details at
+
+<p> The &ldquo;List&rdquo; reporter outputs a simple specifications list as
+ test cases pass or fail, outputting the failure details at
the bottom of the output.</p>
-<p><img src="images/reporter-list.png" alt="list reporter" title="" /></p>
+<p> <img src="images/reporter-list.png" alt="list reporter" /></p>
- <h3>Progress</h3>
+ <h3 id="progress-reporter">Progress</h3>
+
-<p>The progress reporter implements a simple progress-bar:</p>
-<p><img src="images/reporter-progress.png" alt="progress bar" title="" /></p>
+<p> The progress reporter implements a simple progress-bar:</p>
+
+<p> <img src="images/reporter-progress.png" alt="progress bar" /></p>
- <h3>JSON</h3>
+ <h3 id="json-reporter">JSON</h3>
+
-<p>The JSON reporter outputs a single large JSON object when
+
+<p> The JSON reporter outputs a single large JSON object when
the tests have completed (failures or not).</p>
-<p><img src="images/reporter-json.png" alt="json reporter" title="" /></p>
+<p> <img src="images/reporter-json.png" alt="json reporter" /></p>
- <h3>JSON Stream</h3>
+ <h3 id="json-stream-reporter">JSON Stream</h3>
+
-<p>The JSON Stream reporter outputs newline-delimited JSON "events" as they occur, beginning with a "start" event, followed by test passes or failures, and then the final "end" event.</p>
-<p><img src="images/reporter-json-stream.png" alt="json stream reporter" title="" /></p>
+<p> The JSON Stream reporter outputs newline-delimited JSON &ldquo;events&rdquo; as they occur, beginning with a &ldquo;start&rdquo; event, followed by test passes or failures, and then the final &ldquo;end&rdquo; event.</p>
+
+<p> <img src="images/reporter-json-stream.png" alt="json stream reporter" /></p>
- <h3>JSONCov</h3>
+ <h3 id="jsoncov-reporter">JSONCov</h3>
+
-<p>The JSONCov reporter is similar to the JSON reporter, however when run against a library instrumented by <a href="https://github.com/visionmedia/node-jscoverage">node-jscoverage</a> it will produce coverage output.</p>
+
+<p> The JSONCov reporter is similar to the JSON reporter, however when run against a library instrumented by <a href="https://github.com/visionmedia/node-jscoverage">node-jscoverage</a> it will produce coverage output.</p>
- <h3>HTMLCov</h3>
+ <h3 id="htmlcov-reporter">HTMLCov</h3>
+
-<p>The HTMLCov reporter extends the JSONCov reporter. The library being tested should first be instrumented by <a href="https://github.com/visionmedia/node-jscoverage">node-jscoverage</a>, this allows Mocha to capture the coverage information necessary to produce a single-page HTML report.</p>
-<p>Click to view the current <a href="coverage.html">Express test coverage</a> report. For an integration example view the mcoha test coverage support <a href="https://github.com/visionmedia/express/commit/b6ee5fafd0d6c79cf7df5560cb324ebee4fe3a7f">commit</a> for Express.</p>
+<p> The HTMLCov reporter extends the JSONCov reporter. The library being tested should first be instrumented by <a href="https://github.com/visionmedia/node-jscoverage">node-jscoverage</a>, this allows Mocha to capture the coverage information necessary to produce a single-page HTML report.</p>
-<p><img src="http://f.cl.ly/items/3T3G1h1d3Z2i3M3Y1Y0Y/Screen%20Shot%202012-02-23%20at%208.37.13%20PM.png" alt="code coverage reporting" title="" /></p>
+<p> Click to view the current <a href="coverage.html">Express test coverage</a> report. For an integration example view the mcoha test coverage support <a href="https://github.com/visionmedia/express/commit/b6ee5fafd0d6c79cf7df5560cb324ebee4fe3a7f">commit</a> for Express.</p>
+
+<p> <img src="http://f.cl.ly/items/3T3G1h1d3Z2i3M3Y1Y0Y/Screen%20Shot%202012-02-23%20at%208.37.13%20PM.png" alt="code coverage reporting" /></p>
- <h3>Min</h3>
+ <h3 id="min-reporter">Min</h3>
+
-<p>The "min" reporter displays the summary only, while still outputting errors
+
+<p> The &ldquo;min&rdquo; reporter displays the summary only, while still outputting errors
on failure. This reporter works great with <code>--watch</code> as it clears the terminal
in order to keep your test summary at the top.</p>
-<p><img src="http://f.cl.ly/items/460B2r3p3M3k2D3J250m/Screen%20Shot%202012-03-24%20at%2010.46.01%20AM.png" alt="" title="" /></p>
+<p> <img src="http://f.cl.ly/items/460B2r3p3M3k2D3J250m/Screen%20Shot%202012-03-24%20at%2010.46.01%20AM.png" alt="" /></p>
- <h3>Doc</h3>
+ <h3 id="doc-reporter">Doc</h3>
+
-<p>The "doc" reporter outputs a hierarchical HTML body representation
+
+<p> The &ldquo;doc&rdquo; reporter outputs a hierarchical HTML body representation
of your tests, wrap it with a header, footer, some styling and you
have some fantastic documentation!</p>
@@@ -476,33 -474,33 +515,38 @@@
&gt; docs/test.html
</code></pre>
-<p>View the entire <a href="https://github.com/visionmedia/superagent/blob/master/Makefile">Makefile</a> for reference.</p>
+<p> View the entire <a href="https://github.com/visionmedia/superagent/blob/master/Makefile">Makefile</a> for reference.</p>
- <h3>XUnit</h3>
+ <h3 id="xunit-reporter">XUnit</h3>
+
-<p>Documentation needed.</p>
+
+<p> Documentation needed.</p>
- <h3>TeamCity</h3>
+ <h3 id="teamcity-reporter">TeamCity</h3>
+
-<p>Documentation needed.</p>
+
+<p> Documentation needed.</p>
- <h3>Markdown</h3>
+ <h3 id="markdown-reporter">Markdown</h3>
+
-<p>The "markdown" reporter generates a markdown TOC and body for your
+
+<p> The &ldquo;markdown&rdquo; reporter generates a markdown TOC and body for your
test suite. This is great if you want to use the tests as documentation
within a Github wiki page, or a markdown file in the repository that
Github can render. For example here is the Connect <a href="https://github.com/senchalabs/connect/blob/90a725343c2945aaee637e799b1cd11e065b2bff/tests.md">test output</a>.</p>
- <h3>HTML</h3>
+ <h3 id="html-reporter">HTML</h3>
+
-<p>The <strong>HTML</strong> reporter is currently the only browser reporter
+
+<p> The <strong>HTML</strong> reporter is currently the only browser reporter
supported by Mocha, and it looks like this:</p>
-<p><img src="images/reporter-html.png" alt="HTML test reporter" title="" /></p>
+<p> <img src="images/reporter-html.png" alt="HTML test reporter" /></p>
- <h2>Browser support</h2>
+ <h2 id="browser-support">Browser support</h2>
+
-<p>Mocha runs in the browser. Every release of Mocha will have new builds of <em>./mocha.js</em> and <em>./mocha.css</em> for use in the browser. To setup Mocha for browser use all you have to do is include the script, stylesheet, tell Mocha which interface you wish to use, and then run the tests. A typical setup might look something like the following, where we call <code>mocha.setup('bdd')</code> to use the <strong>BDD</strong> interface before loading the test scripts, running them <code>onload</code> with <code>mocha.run()</code>.</p>
+
+<p> Mocha runs in the browser. Every release of Mocha will have new builds of <em>./mocha.js</em> and <em>./mocha.css</em> for use in the browser. To setup Mocha for browser use all you have to do is include the script, stylesheet, tell Mocha which interface you wish to use, and then run the tests. A typical setup might look something like the following, where we call <code>mocha.setup('bdd')</code> to use the <strong>BDD</strong> interface before loading the test scripts, running them <code>onload</code> with <code>mocha.run()</code>.</p>
<pre><code>&lt;html&gt;
&lt;head&gt;
@@@ -530,13 -528,13 +574,15 @@@
&lt;/html&gt;
</code></pre>
- <h3>grep</h3>
+ <h3 id="grep-query">grep</h3>
+
-<p>The client-side may utilize <code>--grep</code> as well, however you use the query-string, for example <code>?grep=api</code>.</p>
+
+<p> The client-side may utilize <code>--grep</code> as well, however you use the query-string, for example <code>?grep=api</code>.</p>
- <h2>mocha.opts</h2>
+ <h2 id="mocha.opts">mocha.opts</h2>
+
-<p>Mocha will attempt to load <code>./test/mocha.opts</code>, these are concatenated with <code>process.argv</code>, though command-line args will take precedence. For example suppose you have the following <em>mocha.opts</em> file:</p>
+
+<p> Mocha will attempt to load <code>./test/mocha.opts</code>, these are concatenated with <code>process.argv</code>, though command-line args will take precedence. For example suppose you have the following <em>mocha.opts</em> file:</p>
<pre><code>--require should
--reporter dot
@@@ -551,9 -549,9 +597,10 @@@
<pre><code>$ mocha --reporter list --growl
</code></pre>
- <h2>Test specific timeouts</h2>
+ <h2 id="test-specific-timeouts">Test specific timeouts</h2>
+
-<p>To compliment the global <code>--timeout</code> option, you may also specific test-specific timeouts via <code>this.timeout()</code>, or disable the timeout all-together with <code>this.timeout(0)</code>.</p>
+
+<p> To compliment the global <code>--timeout</code> option, you may also specific test-specific timeouts via <code>this.timeout()</code>, or disable the timeout all-together with <code>this.timeout(0)</code>.</p>
<pre><code>it('should take less than 500ms', function(done){
this.timeout(500);
@@@ -561,16 -559,16 +608,21 @@@
})
</code></pre>
- <h2>Best practices</h2>
+ <h2 id="best-practices">Best practices</h2>
+
++
++
++
+ <h3 id="test-directory">test/*</h3>
- <h3>test/*</h3>
-<p>By default <code>mocha(1)</code> will use the pattern <code>./test/*.js</code>, so
- it's usually a good place to put your tests.</p>
+
+<p> By default <code>mocha(1)</code> will use the pattern <code>./test/*.js</code>, so
+ it&rsquo;s usually a good place to put your tests.</p>
- <h3>Makefiles</h3>
+ <h3 id="makefiles">Makefiles</h3>
+
-<p>Be kind and don't make developers hunt around in your docs to figure
+
+<p> Be kind and don&rsquo;t make developers hunt around in your docs to figure
out how to run the tests, add a <code>make test</code> target to your <em>Makefile</em>:</p>
<pre><code> test:
@@@ -580,36 -578,35 +632,40 @@@
.PHONY: test
</code></pre>
- <h2>Editors</h2>
+ <h2 id="editors">Editors</h2>
+
-<p>The following editor-related packages are available:</p>
+
+<p> The following editor-related packages are available:</p>
- <h3>TextMate bundle</h3>
+ <h3 id="textmate-bundle">TextMate bundle</h3>
+
-<p>The Mocha TextMate bundle includes snippets to
+
+<p> The Mocha TextMate bundle includes snippets to
make writing tests quicker and more enjoyable.
To install the bundle run:</p>
<pre><code> $ make tm
</code></pre>
- <h2>Example test suites</h2>
+ <h2 id="example-test-suites">Example test suites</h2>
+
-<p>The following test suites are from real projects putting Mocha to use,
+
+<p> The following test suites are from real projects putting Mocha to use,
so they serve as good examples:</p>
<ul>
-<li><a href="https://github.com/visionmedia/express/tree/master/test">Express</a></li>
-<li><a href="https://github.com/senchalabs/connect/tree/master/test">Connect</a></li>
-<li><a href="https://github.com/visionmedia/superagent/tree/master/test/node">SuperAgent</a></li>
-<li><a href="https://github.com/LearnBoost/websocket.io/tree/master/test">WebSocket.io</a></li>
-<li><a href="https://github.com/visionmedia/mocha/tree/master/test">Mocha</a></li>
+<li> <a href="https://github.com/visionmedia/express/tree/master/test">Express</a></li>
+<li> <a href="https://github.com/senchalabs/connect/tree/master/test">Connect</a></li>
+<li> <a href="https://github.com/visionmedia/superagent/tree/master/test/node">SuperAgent</a></li>
+<li> <a href="https://github.com/LearnBoost/websocket.io/tree/master/test">WebSocket.io</a></li>
+<li> <a href="https://github.com/visionmedia/mocha/tree/master/test">Mocha</a></li>
</ul>
+
- <h2>Running mocha&rsquo;s tests</h2>
+ <h2 id="running-mochas-tests">Running mocha's tests</h2>
+
-<p>Run the tests:</p>
+
+<p> Run the tests:</p>
<pre><code> $ make test
</code></pre>
@@@ -624,9 -621,9 +680,10 @@@
<pre><code> $ make test REPORTER=list
</code></pre>
- <h2>More information</h2>
+ <h2 id="more-information">More information</h2>
+
-<p>For additional information such as using spies, mocking, and shared behaviours be sure to check out the <a href="https://github.com/visionmedia/mocha/wiki">Mocha Wiki</a> on GitHub.</p>
+
+<p> For additional information such as using spies, mocking, and shared behaviours be sure to check out the <a href="https://github.com/visionmedia/mocha/wiki">Mocha Wiki</a> on GitHub. For discussions join the <a href="http://groups.google.com/group/mochajs">Google Group</a>.</p>
</section>
<footer>
<span>© 2011 TJ Holowaychuk. All rights reserved.</span>
diff --cc index.md
index 7c8de7ef,cae780dc..c70cece1
--- a/index.md
+++ b/index.md
@@@ -574,6 -574,6 +574,6 @@@ Testing asynchronous code with Mocha co
$ make test REPORTER=list
- ## More information
+ <h2 id="more-information">More information</h2>
- For additional information such as using spies, mocking, and shared behaviours be sure to check out the [Mocha Wiki](https://github.com/visionmedia/mocha/wiki) on GitHub. For discussions join the [Google Group](http://groups.google.com/group/mochajs).
- For additional information such as using spies, mocking, and shared behaviours be sure to check out the [Mocha Wiki](https://github.com/visionmedia/mocha/wiki) on GitHub.
++ For additional information such as using spies, mocking, and shared behaviours be sure to check out the [Mocha Wiki](https://github.com/visionmedia/mocha/wiki) on GitHub. For discussions join the [Google Group](http://groups.google.com/group/mochajs).