chore: formatter

docs/swc.md

@@ -1,6 +1,15 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
-swc rule
+API for running SWC under Bazel
+
+Simplest usage:
+
+```starlark
+load("@aspect_rules_swc//swc:swc.bzl", "swc")
+
+swc(name = "transpile")
+```
+
 
 <a id="#swc_rule"></a>
 
@@ -12,8 +21,10 @@ swc_rule(<a href="#swc_rule-name">name</a>, <a href="#swc_rule-args">args</a>, <
 
 Underlying rule for the `swc` macro.
 
-    Use this if you need more control over how the rule is called,
-    for example to set your own output labels for `js_outs`.
+Most users should just use [swc](#swc) instead.
+
+Use this if you need more control over how the rule is called,
+for example to set your own output labels for `js_outs`.
 
 **ATTRIBUTES**
 
@@ -23,8 +34,8 @@ Underlying rule for the `swc` macro.
 | <a id="swc_rule-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 | <a id="swc_rule-args"></a>args |  additional arguments to pass to swc cli, see https://swc.rs/docs/usage/cli   | List of strings | optional | [] |
 | <a id="swc_rule-data"></a>data |  runtime dependencies propagated to binaries that depend on this   | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] |
-| <a id="swc_rule-js_outs"></a>js_outs |  -   | List of labels | optional |  |
-| <a id="swc_rule-map_outs"></a>map_outs |  -   | List of labels | optional |  |
+| <a id="swc_rule-js_outs"></a>js_outs |  list of expected JavaScript output files   | List of labels | optional |  |
+| <a id="swc_rule-map_outs"></a>map_outs |  list of expected source map output files   | List of labels | optional |  |
 | <a id="swc_rule-output_dir"></a>output_dir |  whether to produce a directory output rather than individual files   | Boolean | optional | False |
 | <a id="swc_rule-srcs"></a>srcs |  source files, typically .ts files in the source tree   | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | required |  |
 | <a id="swc_rule-swc_cli"></a>swc_cli |  binary that executes the swc CLI   | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | @aspect_rules_swc//swc:cli |

examples/rc/src/BUILD.bazel

@@ -21,4 +21,4 @@ diff_test(
     name = "test_map",
     file1 = "in.js.map",
     file2 = "expected.js.map",
-)
+)

examples/rc/src/in.ts

@@ -1 +1 @@
-export const a: string = 'foo'
+export const a: string = "foo";

swc/private/swc.bzl

@@ -17,8 +17,8 @@ _attrs = {
 }
 
 _outputs = {
-    "js_outs": attr.output_list(),
-    "map_outs": attr.output_list(),
+    "js_outs": attr.output_list(doc = "list of expected JavaScript output files"),
+    "map_outs": attr.output_list(doc = "list of expected source map output files"),
 }
 
 def _impl(ctx):

swc/swc.bzl

@@ -1,13 +1,24 @@
-"swc rule"
+"""API for running SWC under Bazel
+
+Simplest usage:
+
+```starlark
+load("@aspect_rules_swc//swc:swc.bzl", "swc")
+
+swc(name = "transpile")
+```
+"""
 
 load("//swc/private:swc.bzl", _swc_lib = "swc")
 load("@bazel_skylib//lib:paths.bzl", "paths")
 
 swc_rule = rule(
     doc = """Underlying rule for the `swc` macro.
 
-    Use this if you need more control over how the rule is called,
-    for example to set your own output labels for `js_outs`.""",
+Most users should just use [swc](#swc) instead.
+
+Use this if you need more control over how the rule is called,
+for example to set your own output labels for `js_outs`.""",
     implementation = _swc_lib.implementation,
     attrs = _swc_lib.attrs,
     toolchains = _swc_lib.toolchains,