rules_nodejs

rules_nodejs Bazel module

This is the “core” module, and is used internally by build_bazel_rules_nodejs. Most users should continue to use only the latter, and ignore this “core” module.

The dependency graph is: build_bazel_rules_nodejs -> rules_nodejs -> bazel_skylib

Features:

Most features, such as npm_install and nodejs_binary are still in the build_bazel_rules_nodejs module. We plan to clean these up and port into rules_nodejs in a future major release.

directory_file_path

USAGE

directory_file_path(name, directory, path)

Provide DirectoryFilePathInfo to reference some file within a directory.

    Otherwise there is no way to give a Bazel label for it.

ATTRIBUTES

name

(Name, mandatory): A unique name for this target.

directory

(Label, mandatory): a directory

path

(String, mandatory): a path within that directory

node_repositories

USAGE

node_repositories(name, node_download_auth, node_repositories, node_urls, node_version, platform,
                  repo_mapping, use_nvmrc)

To be run in user’s WORKSPACE to install rules_nodejs dependencies.

This rule sets up node, npm, and npx. The versions of these tools can be specified in one of three ways

Simplest Usage

Specify no explicit versions. This will download and use the latest NodeJS that was available when the version of rules_nodejs you’re using was released. Note that you can skip calling node_repositories in your WORKSPACE file - if you later try to yarn_install or npm_install, we’ll automatically select this simple usage for you.

Forced version(s)

You can select the version of NodeJS to download & use by specifying it when you call node_repositories, using a value that matches a known version (see the default values)

Using a custom version

You can pass in a custom list of NodeJS repositories and URLs for node_repositories to use.

Custom NodeJS versions

To specify custom NodeJS versions, use the node_repositories attribute

node_repositories(
    node_repositories = {
        "10.10.0-darwin_amd64": ("node-v10.10.0-darwin-x64.tar.gz", "node-v10.10.0-darwin-x64", "00b7a8426e076e9bf9d12ba2d571312e833fe962c70afafd10ad3682fdeeaa5e"),
        "10.10.0-linux_amd64": ("node-v10.10.0-linux-x64.tar.xz", "node-v10.10.0-linux-x64", "686d2c7b7698097e67bcd68edc3d6b5d28d81f62436c7cf9e7779d134ec262a9"),
        "10.10.0-windows_amd64": ("node-v10.10.0-win-x64.zip", "node-v10.10.0-win-x64", "70c46e6451798be9d052b700ce5dadccb75cf917f6bf0d6ed54344c856830cfb"),
    },
)

These can be mapped to a custom download URL, using node_urls

node_repositories(
    node_version = "10.10.0",
    node_repositories = {"10.10.0-darwin_amd64": ("node-v10.10.0-darwin-x64.tar.gz", "node-v10.10.0-darwin-x64", "00b7a8426e076e9bf9d12ba2d571312e833fe962c70afafd10ad3682fdeeaa5e")},
    node_urls = ["https://mycorpproxy/mirror/node/v{version}/{filename}"],
)

A Mac client will try to download node from https://mycorpproxy/mirror/node/v10.10.0/node-v10.10.0-darwin-x64.tar.gz and expect that file to have sha256sum 00b7a8426e076e9bf9d12ba2d571312e833fe962c70afafd10ad3682fdeeaa5e

See the the repositories documentation for how to use the resulting repositories.

Using a custom node.js.

To avoid downloads, you can check in a vendored node.js binary or can build one from source. See toolchains and examples/vendored_node_and_yarn.

ATTRIBUTES

name

(Name, mandatory): A unique name for this repository.

node_download_auth

(Dictionary: String -> String): auth to use for all url requests Example: {“type”: “basic”, “login”: “", "password": "" }

Defaults to {}

node_repositories

(Dictionary: String -> List of strings): Custom list of node repositories to use

A dictionary mapping NodeJS versions to sets of hosts and their corresponding (filename, strip_prefix, sha256) tuples. You should list a node binary for every platform users have, likely Mac, Windows, and Linux.

By default, if this attribute has no items, we’ll use a list of all public NodeJS releases.

Defaults to {}

node_urls

(List of strings): custom list of URLs to use to download NodeJS

Each entry is a template for downloading a node distribution.

The {version} parameter is substituted with the node_version attribute, and {filename} with the matching entry from the node_repositories attribute.

Defaults to ["https://nodejs.org/dist/v{version}/{filename}"]

node_version

(String): the specific version of NodeJS to install

Defaults to "16.18.1"

platform

(String): Internal use only. Which platform to install as a toolchain. If unset, we assume the repository is named nodejs_[platform]

Defaults to ""

repo_mapping

(Dictionary: String -> String, mandatory): A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).

