Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspect.build/llms.txt

Use this file to discover all available pages before exploring further.

Documentation for @aspect_rules_swc@v2.6.1 — View source
API for running the SWC cli under Bazel The simplest usage relies on the swcrc attribute automatically discovering .swcrc: 
load("@aspect_rules_swc//swc:defs.bzl", "swc")

swc(
    name = "compile",
    srcs = ["file.ts"],
)

​
Rule: swc_compile

Underlying rule for the swc macro. Most users should use swc instead, as it predicts the output files and has convenient default values. 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

​
name
name
required
A unique name for this target.
​
srcs
list of labels
required
source files, typically .ts files in the source tree
​
args
list of strings
default:"[]"
Additional arguments to pass to swcx cli (NOT swc!).NB: this is not the same as the CLI arguments for @swc/cli npm package. For performance, rules_swc does not call a Node.js program wrapping the swc rust binding. Instead, we directly spawn the (somewhat experimental) native Rust binary shipped inside the @swc/core npm package, which the swc project calls “swcx” Tracking issue for feature parity: https://github.com/swc-project/swc/issues/4017
​
source_maps
string
default:"false"
Create source map files for emitted JavaScript files.see https://swc.rs/docs/usage/cli#—source-maps—s
​
source_root
string
default:"\"\""
Specify the root path for debuggers to find the reference source code.see https://swc.rs/docs/usage/cli#—source-rootIf not set, then the directory containing the source file is used.
​
output_dir
boolean
default:"False"
Whether to produce a directory output rather than individual files.If out_dir is also specified, it is used as the name of the output directory. Otherwise, the directory is named the same as the target.
​
data
list of labels
default:"[]"
Runtime dependencies to include in binaries/tests that depend on this target.Follows the same semantics as js_library data attribute. See https://docs.aspect.build/rulesets/aspect_rules_js/docs/js_library#data for more info.
​
swcrc
label
default:"None"
label of a configuration file for swc, see https://swc.rs/docs/configuration/swcrc
​
plugins
list of labels
default:"[]"
swc compilation plugins, created with swc_plugin rule
​
out_dir
string
default:"\"\""
With output_dir=False, output files will have this directory prefix.With output_dir=True, this is the name of the output directory.
​
root_dir
string
default:"\"\""
a subdirectory under the input package which should be consider the root directory of all the input files
​
emit_isolated_dts
boolean
default:"False"
Emit .d.ts files instead of .js for TypeScript sourcesEXPERIMENTAL: this API is undocumented, experimental and may change without notice
​
default_ext
string
default:"\"\""
Default extension for output files.If a source file does not indicate a specific module type, this extension is used.If unset, extensions will be determined based on the js_outs outputs attribute or source file extensions.
​
allow_js
boolean
default:"True"
Allow JavaScript sources to be transpiled.If False, only TypeScript sources will be transpiled.
​
js_outs
list of labels
default:"[]"
list of expected JavaScript output files.There should be one for each entry in srcs.
​
map_outs
list of labels
default:"[]"
list of expected source map output files.Can be empty, meaning no source maps should be produced. If non-empty, there should be one for each entry in srcs.
​
dts_outs
list of labels
default:"[]"
list of expected TypeScript declaration files.Can be empty, meaning no dts files should be produced. If non-empty, there should be one for each entry in srcs.

​
Function: swc

Execute the SWC compiler

​
Parameters

​
name
unknown
required
A name for this target
​
srcs
unknown
required
List of labels of TypeScript source files.
​
args
unknown
default:"[]"
Additional options to pass to swcx cli, see https://github.com/swc-project/swc/discussions/3859 Note: we do not run the NodeJS wrapper @swc/cli
​
data
unknown
default:"[]"
Files needed at runtime by binaries or tests that transitively depend on this target. See https://bazel.build/reference/be/common-definitions#typical-attributes
​
plugins
unknown
default:"[]"
List of plugin labels created with swc_plugin.
​
output_dir
unknown
default:"False"
Whether to produce a directory output rather than individual files.If out_dir is set, then that is used as the name of the output directory. Otherwise, the output directory is named the same as the target.
​
swcrc
unknown
default:"None"
Label of a .swcrc configuration file for the SWC cli, see https://swc.rs/docs/configuration/swcrc Instead of a label, you can pass a dictionary matching the JSON schema. If this attribute isn’t specified, and a file .swcrc exists in the same folder as this rule, it is used.Note that some settings in .swcrc also appear in tsconfig.json. See the notes in [/docs/tsconfig.md].
​
source_maps
unknown
default:"False"
If set, the —source-maps argument is passed to the SWC cli with the value. See https://swc.rs/docs/usage/cli#—source-maps—s. True/False are automaticaly converted to “true”/“false” string values the cli expects.
​
out_dir
unknown
default:"None"
The base directory for output files relative to the output directory for this package.If output_dir is True, then this is used as the name of the output directory.
​
root_dir
unknown
default:"None"
A subdirectory under the input package which should be considered the root directory of all the input files
​
default_ext
unknown
default:".js"
The default extension to use for output files. If not set, the default is “.js”.
​
allow_js
unknown
default:"True"
If True (default), then .js/.mjs/.cjs input files are transpiled. If False, they are ignored. This can be used to mimic the behavior of tsc when using ts_project(transpiler).
​
kwargs
unknown
additional keyword arguments passed through to underlying swc_compile, eg. visibility, tags

​
Function: swc_plugin

Configure an SWC plugin

​
Parameters

​
name
unknown
required
A name for this target
​
srcs
unknown
default:"[]"
Plugin files. Either a directory containing a package.json pointing at a wasm file as the main entrypoint, or a wasm file. Usually a linked npm package target via rules_js.
​
config
unknown
default:"{}"
Optional configuration dict for the plugin. This is passed as a JSON object into the jsc.experimental.plugins entry for the plugin.
​
kwargs
unknown
additional keyword arguments passed through to underlying rule, eg. visibility, tags