Skip to content
This repository has been archived by the owner on Sep 16, 2021. It is now read-only.

Commit

Permalink
Move ts_web_test_suite docs to same page with ts_web_test
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexeagle
alexeagle committed May 10, 2018
1 parent e30cfe7 commit fdc8ca0
Show file tree
Hide file tree
Showing 7 changed files with 133 additions and 48 deletions.
5 changes: 0 additions & 5 deletions docs/api/build_defs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down
5 changes: 0 additions & 5 deletions docs/api/devserver/ts_devserver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down
19 changes: 1 addition & 18 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down Expand Up @@ -110,7 +105,6 @@ <h2>Rule sets</h2>
<li><a href="#ts_config">tsconfig.json files using extends</a></li>
<li><a href="#ts_devserver">Simple development server</a></li>
<li><a href="#ts_web_test">Unit testing in with Karma</a></li>
<li><a href="#ts_web_test_suite">Web Test rules for Typescript.</a></li>
<li><a href="#ts_proto_library">Protocol Buffers</a></li>
</ul>
</nav>
Expand Down Expand Up @@ -283,20 +277,9 @@ <h3>Macros</h3>

</td>
</tr>
</tbody>
</table>
<h2><a href="/api/karma/ts_web_test_suite.html" id="ts_web_test_suite">Web Test rules for Typescript.</a></h2>

<h3>Macros</h3>
<table class="overview-table">
<colgroup>
<col class="col-name" />
<col class="col-description" />
</colgroup>
<tbody>
<tr>
<td>
<a href="/api/karma/ts_web_test_suite.html#ts_web_test_suite">
<a href="/api/karma/ts_web_test.html#ts_web_test_suite">
<code>ts_web_test_suite</code>
</a>
</td>
Expand Down
137 changes: 132 additions & 5 deletions docs/api/karma/ts_web_test.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down Expand Up @@ -109,6 +104,7 @@ <h2>Rules</h2>
<h2>Macros</h2>
<ul>
<li><a href="#ts_web_test_macro">ts_web_test_macro</a></li>
<li><a href="#ts_web_test_suite">ts_web_test_suite</a></li>
</ul>
</nav>
<hr>
Expand Down Expand Up @@ -151,6 +147,137 @@ <h3 id="ts_web_test_macro_args">Attributes</h3>
</table>
<hr>

<h2 id="ts_web_test_suite">ts_web_test_suite</h2>

<pre>ts_web_test_suite(<a href="#ts_web_test_suite.name">name</a>, <a href="#ts_web_test_suite.browsers">browsers</a>, <a href="#ts_web_test_suite.args">args</a>, <a href="#ts_web_test_suite.browser_overrides">browser_overrides</a>, <a href="#ts_web_test_suite.config">config</a>, <a href="#ts_web_test_suite.flaky">flaky</a>, <a href="#ts_web_test_suite.local">local</a>, <a href="#ts_web_test_suite.shard_count">shard_count</a>, <a href="#ts_web_test_suite.size">size</a>, <a href="#ts_web_test_suite.tags">tags</a>, <a href="#ts_web_test_suite.test_suite_tags">test_suite_tags</a>, <a href="#ts_web_test_suite.timeout">timeout</a>, <a href="#ts_web_test_suite.visibility">visibility</a>, <a href="#ts_web_test_suite.web_test_data">web_test_data</a>, <a href="#ts_web_test_suite.wrapped_test_tags">wrapped_test_tags</a>)</pre>

<p>Defines a test_suite of web_test targets that wrap a ts_web_test target.</p>


<h3 id="ts_web_test_suite_args">Attributes</h3>

