Terser rules for Bazel
WARNING: this is beta-quality software. Breaking changes are likely. Not recommended for production use without expert support.
The Terser rules run the Terser JS minifier with Bazel.
Wraps the Terser CLI documented at https://github.com/terser-js/terser#command-line-usage
Installation
Add the @bazel/terser
npm package to your devDependencies
in package.json
.
Your WORKSPACE
should declare a yarn_install
or npm_install
rule named npm
.
It should then install the rules found in the npm packages using the install_bazel_dependencies
function.
See https://github.com/bazelbuild/rules_nodejs/#quickstart
This causes the @bazel/terser
package to be installed as a Bazel workspace named npm_bazel_terser
.
Installing with self-managed dependencies
If you didn't use the yarn_install
or npm_install
rule to create an npm
workspace, you'll have to declare a rule in your root BUILD.bazel
file to execute terser:
nodejs_binary(
name = "terser_bin",
entry_point = "//:node_modules/terser/bin/uglifyjs",
node_modules = ["//:node_modules"],
)
terser_minified
Run the terser minifier.
Typical example:
load("@npm_bazel_terser//:index.bzl", "terser_minified")
terser_minified(
name = "out.min",
src = "input.js",
config_file = "terser_config.json",
)
Note that the name
attribute determines what the resulting files will be called.
So the example above will output out.min.js
and out.min.js.map
(since sourcemap
defaults to true
).
If the input is a directory, then the output will also be a directory, named after the name
attribute.
Usage
terser_minified(name, args, config_file, debug, sourcemap, src, terser_bin)
name
(name, mandatory): A unique name for this target.
args
(List of strings): Additional command line arguments to pass to terser.
Terser only parses minify() args from the config file so additional arguments such as --comments
may
be passed to the rule using this attribute. See https://github.com/terser/terser#command-line-usage for the
full list of terser CLI options.
config_file
(label): A JSON file containing Terser minify() options.
This is the file you would pass to the --config-file argument in terser's CLI.
https://github.com/terser-js/terser#minify-options documents the content of the file.
Bazel will make a copy of your config file, treating it as a template.
Run bazel with --subcommands
to see the path to the copied file.
If you use the magic strings "bazel_debug"
or "bazel_no_debug"
, these will be
replaced with true
and false
respecting the value of the debug
attribute
or the --compilation_mode=dbg
bazel flag.
For example,
{
"compress": {
"arrows": "bazel_no_debug"
}
}
Will disable the arrows
compression setting when debugging.
If config_file
isn't supplied, Bazel will use a default config file.
debug
(Boolean): Configure terser to produce more readable output.
Instead of setting this attribute, consider using debugging compilation mode instead
bazel build --compilation_mode=dbg //my/terser:target
so that it only affects the current build.
sourcemap
(Boolean): Whether to produce a .js.map output
src
(label, mandatory): File(s) to minify.
Can be a .js file, a rule producing .js files as its default output, or a rule producing a directory of .js files.
Note that you can pass multiple files to terser, which it will bundle together.
If you want to do this, you can pass a filegroup here.
terser_bin
(label): An executable target that runs Terser
0.41.0 (2019-11-22)
To upgrade:
http_archive(
name = "build_bazel_rules_nodejs",
sha256 = "8dc1466f8563f3aa4ac7ab7aa3c96651eb7764108219f40b2d1c918e1a81c601",
urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/0.41.0/rules_nodejs-0.41.0.tar.gz"],
)
and run yarn upgrade --scope @bazel
to update all your @bazel
-scoped npm packages to the latest versions.
(or manually do the npm equivalent - they don't have a way to update a scope)
BREAKING CHANGES
As mentioned before, we are close to a 1.0 release, so we are making all our breaking changes now to prepare for a period of stability. Sorry for the long list this time!
web_package
rule has been renamed to pkg_web
and is now a public API
Update your load statements from
load("@build_bazel_rules_nodejs//internal/web_package:web_package.bzl", "web_package")
to
load("@build_bazel_rules_nodejs//:index.bzl", "pkg_web")
ts_devserver
and pkg_web
(previously web_package
) no longer have an index_html
attribute.
They expect an index.html file to be among the assets, and to already
have the script and link tags needed for the app to work.
The feature where those tags were injected into the html dynamically has
been moved to its own rule, inject_html.
We are in a transition state where the inject_html
rule is not published, because we want this to be a plain npm package and not Bazel-specific. We will publish this functionality soon. If you depend on it, you may want to delay this upgrade.
-
internal/rollup_bundle rule is removed. see https://github.com/bazelbuild/rules_nodejs/wiki for migration instructions
-
Removed the expand_location_into_runfiles helper from //internal:node.bzl
Load it from //internal/common:expand_into_runfiles instead
-
npm karma deps for karma_web_test and karma_web_suite are now peer deps so that the versions used can be chosen by the user.
This PR also removes the built-in @io_bazel_rules_webtesting//browsers/sauce:chrome-win10
saucelabs support. It is not very useful as it only tests a single browser and it difficult to use. In the angular repo, saucelabs support was implemented with a custom karma config using karma_web_test. This is the recommended approach.
bazel run @nodejs//:npm
is replaced with bazel run @nodejs//:npm_node_repositories
and bazel run @nodejs//:yarn
is replaced with bazel run @nodejs//:yarn_node_repositories
. @nodejs//:yarn
and @nodejs//:npm
now run yarn & npm in the current working directory instead of on all of the package.json
files in node_repositories()
.
@nodejs//:bin/node
& @nodejs//:bin/node.cmd
(on Windows) are no longer valid targets. Use @nodejs//:node
instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/node
.
@nodejs//:bin/yarn
& @nodejs//:bin/yarn.cmd
(on Windows) are no longer valid targets. Use @nodejs//:yarn
instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/yarn
.
@nodejs//:bin/npm
& @nodejs//:bin/npm.cmd
(on Windows) are no longer valid targets. Use @nodejs//:npm
instead on all platforms. You can still call the old targets in their platform specific node repositories such as @nodejs_darwin_amd64//:bin/npm
.
Bug Fixes
- builtin: allow .tsx entry_point in node binary/test (313d484), closes #1351
- terser: call terser binary instead of uglifyjs (#1360) (a100420)
- terser: remove ngDevMode & ngI18nClosureMode global_defs from default terser config (98c8dbc)
chore
Code Refactoring
- move injector feature to own rule (be06d23)
Features
- node-patches\filesystem patcher. (#1332) (0b2f675)
- support --compilation_mode flag (9fa4343)
- builtin: rename @nodejs//:npm and @nodejs//:yarn to @nodejs//:[yarn/npm]_node_repositories (#1369) (01079a3)
- karma: npm peer deps & remove @rules_webtesting//browsers/sauce:chrome-win10 support (318bbf3)
- protractor: protractor npm package is now a peer deps (#1352) (5db7c8e)