Update docs for release

bazelbuild · Oct 4, 2018 · 94f6faf · 94f6faf
1 parent 6561f95
commit 94f6faf
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -25,8 +25,8 @@ Optionally add the `@bazel/karma` npm package if you would like to use the
 {
   ...
   "devDependencies": {
-    "@bazel/typescript": "0.18.0",
-    "@bazel/karma": "0.18.0",
+    "@bazel/typescript": "0.20.0",
+    "@bazel/karma": "0.20.0",
     ...
   },
   ...
@@ -46,8 +46,8 @@ containing:
 ```python
 http_archive(
     name = "build_bazel_rules_typescript",
-    url = "https://github.com/bazelbuild/rules_typescript/archive/0.18.0.zip",
-    strip_prefix = "rules_typescript-0.18.0",
+    url = "https://github.com/bazelbuild/rules_typescript/archive/0.20.0.zip",
+    strip_prefix = "rules_typescript-0.20.0",
 )
 
 # Fetch our Bazel dependencies that aren't distributed on npm

diff --git a/docs/api/build_defs.html b/docs/api/build_defs.html
@@ -111,7 +111,7 @@ <h2>Macros</h2>
 
           <h2 id="tsc_wrapped_tsconfig">tsc_wrapped_tsconfig</h2>
 
-          <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>
+          <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>
 
           <p>Produce a tsconfig.json that sets options required under Bazel.</p>
 
@@ -159,13 +159,20 @@ <h3 id="tsc_wrapped_tsconfig_args">Attributes</h3>
 
       </td>
     </tr>
+    <tr id="tsc_wrapped_tsconfig.**kwargs">
+      <td><code>**kwargs</code></td>
+      <td>
+        <p><code>Unknown; Optional</code></p>
+
+      </td>
+    </tr>
   </tbody>
 </table>
           <hr>
 
           <h2 id="ts_library_macro">ts_library_macro</h2>
 
-          <pre>ts_library_macro(<a href="#ts_library_macro.tsconfig">tsconfig</a>)</pre>
+          <pre>ts_library_macro(<a href="#ts_library_macro.tsconfig">tsconfig</a>, <a href="#ts_library_macro.**kwargs">**kwargs</a>)</pre>
 
           <p>Wraps <code>ts_library</code> to set the default for the <code>tsconfig</code> attribute.</p>
 <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>
       <td><code>tsconfig</code></td>
       <td>
         <p><code>Unknown; Optional</code></p>
-        <p>the label pointing to a tsconfig.json file
-**kwargs: remaining args to pass to the ts_library rule</p>
+        <p>the label pointing to a tsconfig.json file</p>
+      </td>
+    </tr>
+    <tr id="ts_library_macro.**kwargs">
+      <td><code>**kwargs</code></td>
+      <td>
+        <p><code>Unknown; Optional</code></p>
+        <p>remaining args to pass to the ts_library rule</p>
       </td>
     </tr>
   </tbody>
@@ -239,7 +252,7 @@ <h3 id="ts_library_args">Attributes</h3>
         <p>Sets a different TypeScript compiler binary to use for this library.
             For example, we use the vanilla TypeScript tsc.js for bootstrapping,
             and Angular compilations can replace this with <code>ngc</code>.</p>
-<pre><code>        The default ts_library compiler depends on the `@npm//:@bazel/typescript`
+<pre><code>        The default ts_library compiler depends on the `@npm//@bazel/typescript`
         target which is setup for projects that use bazel managed npm deps that
         fetch the @bazel/typescript npm package. It is recommended that you use
         the workspace name `@npm` for bazel managed deps so the default
@@ -258,15 +271,15 @@ <h3 id="ts_library_args">Attributes</h3>
     <tr id="ts_library.node_modules">
       <td><code>node_modules</code></td>
       <td>
-        <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//:typescript__typings</code></p>
+        <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//typescript:typescript__typings</code></p>
         <p>The npm packages which should be available during the compile.</p>
-<pre><code>        The default value is `@npm//:typescript__typings` is setup
+<pre><code>        The default value is `@npm//typescript:typescript__typings` is setup
         for projects that use bazel managed npm deps that. It is recommended
         that you use the workspace name `@npm` for bazel managed deps so the
         default node_modules works out of the box. Otherwise, you'll have to
         override the node_modules attribute manually. This default is in place
         since ts_library will always depend on at least the typescript
-        default libs which are provided by `@npm//:typescript__typings`.
+        default libs which are provided by `@npm//typescript:typescript__typings`.
 
         This attribute is DEPRECATED. As of version 0.18.0 the recommended
         approach to npm dependencies is to use fine grained npm dependencies
@@ -292,10 +305,10 @@ <h3 id="ts_library_args">Attributes</h3>
           name = "my_lib",
           ...
           deps = [
-              "@npm//:@types/foo",
-              "@npm//:@types/bar",
-              "@npm//:foo",
-              "@npm//:bar",
+              "@npm//@types/foo",
+              "@npm//@types/bar",
+              "@npm//foo",
+              "@npm//bar",
               ...
           ],
         )

