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

Commit 94f6faf

Browse files
committed
Update docs for release
1 parent 6561f95 commit 94f6faf

File tree

5 files changed

+59
-29
lines changed

5 files changed

+59
-29
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Optionally add the `@bazel/karma` npm package if you would like to use the
2525
{
2626
...
2727
"devDependencies": {
28-
"@bazel/typescript": "0.18.0",
29-
"@bazel/karma": "0.18.0",
28+
"@bazel/typescript": "0.20.0",
29+
"@bazel/karma": "0.20.0",
3030
...
3131
},
3232
...
@@ -46,8 +46,8 @@ containing:
4646
```python
4747
http_archive(
4848
name = "build_bazel_rules_typescript",
49-
url = "https://github.com/bazelbuild/rules_typescript/archive/0.18.0.zip",
50-
strip_prefix = "rules_typescript-0.18.0",
49+
url = "https://github.com/bazelbuild/rules_typescript/archive/0.20.0.zip",
50+
strip_prefix = "rules_typescript-0.20.0",
5151
)
5252

5353
# Fetch our Bazel dependencies that aren't distributed on npm

docs/api/build_defs.html

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h2>Macros</h2>
111111

112112
<h2 id="tsc_wrapped_tsconfig">tsc_wrapped_tsconfig</h2>
113113

114-
<pre>tsc_wrapped_tsconfig(<a href="#tsc_wrapped_tsconfig.ctx">ctx</a>, <a href="#tsc_wrapped_tsconfig.files">files</a>, <a href="#tsc_wrapped_tsconfig.srcs">srcs</a>, <a href="#tsc_wrapped_tsconfig.devmode_manifest">devmode_manifest</a>, <a href="#tsc_wrapped_tsconfig.jsx_factory">jsx_factory</a>)</pre>
114+
<pre>tsc_wrapped_tsconfig(<a href="#tsc_wrapped_tsconfig.ctx">ctx</a>, <a href="#tsc_wrapped_tsconfig.files">files</a>, <a href="#tsc_wrapped_tsconfig.srcs">srcs</a>, <a href="#tsc_wrapped_tsconfig.devmode_manifest">devmode_manifest</a>, <a href="#tsc_wrapped_tsconfig.jsx_factory">jsx_factory</a>, <a href="#tsc_wrapped_tsconfig.**kwargs">**kwargs</a>)</pre>
115115

116116
<p>Produce a tsconfig.json that sets options required under Bazel.</p>
117117

@@ -159,13 +159,20 @@ <h3 id="tsc_wrapped_tsconfig_args">Attributes</h3>
159159

160160
</td>
161161
</tr>
162+
<tr id="tsc_wrapped_tsconfig.**kwargs">
163+
<td><code>**kwargs</code></td>
164+
<td>
165+
<p><code>Unknown; Optional</code></p>
166+
167+
</td>
168+
</tr>
162169
</tbody>
163170
</table>
164171
<hr>
165172

166173
<h2 id="ts_library_macro">ts_library_macro</h2>
167174

168-
<pre>ts_library_macro(<a href="#ts_library_macro.tsconfig">tsconfig</a>)</pre>
175+
<pre>ts_library_macro(<a href="#ts_library_macro.tsconfig">tsconfig</a>, <a href="#ts_library_macro.**kwargs">**kwargs</a>)</pre>
169176

170177
<p>Wraps <code>ts_library</code> to set the default for the <code>tsconfig</code> attribute.</p>
171178
<p>This must be a macro so that the string is converted to a label in the context of the
@@ -186,8 +193,14 @@ <h3 id="ts_library_macro_args">Attributes</h3>
186193
<td><code>tsconfig</code></td>
187194
<td>
188195
<p><code>Unknown; Optional</code></p>
189-
<p>the label pointing to a tsconfig.json file
190-
**kwargs: remaining args to pass to the ts_library rule</p>
196+
<p>the label pointing to a tsconfig.json file</p>
197+
</td>
198+
</tr>
199+
<tr id="ts_library_macro.**kwargs">
200+
<td><code>**kwargs</code></td>
201+
<td>
202+
<p><code>Unknown; Optional</code></p>
203+
<p>remaining args to pass to the ts_library rule</p>
191204
</td>
192205
</tr>
193206
</tbody>
@@ -239,7 +252,7 @@ <h3 id="ts_library_args">Attributes</h3>
239252
<p>Sets a different TypeScript compiler binary to use for this library.
240253
For example, we use the vanilla TypeScript tsc.js for bootstrapping,
241254
and Angular compilations can replace this with <code>ngc</code>.</p>
242-
<pre><code> The default ts_library compiler depends on the `@npm//:@bazel/typescript`
255+
<pre><code> The default ts_library compiler depends on the `@npm//@bazel/typescript`
243256
target which is setup for projects that use bazel managed npm deps that
244257
fetch the @bazel/typescript npm package. It is recommended that you use
245258
the workspace name `@npm` for bazel managed deps so the default
@@ -258,15 +271,15 @@ <h3 id="ts_library_args">Attributes</h3>
258271
<tr id="ts_library.node_modules">
259272
<td><code>node_modules</code></td>
260273
<td>
261-
<p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//:typescript__typings</code></p>
274+
<p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//typescript:typescript__typings</code></p>
262275
<p>The npm packages which should be available during the compile.</p>
263-
<pre><code> The default value is `@npm//:typescript__typings` is setup
276+
<pre><code> The default value is `@npm//typescript:typescript__typings` is setup
264277
for projects that use bazel managed npm deps that. It is recommended
265278
that you use the workspace name `@npm` for bazel managed deps so the
266279
default node_modules works out of the box. Otherwise, you'll have to
267280
override the node_modules attribute manually. This default is in place
268281
since ts_library will always depend on at least the typescript
269-
default libs which are provided by `@npm//:typescript__typings`.
282+
default libs which are provided by `@npm//typescript:typescript__typings`.
270283

271284
This attribute is DEPRECATED. As of version 0.18.0 the recommended
272285
approach to npm dependencies is to use fine grained npm dependencies
@@ -292,10 +305,10 @@ <h3 id="ts_library_args">Attributes</h3>
292305
name = "my_lib",
293306
...
294307
deps = [
295-
"@npm//:@types/foo",
296-
"@npm//:@types/bar",
297-
"@npm//:foo",
298-
"@npm//:bar",
308+
"@npm//@types/foo",
309+
"@npm//@types/bar",
310+
"@npm//foo",
311+
"@npm//bar",
299312
...
300313
],
301314
)

