Skip to content

Commit 41f5142

Browse files
committed
docs: update docs for release
1 parent 3247844 commit 41f5142

33 files changed

+3820
-924
lines changed

docs/Built-ins.html

Lines changed: 9 additions & 400 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Built-ins.md

Lines changed: 4 additions & 474 deletions
Large diffs are not rendered by default.

docs/Concatjs.html

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Concatjs.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ nav: rule
1010
Instead you must edit the .bzl file where the rules are declared,
1111
or possibly a markdown file next to the .bzl file
1212
********************* -->
13+
1314
# @bazel/concatjs
1415

1516
Concatjs is a JavaScript bundler, in a trivial sense: the UNIX `cat` command is a basic implementation:
@@ -33,10 +34,8 @@ So Bazel rules that originated in Google's codebase have affordances for concatj
3334
For example `ts_library` produces named AMD modules in its "devmode" output, and
3435
`karma_web_test` expects to bundle inputs using concatjs.
3536

36-
3737
## Compatibility
3838

39-
4039
### First-party code
4140

4241
First-party code has to be authored as named AMD/UMD modules.
@@ -59,7 +58,6 @@ using the TS triple-slash syntax:
5958
it is [also compiled with](https://github.com/bazelbuild/rules_nodejs/blob/bd53eb524ea3bd56b46b7a5f2eff700443e281ec/packages/concatjs/BUILD.bazel#L28)
6059
the `"compilerOptions": { "module": "umd" }` TypeScript setting.
6160

62-
6361
### Third-party code
6462

6563
To make it easier to produce a UMD version of a third-party npm package, we automatically generate a target that uses Browserify to build one, using the `main` entry from the package's `package.json`.
@@ -74,7 +72,6 @@ For example, even though RxJS ships with a UMD bundle, it contains multiple entr
7472

7573
Ultimately by using concatjs, you're signing up for at least a superficial understanding of these shims and may need to update them when you change your dependencies.
7674

77-
7875
## Serving JS in development mode under Bazel
7976

8077
There are two choices for development mode:
@@ -131,7 +128,6 @@ finishes.
131128

132129
[ibazel]: https://github.com/bazelbuild/bazel-watcher
133130

134-
135131
## Testing with Karma
136132

137133
The `karma_web_test` rule runs karma tests with Bazel.
@@ -160,7 +156,6 @@ browser_repositories(
160156
)
161157
```
162158

163-
164159
## Installing with user-managed dependencies
165160

166161
If you didn't use the `yarn_install` or `npm_install` rule to create an `npm` workspace, you'll have to declare a rule in your root `BUILD.bazel` file to execute karma:
@@ -274,7 +269,6 @@ Defaults to `"/_/ts_scripts.js"`
274269
Defaults to `[]`
275270

276271

277-
278272
## karma_web_test
279273

280274
**USAGE**
@@ -392,7 +386,6 @@ Passed through to `karma_web_test`
392386

393387

394388

395-
396389
## karma_web_test_suite
397390

398391
**USAGE**

docs/Cypress.html

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Cypress.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ nav: rule
1010
Instead you must edit the .bzl file where the rules are declared,
1111
or possibly a markdown file next to the .bzl file
1212
********************* -->
13+
1314
# Cypress rules for Bazel
1415

1516
The Cypress rules run tests under the Cypress e2e testing framework with Bazel.
1617

17-
1818
## Installation
1919

2020
Add `@bazel/cypress` and `cypress` npm packages to your `devDependencies` in `package.json`.
@@ -38,19 +38,16 @@ load("@npm//@bazel/cypress:index.bzl", "cypress_repository")
3838
cypress_repository(name = "cypress")
3939
```
4040

41-
4241
### macOS install requirements
4342
On macOS, `cypress_repository` generates an external repository containing files whose names contain spaces. In order to make these files compatible with bazel you will need to add the following flag to your `.bazelrc` file:
4443
```python
4544
# Required for cypress_repository on macOS
4645
build --experimental_inprocess_symlink_creation
4746
```
4847

49-
5048
### windows install requirements
5149
At this point in time, `cypress_repository` is incompatible with bazel sandboxing on Windows. This may change in the future, but for now using cypress on windows requires windows sandboxing be disabled (it is disabled by default)
5250

53-
5451
## Example use of cypress_web_test
5552
This example assumes you've named your external repository for node_modules as `npm` and for cypress as `cypress`
5653
```python

docs/Jasmine.html

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Jasmine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ nav: rule
1010
Instead you must edit the .bzl file where the rules are declared,
1111
or possibly a markdown file next to the .bzl file
1212
********************* -->
13+
1314
# Jasmine rules for Bazel
1415

1516
The Jasmine rules run tests under the Jasmine framework with Bazel.
1617

17-
1818
## Installation
1919

2020
Add the `@bazel/jasmine` npm package to your `devDependencies` in `package.json`.

docs/Labs.html

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Labs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ nav: rule
1010
Instead you must edit the .bzl file where the rules are declared,
1111
or possibly a markdown file next to the .bzl file
1212
********************* -->
13+
1314
# Bazel nodejs Labs
1415

1516
This package contains experimental code which isn't at the same quality or stability standard as our main packages.

0 commit comments

Comments
 (0)