-
Notifications
You must be signed in to change notification settings - Fork 524
scratch
Allows a tsconfig.json file to extend another file.
Normally, you just give a single tsconfig.json file as the tsconfig attribute
of a ts_library rule. However, if your tsconfig.json uses the extends
feature from TypeScript, then the Bazel implementation needs to know about that
extended configuration file as well, to pass them both to the TypeScript compiler.
ts_config(name, deps, src)
(name, mandatory) : A unique name for this target.
(labels, mandatory) : Additional tsconfig.json files referenced via extends
(label, mandatory) : The tsconfig.json file passed to the TypeScript compiler
ts_devserver is a simple development server intended for a quick "getting started" experience.
Additional documentation at https://github.com/alexeagle/angular-bazel-example/wiki/Running-a-devserver-under-Bazel
ts_devserver(name, additional_root_paths, bootstrap, data, deps, devserver, entry_module, index_html, port, scripts, serving_path, static_files)
(name, mandatory) : A unique name for this target.
(List of strings)
: Additional root paths to serve static_files from.
Paths should include the workspace name such as ["__main__/resources"]
(labels) : Scripts to include in the JS bundle before the module loader (require.js)
(labels) : Dependencies that can be require'd while the server is running
(labels)
: Targets that produce JavaScript, such as ts_library
(label) : Go based devserver executable. Defaults to precompiled go binary in @npm_bazel_typescript setup by @bazel/typescript npm package
(String)
: The entry_module should be the AMD module name of the entry module such as "__main__/src/index".
ts_devserver concats the following snippet after the bundle to load the application:
require(["entry_module"]);
(label) : An index.html file, we'll inject the script tag for the bundle, as well as script tags for .js static_files and link tags for .css static_files
(Integer) : The port that the devserver will listen on.
(labels) : User scripts to include in the JS bundle before the application sources
(String) : The path you can request from the client HTML which serves the JavaScript bundle. If you don't specify one, the JavaScript can be loaded at /_/ts_scripts.js
(labels) : Arbitrary files which to be served, such as index.html. They are served relative to the package where this rule is declared.
ts_library type-checks and compiles a set of TypeScript sources to JavaScript.
It produces declarations files (.d.ts) which are used for compiling downstream
TypeScript targets and JavaScript for the browser and Closure compiler.
ts_library(name, compile_angular_templates, compiler, data, deps, expected_diagnostics, generate_externs, internal_testing_type_check_dependencies, module_name, module_root, node_modules, runtime, runtime_deps, srcs, supports_workers, tsconfig, tsickle_typed)
(name, mandatory) : A unique name for this target.
(Boolean) : Run the Angular ngtsc compiler under ts_library
(label)
: Sets a different TypeScript compiler binary to use for this library.
For example, we use the vanilla TypeScript tsc.js for bootstrapping,
and Angular compilations can replace this with ngc.
The default ts_library compiler depends on the @npm//@bazel/typescript
target which is setup for projects that use bazel managed npm deps that
fetch the @bazel/typescript npm package. It is recommended that you use
the workspace name @npm for bazel managed deps so the default
compiler works out of the box. Otherwise, you'll have to override
the compiler attribute manually.
(labels)
(labels) : Compile-time dependencies, typically other ts_library targets
(List of strings)
(Boolean)
(Boolean) : Testing only, whether to type check inputs that aren't srcs.
(String)
(String)
(label) : The npm packages which should be available during the compile.
The default value is @npm//typescript:typescript__typings is setup
for projects that use bazel managed npm deps that. It is recommended
that you use the workspace name @npm for bazel managed deps so the
default node_modules works out of the box. Otherwise, you'll have to
override the node_modules attribute manually. This default is in place
since ts_library will always depend on at least the typescript
default libs which are provided by @npm//typescript:typescript__typings.
This attribute is DEPRECATED. As of version 0.18.0 the recommended
approach to npm dependencies is to use fine grained npm dependencies
which are setup with the yarn_install or npm_install rules.
For example, in targets that used a //:node_modules filegroup,
ts_library(
name = "my_lib",
...
node_modules = "//:node_modules",
)
which specifies all files within the //:node_modules filegroup
to be inputs to the my_lib. Using fine grained npm dependencies,
my_lib is defined with only the npm dependencies that are
needed:
ts_library(
name = "my_lib",
...
deps = [
"@npm//@types/foo",
"@npm//@types/bar",
"@npm//foo",
"@npm//bar",
...
],
)
In this case, only the listed npm packages and their
transitive deps are includes as inputs to the my_lib target
which reduces the time required to setup the runfiles for this
target (see https://github.com/bazelbuild/bazel/issues/5153).
The default typescript libs are also available via the node_modules
default in this case.
The @npm external repository and the fine grained npm package
targets are setup using the yarn_install or npm_install rule
in your WORKSPACE file:
yarn_install( name = "npm", package_json = "//:package.json", yarn_lock = "//:yarn.lock", )
(String)
(labels)
(labels, mandatory) : The TypeScript source files to compile.
(Boolean) : Intended for internal use only.
Allows you to disable the Bazel Worker strategy for this library. Typically used together with the "compiler" setting when using a non-worker aware compiler binary.
(label)
: A tsconfig.json file containing settings for TypeScript compilation.
Note that some properties in the tsconfig are governed by Bazel and will be
overridden, such as target and module.
The default value is set to //:tsconfig.json by a macro. This means you must
either:
- Have your
tsconfig.jsonfile in the workspace root directory - Use an alias in the root BUILD.bazel file to point to the location of tsconfig:
alias(name="tsconfig.json", actual="//path/to:tsconfig-something.json") - Give an explicit
tsconfigattribute to allts_librarytargets
(Boolean) : If using tsickle, instruct it to translate types to ClosureJS format
Wraps https://github.com/dcodeIO/protobuf.js for use in Bazel.
ts_proto_library has identical outputs to ts_library, so it can be used anywhere
a ts_library can appear, such as in the deps[] of another ts_library.
Example:
load("@npm_bazel_typescript//:index.bzl", "ts_library", "ts_proto_library")
proto_library(
name = "car_proto",
srcs = ["car.proto"],
)
ts_proto_library(
name = "car",
deps = [":car_proto"],
)
ts_library(
name = "test_lib",
testonly = True,
srcs = ["car.spec.ts"],
deps = [":car"],
)Note in this example we named the ts_proto_library rule car so that the
result will be car.d.ts. This means our TypeScript code can just
import {symbols} from './car'. Use the output_name attribute if you want to
name the rule differently from the output file.
The JavaScript produced by protobuf.js has a runtime dependency on a support library.
Under devmode (e.g. ts_devserver, ts_web_test_suite) you'll need to include these scripts
in the bootstrap phase (before Require.js loads). You can use the label
@npm_bazel_typescript//:protobufjs_bootstrap_scripts to reference these scripts
in the bootstrap attribute of ts_web_test_suite or ts_devserver.
To complete the example above, you could write a ts_web_test_suite:
load("@npm_bazel_karma//:index.bzl", "ts_web_test_suite")
ts_web_test_suite(
name = "test",
deps = ["test_lib"],
bootstrap = ["@npm_bazel_typescript//:protobufjs_bootstrap_scripts"],
browsers = [
"@io_bazel_rules_webtesting//browsers:chromium-local",
"@io_bazel_rules_webtesting//browsers:firefox-local",
],
)ts_proto_library(name, deps, output_name)
(name, mandatory) : A unique name for this target.
(labels) : proto_library targets
(String) : Name of the resulting module, which you will import from. If not specified, the name will match the target's name.
Verify that a compatible npm_bazel_typescript is loaded a WORKSPACE.
Where COMPAT_VERSION and VERSION come from the npm_bazel_typescript that is loaded in a WORKSPACE, this function will check:
VERSION >= version_string >= COMPAT_VERSION
This should be called from the WORKSPACE file so that the build fails as
early as possible. For example:
# in WORKSPACE:
load("@npm_bazel_typescript//:index.bzl", "check_rules_typescript_version")
check_rules_typescript_version(version_string = "0.22.0")
check_rules_typescript_version(version_string)
A version string to check for compatibility with the loaded version
of npm_bazel_typescript. The version check performed is
VERSION >= version_string >= COMPAT_VERSION where VERSION and COMPAT_VERSION
come from the loaded version of npm_bazel_typescript.
This repository rule should be called from your WORKSPACE file.
It creates some additional Bazel external repositories that are used internally by the TypeScript rules.
ts_setup_workspace()