Skip to content

Commit

Permalink
docs(labs): produce stardoc API for labs
Browse files Browse the repository at this point in the history
Fixes #2195
  • Loading branch information
Alex Eagle authored and alexeagle committed Sep 23, 2020
1 parent 56b8f69 commit 2923766
Show file tree
Hide file tree
Showing 27 changed files with 827 additions and 23 deletions.
22 changes: 11 additions & 11 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,17 @@ load("@build_bazel_rules_typescript//:package.bzl", "rules_typescript_dev_depend

rules_typescript_dev_dependencies()

# Install labs dependencies
load("//packages/labs:package.bzl", "npm_bazel_labs_dependencies")

npm_bazel_labs_dependencies()

load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")

rules_proto_dependencies()

rules_proto_toolchains()

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

Expand Down Expand Up @@ -286,14 +297,3 @@ load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries

# Depend on the Bazel binaries
bazel_binaries(versions = SUPPORTED_BAZEL_VERSIONS)

# Install labs dependencies
load("//packages/labs:package.bzl", "npm_bazel_labs_dependencies")

npm_bazel_labs_dependencies()

load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")

rules_proto_dependencies()

rules_proto_toolchains()
1 change: 1 addition & 0 deletions docs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ rules_nodejs_docs(
"Cypress": "//packages/cypress:README.md",
"Jasmine": "//packages/jasmine:README.md",
"Karma": "//packages/karma:README.md",
"Labs": "//packages/labs:README.md",
"Protractor": "//packages/protractor:README.md",
"Rollup": "//packages/rollup:README.md",
"Terser": "//packages/terser:README.md",
Expand Down
43 changes: 41 additions & 2 deletions docs/Built-ins.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 37 additions & 2 deletions docs/Built-ins.md
Original file line number Diff line number Diff line change
Expand Up @@ -986,7 +986,7 @@ check if yarn is being run by the <code>npm_install</code> repository rule.

<pre>
npm_install(<a href="#npm_install-name">name</a>, <a href="#npm_install-args">args</a>, <a href="#npm_install-data">data</a>, <a href="#npm_install-environment">environment</a>, <a href="#npm_install-included_files">included_files</a>, <a href="#npm_install-manual_build_file_contents">manual_build_file_contents</a>, <a href="#npm_install-package_json">package_json</a>,
<a href="#npm_install-package_lock_json">package_lock_json</a>, <a href="#npm_install-quiet">quiet</a>, <a href="#npm_install-symlink_node_modules">symlink_node_modules</a>, <a href="#npm_install-timeout">timeout</a>)
<a href="#npm_install-package_lock_json">package_lock_json</a>, <a href="#npm_install-quiet">quiet</a>, <a href="#npm_install-strict_visibility">strict_visibility</a>, <a href="#npm_install-symlink_node_modules">symlink_node_modules</a>, <a href="#npm_install-timeout">timeout</a>)
</pre>

**ATTRIBUTES**
Expand Down Expand Up @@ -1131,6 +1131,23 @@ fine grained npm dependencies.
<td>
True
</td>
</tr>
<tr id="npm_install-strict_visibility">
<td>strict_visibility</td>
<td>
Turn on stricter visibility for generated BUILD.bazel files

When enabled, only dependencies within the given <code>package.json</code> file are given public visibility.
All transitive dependencies are given limited visibility, enforcing that all direct dependencies are
listed in the <code>package.json</code> file.

Currently the default is set <code>False</code>, but will likely be flipped <code>True</code> in rules_nodejs 3.0.0
</td>
<td>Boolean</td>
<td>optional</td>
<td>
False
</td>
</tr>
<tr id="npm_install-symlink_node_modules">
<td>symlink_node_modules</td>
Expand Down Expand Up @@ -1476,7 +1493,8 @@ check if yarn is being run by the <code>yarn_install</code> repository rule.

<pre>
yarn_install(<a href="#yarn_install-name">name</a>, <a href="#yarn_install-args">args</a>, <a href="#yarn_install-data">data</a>, <a href="#yarn_install-environment">environment</a>, <a href="#yarn_install-included_files">included_files</a>, <a href="#yarn_install-manual_build_file_contents">manual_build_file_contents</a>,
<a href="#yarn_install-package_json">package_json</a>, <a href="#yarn_install-quiet">quiet</a>, <a href="#yarn_install-symlink_node_modules">symlink_node_modules</a>, <a href="#yarn_install-timeout">timeout</a>, <a href="#yarn_install-use_global_yarn_cache">use_global_yarn_cache</a>, <a href="#yarn_install-yarn_lock">yarn_lock</a>)
<a href="#yarn_install-package_json">package_json</a>, <a href="#yarn_install-quiet">quiet</a>, <a href="#yarn_install-strict_visibility">strict_visibility</a>, <a href="#yarn_install-symlink_node_modules">symlink_node_modules</a>, <a href="#yarn_install-timeout">timeout</a>,
<a href="#yarn_install-use_global_yarn_cache">use_global_yarn_cache</a>, <a href="#yarn_install-yarn_lock">yarn_lock</a>)
</pre>

**ATTRIBUTES**
Expand Down Expand Up @@ -1611,6 +1629,23 @@ fine grained npm dependencies.
<td>
True
</td>
</tr>
<tr id="yarn_install-strict_visibility">
<td>strict_visibility</td>
<td>
Turn on stricter visibility for generated BUILD.bazel files

When enabled, only dependencies within the given <code>package.json</code> file are given public visibility.
All transitive dependencies are given limited visibility, enforcing that all direct dependencies are
listed in the <code>package.json</code> file.

Currently the default is set <code>False</code>, but will likely be flipped <code>True</code> in rules_nodejs 3.0.0
</td>
<td>Boolean</td>
<td>optional</td>
<td>
False
</td>
</tr>
<tr id="yarn_install-symlink_node_modules">
<td>symlink_node_modules</td>
Expand Down
4 changes: 4 additions & 0 deletions docs/Cypress.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions docs/Jasmine.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions docs/Karma.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions docs/Karma.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ environment must specify CHROME_BIN so that the rule will know which Chrome bina
Other <code>browsers</code> and <code>customLaunchers</code> may be set using the a base Karma configuration
specified in the <code>config_file</code> attribute.

By default we open a headless Chrome. To use a real Chrome browser window, you can pass
<code>--define DISPLAY=true</code> to Bazel, along with <code>configuration_env_vars = ["DISPLAY"]</code> on
<code>karma_web_test</code>.


<pre>
karma_web_test(<a href="#karma_web_test-srcs">srcs</a>, <a href="#karma_web_test-deps">deps</a>, <a href="#karma_web_test-data">data</a>, <a href="#karma_web_test-configuration_env_vars">configuration_env_vars</a>, <a href="#karma_web_test-bootstrap">bootstrap</a>, <a href="#karma_web_test-runtime_deps">runtime_deps</a>, <a href="#karma_web_test-static_files">static_files</a>,
Expand Down
Loading

0 comments on commit 2923766

Please sign in to comment.