diff --git a/docs/api/devserver/ts_devserver.html b/docs/api/devserver/ts_devserver.html
@@ -110,7 +110,7 @@ <h2>Macros</h2>
 
           <h2 id="ts_devserver_macro">ts_devserver_macro</h2>
 
-          <pre>ts_devserver_macro(<a href="#ts_devserver_macro.tags">tags</a>)</pre>
+          <pre>ts_devserver_macro(<a href="#ts_devserver_macro.tags">tags</a>, <a href="#ts_devserver_macro.**kwargs">**kwargs</a>)</pre>
 
           <p>ibazel wrapper for <code>ts_devserver</code></p>
 <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>
       <td><code>tags</code></td>
       <td>
         <p><code>List of strings; Optional</code></p>
-        <p>standard Bazel tags, this macro adds a couple for ibazel
-**kwargs: passed through to <code>ts_devserver</code></p>
+        <p>standard Bazel tags, this macro adds a couple for ibazel</p>
+      </td>
+    </tr>
+    <tr id="ts_devserver_macro.**kwargs">
+      <td><code>**kwargs</code></td>
+      <td>
+        <p><code>Unknown; Optional</code></p>
+        <p>passed through to <code>ts_devserver</code></p>
       </td>
     </tr>
   </tbody>

diff --git a/docs/api/karma/ts_web_test.html b/docs/api/karma/ts_web_test.html
@@ -111,7 +111,7 @@ <h2>Macros</h2>
 
           <h2 id="ts_web_test_macro">ts_web_test_macro</h2>
 
-          <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>
+          <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>
 
           <p>ibazel wrapper for <code>ts_web_test</code></p>
 <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>
       <td><code>data</code></td>
       <td>
         <p><code>List of strings; Optional</code></p>
-        <p>runtime dependencies
-**kwargs: passed through to <code>ts_web_test</code></p>
+        <p>runtime dependencies</p>
+      </td>
+    </tr>
+    <tr id="ts_web_test_macro.**kwargs">
+      <td><code>**kwargs</code></td>
+      <td>
+        <p><code>Unknown; Optional</code></p>
+        <p>passed through to <code>ts_web_test</code></p>
       </td>
     </tr>
   </tbody>
@@ -156,7 +162,7 @@ <h3 id="ts_web_test_macro_args">Attributes</h3>
 
           <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.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>
+          <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>
 
           <p>Defines a test_suite of web_test targets that wrap a ts_web_test target.</p>
 
@@ -284,8 +290,14 @@ <h3 id="ts_web_test_suite_args">Attributes</h3>
       <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>
+        <p>A list of test tag strings to use for the wrapped test</p>
+      </td>
+    </tr>
+    <tr id="ts_web_test_suite.**remaining_keyword_args">
+      <td><code>**remaining_keyword_args</code></td>
+      <td>
+        <p><code>Unknown; Optional</code></p>
+        <p>Arguments for the wrapped test target.</p>
       </td>
     </tr>
   </tbody>
@@ -360,7 +372,7 @@ <h3 id="ts_web_test_args">Attributes</h3>
     <tr id="ts_web_test.karma">
       <td><code>karma</code></td>
       <td>
-        <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//:@bazel/karma/karma</code></p>
+        <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is @npm//@bazel/karma/bin:karma</code></p>
 
       </td>
     </tr>

diff --git a/package.bzl b/package.bzl
@@ -38,9 +38,8 @@ def rules_typescript_dependencies():
     _maybe(
         http_archive,
         name = "build_bazel_rules_nodejs",
-        # TODO: change to a release tag before next rules_typescript release
-        urls = ["https://github.com/bazelbuild/rules_nodejs/archive/3501f9b6a9a78a01fd1ef9b808f022bfcbb478a0.zip"],
-        strip_prefix = "rules_nodejs-3501f9b6a9a78a01fd1ef9b808f022bfcbb478a0",
+        urls = ["https://github.com/bazelbuild/rules_nodejs/archive/0.15.0.zip"],
+        strip_prefix = "rules_nodejs-0.15.0",
     )
 
     # ts_web_test depends on the web testing rules to provision browsers.