diff --git a/docs/swc.md b/docs/swc.md index c3d0bd5..4d816b8 100644 --- a/docs/swc.md +++ b/docs/swc.md @@ -11,12 +11,12 @@ swc(name = "transpile") ``` - + -## swc_rule +## swc_transpiler
-swc_rule(name, args, data, js_outs, map_outs, output_dir, srcs, swc_cli, swcrc)
+swc_transpiler(name, args, data, js_outs, map_outs, output_dir, srcs, swc_cli, swcrc)
 
Underlying rule for the `swc` macro. @@ -31,15 +31,15 @@ for example to set your own output labels for `js_outs`. | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| args | additional arguments to pass to swc cli, see https://swc.rs/docs/usage/cli | List of strings | optional | [] | -| data | runtime dependencies propagated to binaries that depend on this | List of labels | optional | [] | -| js_outs | list of expected JavaScript output files.

There must be one for each entry in srcs, and in the same order. | List of labels | optional | | -| map_outs | list of expected source map output files.

Can be empty, meaning no source maps should be produced. If non-empty, there must be one for each entry in srcs, and in the same order. | List of labels | optional | | -| output_dir | whether to produce a directory output rather than individual files | Boolean | optional | False | -| srcs | source files, typically .ts files in the source tree | List of labels | required | | -| swc_cli | binary that executes the swc CLI | Label | optional | @aspect_rules_swc//swc:cli | -| swcrc | label of a configuration file for swc, see https://swc.rs/docs/configuration/swcrc | Label | optional | None | +| name | A unique name for this target. | Name | required | | +| args | additional arguments to pass to swc cli, see https://swc.rs/docs/usage/cli | List of strings | optional | [] | +| data | runtime dependencies propagated to binaries that depend on this | List of labels | optional | [] | +| js_outs | list of expected JavaScript output files.

There must be one for each entry in srcs, and in the same order. | List of labels | optional | | +| map_outs | list of expected source map output files.

Can be empty, meaning no source maps should be produced. If non-empty, there must be one for each entry in srcs, and in the same order. | List of labels | optional | | +| output_dir | whether to produce a directory output rather than individual files | Boolean | optional | False | +| srcs | source files, typically .ts files in the source tree | List of labels | required | | +| swc_cli | binary that executes the swc CLI | Label | optional | @aspect_rules_swc//swc:cli | +| swcrc | label of a configuration file for swc, see https://swc.rs/docs/configuration/swcrc | Label | optional | None | diff --git a/examples/custom_outs/BUILD.bazel b/examples/custom_outs/BUILD.bazel index c3e4438..778dd1b 100644 --- a/examples/custom_outs/BUILD.bazel +++ b/examples/custom_outs/BUILD.bazel @@ -1,8 +1,8 @@ -load("@aspect_rules_swc//swc:swc.bzl", swc = "swc_rule") +load("@aspect_rules_swc//swc:swc.bzl", "swc_transpiler") load("@bazel_skylib//rules:diff_test.bzl", "diff_test") [ - swc( + swc_transpiler( name = "transpile_" + format, srcs = ["in.ts"], args = [ diff --git a/swc/swc.bzl b/swc/swc.bzl index 07c815b..0ee3eff 100644 --- a/swc/swc.bzl +++ b/swc/swc.bzl @@ -12,7 +12,7 @@ swc(name = "transpile") load("//swc/private:swc.bzl", _swc_lib = "swc") load("@bazel_skylib//lib:paths.bzl", "paths") -swc_rule = rule( +swc_transpiler = rule( doc = """Underlying rule for the `swc` macro. Most users should just use [swc](#swc) instead. @@ -79,7 +79,7 @@ def swc(name, srcs = None, args = [], data = [], output_dir = False, swcrc = Non if source_map_outputs: map_outs.append(paths.replace_extension(f, ".js.map")) - swc_rule( + swc_transpiler( name = name, srcs = srcs, js_outs = js_outs,