@aspect_rules_esbuild//esbuild:defs.bzl

Public API

Functions & Macros

esbuild

esbuild helper macro around the esbuild_bundle rule

For a full list of attributes, see the esbuild_bundle rule

Parameters

`*name`	The name used for this rule and output files
`output_dir`	If `True`, produce an output directory Default: `False`
`splitting`	If `True`, produce a code split bundle in the output directory Default: `False`
`config`	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 {...}` Default: `None`
`kwargs`	All other args from `esbuild_bundle`

Rules

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.

Attribute	Type	Description
`*name`	`name`	A unique name for this target.
`args_file`	`label`	Internal use only Default: `None`
`define`	`dictionary: String → String`	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 Default: `{}`
`deps`	`list of labels`	A list of direct dependencies that are required to build the bundle Default: `[]`
`data`	`list of labels`	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. Default: `[]`
`entry_point`	`label`	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. Default: `None`
`entry_points`	`list of labels`	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. Default: `[]`
`external`	`list of strings`	A list of module names that are treated as external and not included in the resulting bundle See https://esbuild.github.io/api/#external for more details Default: `[]`
`format`	`string`	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 Default: `""`
`launcher`	`label`	Override the default esbuild wrapper, which is supplied by the esbuild toolchain Default: `None`
`max_threads`	`integer`	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. Default: `0`
`metafile`	`boolean`	If true, esbuild creates a metafile along with the output Default: `False`
`minify`	`boolean`	Minifies the bundle with the built in minification. Removes whitespace, shortens identifieres and uses equivalent but shorter syntax. Sets all --minify-* flags See https://esbuild.github.io/api/#minify for more details Default: `False`
`output`	`label`	Name of the output file when bundling Default: `None`
`output_css`	`label`	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'. Default: `None`
`output_dir`	`boolean`	If true, esbuild produces an output directory containing all output files Default: `False`
`output_map`	`label`	Name of the output source map when bundling Default: `None`
`platform`	`string`	The platform to bundle for. See https://esbuild.github.io/api/#platform for more details Default: `"browser"`
`sourcemap`	`string`	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 Default: `""`
`sources_content`	`boolean`	If False, omits the `sourcesContent` field from generated source maps See https://esbuild.github.io/api/#sources-content for more details Default: `False`
`splitting`	`boolean`	If true, esbuild produces an output directory containing all the output files from code splitting for multiple entry points See https://esbuild.github.io/api/#splitting and https://esbuild.github.io/api/#entry-points for more details Default: `False`
`srcs`	`list of labels`	Source files to be made available to esbuild Default: `[]`
`target`	`list of strings`	Environment target (e.g. es2017, chrome58, firefox57, safari11, edge16, node10, esnext). Default es2015. See https://esbuild.github.io/api/#target for more details Default: `["es2015"]`
`bundle`	`boolean`	If true, esbuild will bundle the input files, inlining their dependencies recursively Default: `True`
`config`	`label`	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. Default: `None`
`*tsconfig`	`label`	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`	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. Default: `True`
`esbuild_log_level`	`string`	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. Default: `"warning"`
`js_log_level`	`string`	Set the logging level for js_binary launcher and the JavaScript bazel-sandbox plugin. Log levels: fatal, error, warn, info, debug Default: `"error"`
`node_toolchain`	`label`	The Node.js toolchain to use for this target. See https://bazelbuild.github.io/rules_nodejs/Toolchains.html Typically 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. Default: `None`