docs/api/devserver/ts_devserver.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h2>Macros</h2>
110110

111111
<h2 id="ts_devserver_macro">ts_devserver_macro</h2>
112112

113-
<pre>ts_devserver_macro(<a href="#ts_devserver_macro.tags">tags</a>)</pre>
113+
<pre>ts_devserver_macro(<a href="#ts_devserver_macro.tags">tags</a>, <a href="#ts_devserver_macro.**kwargs">**kwargs</a>)</pre>
114114

115115
<p>ibazel wrapper for <code>ts_devserver</code></p>
116116
<p>This macro re-exposes the <code>ts_devserver</code> rule with some extra tags so that
@@ -131,8 +131,14 @@ <h3 id="ts_devserver_macro_args">Attributes</h3>
131131
<td><code>tags</code></td>
132132
<td>
133133
<p><code>List of strings; Optional</code></p>
134-
<p>standard Bazel tags, this macro adds a couple for ibazel
135-
**kwargs: passed through to <code>ts_devserver</code></p>
134+
<p>standard Bazel tags, this macro adds a couple for ibazel</p>
135+
</td>
136+
</tr>
137+
<tr id="ts_devserver_macro.**kwargs">
138+
<td><code>**kwargs</code></td>
139+
<td>
140+
<p><code>Unknown; Optional</code></p>
141+
<p>passed through to <code>ts_devserver</code></p>
136142
</td>
137143
</tr>
138144
</tbody>

