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_esbuild@v0.25.0 — View source

​
Public API

​
Rule: esbuild_bundle

Runs the esbuild bundler under Bazel For further information about esbuild, see https://esbuild.github.io/ Note: to prevent esbuild from following symlinks and leaving the bazel sandbox, a custom bazel-sandbox resolver plugin is used in this rule. See https://github.com/aspect-build/rules_esbuild/issues/58 for more info.

​
Attributes

​
name
name
required
A unique name for this target.
​
args_file
label
default:"None"
Internal use only
​
define
dictionary: String → String
default:"{}"
A dict of global identifier replacements. Values are subject to $(location …) expansion. Example:
esbuild(
name = "bundle",
define = {
"process.env.NODE_ENV": "production"
},
)
See https://esbuild.github.io/api/#define for more details
​
deps
list of labels
default:"[]"
A list of direct dependencies that are required to build the bundle
​
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.
​
entry_point
label
default:"None"
The bundle’s entry point (e.g. your main.js or app.js or index.js)This is a shortcut for the entry_points attribute with a single entry. Specify either this attribute or entry_point, but not both.
​
entry_points
list of labels
default:"[]"
The bundle’s entry points (e.g. your main.js or app.js or index.js)Specify either this attribute or entry_point, but not both.
​
external
list of strings
default:"[]"
A list of module names that are treated as external and not included in the resulting bundleSee https://esbuild.github.io/api/#external for more details
​
format
string
default:"\"\""
The output format of the bundle, defaults to iife when platform is browser and cjs when platform is node. If performing code splitting or multiple entry_points are specified, defaults to esm.See https://esbuild.github.io/api/#format for more details
​
launcher
label
default:"None"
Override the default esbuild wrapper, which is supplied by the esbuild toolchain
​
max_threads
integer
default:"0"
Sets the GOMAXPROCS variable to limit the number of threads that esbuild can run with. This can be useful if running many esbuild rule invocations in parallel, which has the potential to cause slowdown. For general use, leave this attribute unset.
​
metafile
boolean
default:"False"
If true, esbuild creates a metafile along with the output
​
minify
boolean
default:"False"
Minifies the bundle with the built in minification. Removes whitespace, shortens identifieres and uses equivalent but shorter syntax.Sets all —minify-* flagsSee https://esbuild.github.io/api/#minify for more details
​
output
label
default:"None"
Name of the output file when bundling
​
output_css
label
default:"None"
Declare a .css file will be output next to output bundle.If your JS code contains import statements that import .css files, esbuild will place the content in a file next to the main output file, which you’ll need to declare. If your output file is named ‘foo.js’, you should set this to ‘foo.css’.
​
output_dir
boolean
default:"False"
If true, esbuild produces an output directory containing all output files
​
output_map
label
default:"None"
Name of the output source map when bundling
​
platform
string
default:"browser"
The platform to bundle for.See https://esbuild.github.io/api/#platform for more details
​
sourcemap
string
default:"\"\""
Defines where sourcemaps are output and how they are included in the bundle. If linked, a separate .js.map file is generated and referenced by the bundle. If external, a separate .js.map file is generated but not referenced by the bundle. If inline, a sourcemap is generated and its contents are inlined into the bundle (and no external sourcemap file is created). If both, a sourcemap is inlined and a .js.map file is created.See https://esbuild.github.io/api/#sourcemap for more details
​
sources_content
boolean
default:"False"
If False, omits the sourcesContent field from generated source mapsSee https://esbuild.github.io/api/#sources-content for more details
​
splitting
boolean
default:"False"
If true, esbuild produces an output directory containing all the output files from code splitting for multiple entry pointsSee https://esbuild.github.io/api/#splitting and https://esbuild.github.io/api/#entry-points for more details
​
srcs
list of labels
default:"[]"
Source files to be made available to esbuild
​
target
list of strings
default:"[\"es2015\"]"
Environment target (e.g. es2017, chrome58, firefox57, safari11, edge16, node10, esnext). Default es2015.See https://esbuild.github.io/api/#target for more details
​
bundle
boolean
default:"True"
If true, esbuild will bundle the input files, inlining their dependencies recursively
​
config
label
default:"None"
Configuration file used for esbuild. Note that options set in this file may get overwritten. If you formerly used args from rules_nodejs’ npm package @bazel/esbuild, replace it with this attribute. TODO: show how to write a config file that depends on plugins, similar to the esbuild_config macro in rules_nodejs.
​
tsconfig
label
required
TypeScript configuration file used by esbuild. Default to an empty file with no configuration.See https://esbuild.github.io/api/#tsconfig for more details
​
bazel_sandbox_plugin
boolean
default:"True"
If true, a custom bazel-sandbox plugin will be enabled that prevents esbuild from leaving the Bazel sandbox. See https://github.com/aspect-build/rules_esbuild/pull/160 for more info.
​
esbuild_log_level
string
default:"warning"
Set the logging level of esbuild.We set a default of “warmning” since the esbuild default of “info” includes an output file summary which is slightly redundant under Bazel and may lead to spammy bazel build output.See https://esbuild.github.io/api/#log-level for more details.
​
js_log_level
string
default:"error"
Set the logging level for js_binary launcher and the JavaScript bazel-sandbox plugin.Log levels: fatal, error, warn, info, debug
​
node_toolchain
label
default:"None"
The Node.js toolchain to use for this target.See https://bazelbuild.github.io/rules_nodejs/Toolchains.htmlTypically this is left unset so that Bazel automatically selects the right Node.js toolchain for the target platform. See https://bazel.build/extending/toolchains#toolchain-resolution for more information.

​
Function: esbuild

esbuild helper macro around the esbuild_bundle rule For a full list of attributes, see the esbuild_bundle rule

​
Parameters

​
name
unknown
required
The name used for this rule and output files
​
output_dir
unknown
default:"False"
If True, produce an output directory
​
splitting
unknown
default:"False"
If True, produce a code split bundle in the output directory
​
config
unknown
default:"None"
an esbuild configuration file Can be a dictionary. In this case it is converted to json, and a config file is generated which exports the resulting object, e.g. export default {...}
​
kwargs
unknown
All other args from esbuild_bundle