Skip to content

Commit

Permalink
docs: update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
gregmagolan committed Mar 3, 2020
1 parent 8abd20d commit d4c3d6a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/Jasmine.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ This causes the `@bazel/jasmine` package to be installed as a Bazel workspace na

Runs tests in NodeJS using the Jasmine test runner.

Detailed XML test results are found in the standard `bazel-testlogs`
directory. This may be symlinked in your workspace.
See https://docs.bazel.build/versions/master/output_directories.html

To debug the test, see debugging notes in `nodejs_test`.


Expand Down
22 changes: 21 additions & 1 deletion docs/Rollup.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,25 @@ This will produce one output per requested format.
### Usage

```
rollup_bundle(name, config_file, deps, entry_point, entry_points, format, node_context_data, output_dir, rollup_bin, sourcemap, srcs)
rollup_bundle(name, args, config_file, deps, entry_point, entry_points, format, node_context_data, output_dir, rollup_bin, silent, sourcemap, srcs)
```



#### `name`
(*[name], mandatory*): A unique name for this target.

#### `args`
(*List of strings*): Command line arguments to pass to rollup. Can be used to override config file settings.

These argument passed on the command line before all arguments that are always added by the
rule such as `--output.dir` or `--output.file`, `--format`, `--config` and `--preserveSymlinks` and
also those that are optionally added by the rule such as `--sourcemap`.

See rollup CLI docs https://rollupjs.org/guide/en/#command-line-flags for complete list of supported arguments.

Defaults to `[]`

#### `config_file`
(*[label]*): A rollup.config.js file

Expand Down Expand Up @@ -220,6 +231,15 @@ Defaults to `False`

Defaults to `@npm//rollup/bin:rollup`

#### `silent`
(*Boolean*): Whether to execute the rollup binary with the --silent flag, defaults to False.

Using --silent can cause rollup to [ignore errors/warnings](https://github.com/rollup/rollup/blob/master/docs/999-big-list-of-options.md#onwarn)
which are only surfaced via logging. Since bazel expects printing nothing on success, setting silent to True
is a more Bazel-idiomatic experience, however could cause rollup to drop important warnings.

Defaults to `False`

#### `sourcemap`
(*String*): Whether to produce sourcemaps.

Expand Down
2 changes: 1 addition & 1 deletion docs/TypeScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ Defaults to `//devserver:devserver`
(*[label]*): Go based devserver executable for the host platform.
Defaults to precompiled go binary in @npm_bazel_typescript setup by @bazel/typescript npm package

Defaults to `//devserver:devserver_linux_amd64`
Defaults to `//devserver:devserver_darwin_amd64`

#### `entry_module`
(*String*): The `entry_module` should be the AMD module name of the entry module such as `"__main__/src/index".`
Expand Down

0 comments on commit d4c3d6a

Please sign in to comment.