docs/api/karma/ts_web_test.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h2>Macros</h2>
111111

112112
<h2 id="ts_web_test_macro">ts_web_test_macro</h2>
113113

114-
<pre>ts_web_test_macro(<a href="#ts_web_test_macro.karma">karma</a>, <a href="#ts_web_test_macro.tags">tags</a>, <a href="#ts_web_test_macro.data">data</a>)</pre>
114+
<pre>ts_web_test_macro(<a href="#ts_web_test_macro.karma">karma</a>, <a href="#ts_web_test_macro.tags">tags</a>, <a href="#ts_web_test_macro.data">data</a>, <a href="#ts_web_test_macro.**kwargs">**kwargs</a>)</pre>
115115

116116
<p>ibazel wrapper for <code>ts_web_test</code></p>
117117
<p>This macro re-exposes the <code>ts_web_test</code> rule with some extra tags so that
@@ -146,8 +146,14 @@ <h3 id="ts_web_test_macro_args">Attributes</h3>
146146
<td><code>data</code></td>
147147
<td>
148148
<p><code>List of strings; Optional</code></p>
149-
<p>runtime dependencies
150-
**kwargs: passed through to <code>ts_web_test</code></p>
149+
<p>runtime dependencies</p>
150+
</td>
151+
</tr>
152+
<tr id="ts_web_test_macro.**kwargs">
153+
<td><code>**kwargs</code></td>
154+
<td>
155+
<p><code>Unknown; Optional</code></p>
156+
<p>passed through to <code>ts_web_test</code></p>
151157
</td>
152158
</tr>
153159
</tbody>
@@ -156,7 +162,7 @@ <h3 id="ts_web_test_macro_args">Attributes</h3>
156162

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

159-
<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.karma">karma</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>
165+
<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.karma">karma</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>, <a href="#ts_web_test_suite.**remaining_keyword_args">**remaining_keyword_args</a>)</pre>
160166

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

@@ -284,8 +290,14 @@ <h3 id="ts_web_test_suite_args">Attributes</h3>
284290
<td><code>wrapped_test_tags</code></td>
285291
<td>
286292
<p><code>Unknown; Optional</code></p>
287-
<p>A list of test tag strings to use for the wrapped test
288-
**remaining_keyword_args: Arguments for the wrapped test target.</p>
293+
<p>A list of test tag strings to use for the wrapped test</p>
294+
</td>
295+
</tr>
296+
<tr id="ts_web_test_suite.**remaining_keyword_args">
297+
<td><code>**remaining_keyword_args</code></td>
298+
<td>
299+
<p><code>Unknown; Optional</code></p>
300+
<p>Arguments for the wrapped test target.</p>
289301
</td>
290302
</tr>
291303
</tbody>
@@ -360,7 +372,7 @@ <h3 id="ts_web_test_args">Attributes</h3>
360372
<tr id="ts_web_test.karma">
361373
<td><code>karma</code></td>
362374
<td>
363-
<p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//:@bazel/karma/karma</code></p>
375+
<p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//@bazel/karma/bin:karma</code></p>
364376

365377
</td>
366378
</tr>

package.bzl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@ def rules_typescript_dependencies():
3838
_maybe(
3939
http_archive,
4040
name = "build_bazel_rules_nodejs",
41-
# TODO: change to a release tag before next rules_typescript release
42-
urls = ["https://github.com/bazelbuild/rules_nodejs/archive/3501f9b6a9a78a01fd1ef9b808f022bfcbb478a0.zip"],
43-
strip_prefix = "rules_nodejs-3501f9b6a9a78a01fd1ef9b808f022bfcbb478a0",
41+
urls = ["https://github.com/bazelbuild/rules_nodejs/archive/0.15.0.zip"],
42+
strip_prefix = "rules_nodejs-0.15.0",
4443
)
4544

4645
# ts_web_test depends on the web testing rules to provision browsers.

0 commit comments

Comments
 (0)