use_nvmrc

(Label): the local path of the .nvmrc file containing the version of node

If set then also set node_version to the version found in the .nvmrc file.

Defaults to None

node_toolchain

USAGE

node_toolchain(name, npm, npm_files, npm_path, run_npm, target_tool, target_tool_path)

Defines a node toolchain for a platform.

You can use this to refer to a vendored nodejs binary in your repository, or even to compile nodejs from sources using rules_foreign_cc or other rules.

First, in a BUILD.bazel file, create a node_toolchain definition:

load("@rules_nodejs//nodejs:toolchain.bzl", "node_toolchain")

node_toolchain(
    name = "node_toolchain",
    target_tool = "//some/path/bin/node",
)

Next, declare which execution platforms or target platforms the toolchain should be selected for based on constraints.

toolchain(
    name = "my_nodejs",
    exec_compatible_with = [
        "@platforms//os:linux",
        "@platforms//cpu:x86_64",
    ],
    toolchain = ":node_toolchain",
    toolchain_type = "@rules_nodejs//nodejs:toolchain_type",
)

See https://bazel.build/extending/toolchains#toolchain-resolution for more information on toolchain resolution.

Finally in your WORKSPACE, register it with register_toolchains("//:my_nodejs")

For usage see https://docs.bazel.build/versions/main/toolchains.html#defining-toolchains. You can use the --toolchain_resolution_debug flag to bazel to help diagnose which toolchain is selected.

ATTRIBUTES

name

(Name, mandatory): A unique name for this target.

npm

(Label): A hermetically downloaded npm executable target for this target’s platform.

Defaults to None

npm_files

(List of labels): Files required in runfiles to run npm.

Defaults to []

npm_path

(String): Path to an existing npm executable for this target’s platform.

Defaults to ""

run_npm

(Label): A template file that allows us to execute npm

Defaults to None

target_tool

(Label): A hermetically downloaded nodejs executable target for this target’s platform.

Defaults to None

target_tool_path

(String): Path to an existing nodejs executable for this target’s platform.

Defaults to ""

yarn_repositories

USAGE

yarn_repositories(name, node_repository, repo_mapping, yarn_download_auth, yarn_releases, yarn_urls,
                  yarn_version)

Repository rule to fetch the yarnpkg.com package manager.

Note, the recommended name is “yarn”. If you choose a different name, you’ll have to override the yarn attribute in your yarn_install rule to point to your yarn.js file.

Custom Yarn versions

To specify custom Yarn versions, use the yarn_releases attribute

yarn_repositories(
    yarn_releases = {
        "1.12.1": ("yarn-v1.12.1.tar.gz", "yarn-v1.12.1", "09bea8f4ec41e9079fa03093d3b2db7ac5c5331852236d63815f8df42b3ba88d"),
    },
)

Like node_urls, the yarn_urls attribute can be used to provide a list of custom URLs to use to download yarn

yarn_repositories(
    yarn_releases = {
        "1.12.1": ("yarn-v1.12.1.tar.gz", "yarn-v1.12.1", "09bea8f4ec41e9079fa03093d3b2db7ac5c5331852236d63815f8df42b3ba88d"),
    },
    yarn_version = "1.12.1",
    yarn_urls = [
        "https://github.com/yarnpkg/yarn/releases/download/v{version}/{filename}",
    ],
)

Will download yarn from https://github.com/yarnpkg/yarn/releases/download/v1.2.1/yarn-v1.12.1.tar.gz and expect the file to have sha256sum 09bea8f4ec41e9079fa03093d3b2db7ac5c5331852236d63815f8df42b3ba88d.

If you don’t use Yarn at all, you can skip downloading it by setting yarn_urls = [].

Vendored yarn