<table class="params-table">
<colgroup>
<col class="col-param" />
<col class="col-description" />
</colgroup>
<tbody>
<tr id="ts_web_test_suite.name">
<td><code>name</code></td>
<td>
<p><code><a href="https://bazel.build/docs/build-ref.html#name">Name</a>; Required</code></p>
<p>The base name of the test.</p>
</td>
</tr>
<tr id="ts_web_test_suite.browsers">
<td><code>browsers</code></td>
<td>
<p><code>List of strings; Optional</code></p>
<p>A sequence of labels specifying the browsers to use.</p>
</td>
</tr>
<tr id="ts_web_test_suite.args">
<td><code>args</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>Args for web_test targets generated by this extension.</p>
</td>
</tr>
<tr id="ts_web_test_suite.browser_overrides">
<td><code>browser_overrides</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>Dictionary; optional; default is an empty dictionary. A
dictionary mapping from browser names to browser-specific web_test
attributes, such as shard_count, flakiness, timeout, etc. For example:
{'//browsers:chrome-native': {'shard_count': 3, 'flaky': 1}
'//browsers:firefox-native': {'shard_count': 1, 'timeout': 100}}.</p>
</td>
</tr>
<tr id="ts_web_test_suite.config">
<td><code>config</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>Label; optional; Configuration of web test features.</p>
</td>
</tr>
<tr id="ts_web_test_suite.flaky">
<td><code>flaky</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>A boolean specifying that the test is flaky. If set, the test will
be retried up to 3 times (default: 0)</p>
</td>
</tr>
<tr id="ts_web_test_suite.local">
<td><code>local</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>boolean; optional.</p>
</td>
</tr>
<tr id="ts_web_test_suite.shard_count">
<td><code>shard_count</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>The number of test shards to use per browser. (default: 1)</p>
</td>
</tr>
<tr id="ts_web_test_suite.size">
<td><code>size</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>A string specifying the test size. (default: 'large')</p>
</td>
</tr>
<tr id="ts_web_test_suite.tags">
<td><code>tags</code></td>
<td>
<p><code>List of strings; Optional</code></p>
<p>A list of test tag strings to apply to each generated web_test target.
This macro adds a couple for ibazel.</p>
</td>
</tr>
<tr id="ts_web_test_suite.test_suite_tags">
<td><code>test_suite_tags</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>A list of tag strings for the generated test_suite.</p>
</td>
</tr>
<tr id="ts_web_test_suite.timeout">
<td><code>timeout</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>A string specifying the test timeout (default: computed from size)</p>
</td>
</tr>
<tr id="ts_web_test_suite.visibility">
<td><code>visibility</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>List of labels; optional.</p>
</td>
</tr>
<tr id="ts_web_test_suite.web_test_data">
<td><code>web_test_data</code></td>
<td>
<p><code>List of strings; Optional</code></p>
<p>Data dependencies for the web_test.</p>
</td>
</tr>
<tr id="ts_web_test_suite.wrapped_test_tags">
<td><code>wrapped_test_tags</code></td>
<td>
<p><code>Unknown; Optional</code></p>
<p>A list of test tag strings to use for the wrapped test
**remaining_keyword_args: Arguments for the wrapped test target.</p>
</td>
</tr>
</tbody>
</table>
<hr>

<h2 id="ts_web_test">ts_web_test</h2>

<pre>ts_web_test(<a href="#ts_web_test.name">name</a>, <a href="#ts_web_test.deps">deps</a>, <a href="#ts_web_test.data">data</a>, <a href="#ts_web_test.srcs">srcs</a>, <a href="#ts_web_test.bootstrap">bootstrap</a>)</pre>
Expand Down
5 changes: 0 additions & 5 deletions docs/api/protobufjs/ts_proto_library.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down
5 changes: 0 additions & 5 deletions docs/api/ts_config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down
5 changes: 0 additions & 5 deletions docs/api/ts_repositories.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
</li>
</ul>
</li>
<li>
<a href="/api/karma/ts_web_test_suite.html">Web Test rules for Typescript.</a>
<ul>
</ul>
</li>
<li>
<a href="/api/protobufjs/ts_proto_library.html">Protocol Buffers</a>
<ul>
Expand Down

0 comments on commit fdc8ca0

Please sign in to comment.