You can vendor the yarn.js file into your repo. In this case, don’t call yarn_repositories at all. Just pass the label of your vendored file to the yarn attribute of yarn_install.

ATTRIBUTES

name

(Name, mandatory): A unique name for this repository.

node_repository

(String): The basename for a nodejs toolchain to use for running yarn. Usually this is the value of the name attribute given to a nodejs_register_toolchains call in WORKSPACE

Defaults to "nodejs"

repo_mapping

(Dictionary: String -> String, mandatory): A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target).

yarn_download_auth

(Dictionary: String -> String): auth to use for all url requests Example: {“type”: “basic”, “login”: “", "password": "" }

Defaults to {}

yarn_releases

(Dictionary: String -> List of strings): Custom list of yarn releases to use.

Dictionary mapping Yarn versions to their corresponding (filename, strip_prefix, sha256) tuples.

By default, if this attribute has no items, we'll use a list of all public releases which
is periodically mirrored to rules_nodejs.

Defaults to {}

yarn_urls

(List of strings): custom list of URLs to use to download Yarn

Each entry is a template using `yarn_version` and `yarn_releases` in the substitutions.

If this list is empty, we won't download yarn at all.

Defaults to ["https://github.com/yarnpkg/yarn/releases/download/v{version}/{filename}"]

yarn_version

(String): the specific version of Yarn to install

Defaults to "1.22.11"

DeclarationInfo

USAGE

DeclarationInfo(declarations, transitive_declarations, type_blocklisted_declarations)

The DeclarationInfo provider allows JS rules to communicate typing information. TypeScript’s .d.ts files are used as the interop format for describing types. package.json files are included as well, as TypeScript needs to read the “typings” property.

Do not create DeclarationInfo instances directly, instead use the declaration_info factory function.

Note: historically this was a subset of the string-typed “typescript” provider.

FIELDS

declarations

A depset of typings files produced by this rule

transitive_declarations

A depset of typings files produced by this rule and all its transitive dependencies. This prevents needing an aspect in rules that consume the typings, which improves performance.

type_blocklisted_declarations

A depset of .d.ts files that we should not use to infer JSCompiler types (via tsickle)

DirectoryFilePathInfo

USAGE

DirectoryFilePathInfo(directory, path)

Joins a label pointing to a TreeArtifact with a path nested within that directory.

FIELDS

directory

a TreeArtifact (ctx.actions.declare_directory)

path

path relative to the directory

JSModuleInfo

USAGE

JSModuleInfo(direct_sources, sources)

JavaScript files and sourcemaps.

FIELDS

direct_sources

Depset of direct JavaScript files and sourcemaps

sources

Depset of direct and transitive JavaScript files and sourcemaps

LinkablePackageInfo

USAGE

LinkablePackageInfo(files, package_name, package_path, path)

The LinkablePackageInfo provider provides information to the linker for linking pkg_npm built packages

FIELDS

files

Depset of files in this package (must all be contained within path)

package_name

The package name.

This field is optional. If not set, the target can be made linkable to a package_name with the npm_link rule.

package_path

The directory in the workspace to link to.

If set, link the 1st party dependencies to the node_modules under the package path specified. If unset, the default is to link to the node_modules root of the workspace.

path

The path to link to.

Path must be relative to execroot/wksp. It can either an output dir path such as,

bazel-out/<platform>-<build>/bin/path/to/package or bazel-out/<platform>-<build>/bin/external/external_wksp>/path/to/package

or a source file path such as,

path/to/package or external/<external_wksp>/path/to/package

UserBuildSettingInfo

USAGE

UserBuildSettingInfo(value)

FIELDS

value

(Undocumented)

declaration_info

USAGE

declaration_info(declarations, deps)

Constructs a DeclarationInfo including all transitive files needed to type-check from DeclarationInfo providers in a list of deps.

PARAMETERS

declarations

list of typings files

deps

list of labels of dependencies where we should collect their DeclarationInfo to pass transitively

Defaults to []

js_module_info

USAGE

js_module_info(sources, deps)

Constructs a JSModuleInfo including all transitive sources from JSModuleInfo providers in a list of deps.

PARAMETERS

sources

direct JS files

deps

other targets that provide JSModuleInfo, typically from the deps attribute

Defaults to []