diff --git a/docs/npm_package.md b/docs/npm_package.md index ff101b579..7f536f9cd 100644 --- a/docs/npm_package.md +++ b/docs/npm_package.md @@ -107,7 +107,7 @@ To stamp the current git tag as the "version" in the package.json file, see | include_transitive_sources | When True, transitive_sources from JsInfo providers in data targets are included in the list of available files to copy. | True | | include_declarations | When True, declarations from JsInfo providers in data targets are included in the list of available files to copy. | True | | include_transitive_declarations | When True, transitive_declarations from JsInfo providers in data targets are included in the list of available files to copy. | True | -| include_runfiles | When True, default runfiles from srcs targets are included in the list of available files to copy.

This may be needed in a few cases:

- to work-around issues with rules that don't provide everything needed in sources, transitive_sources, declarations & transitive_declarations - to depend on the runfiles targets that don't use JsInfo

NB: The default value will be flipped to False in the next major release as runfiles are not needed in the general case and adding them to the list of files available to copy can add noticeable overhead to the analysis phase in a large repository with many npm_package targets. | True | +| include_runfiles | When True, default runfiles from srcs targets are included in the list of available files to copy.

This may be needed in a few cases:

- to work-around issues with rules that don't provide everything needed in sources, transitive_sources, declarations & transitive_declarations - to depend on the runfiles targets that don't use JsInfo

NB: The default value will be flipped to False in the next major release as runfiles are not needed in the general case and adding them to the list of files available to copy can add noticeable overhead to the analysis phase in a large repository with many npm_package targets. | False | | hardlink | Controls when to use hardlinks to files instead of making copies.

Creating hardlinks is much faster than making copies of files with the caveat that hardlinks share file permissions with their source.

Since Bazel removes write permissions on files in the output tree after an action completes, hardlinks to source files are not recommended since write permissions will be inadvertently removed from sources files.

- auto: hardlinks are used for generated files already in the output tree - off: all files are copied - on: hardlinks are used for all files (not recommended) | "auto" | | verbose | If true, prints out verbose logs to stdout | False | | kwargs | Additional attributes such as tags and visibility | none | diff --git a/npm/private/npm_package.bzl b/npm/private/npm_package.bzl index a2cd4d967..a65a94674 100644 --- a/npm/private/npm_package.bzl +++ b/npm/private/npm_package.bzl @@ -171,8 +171,7 @@ def npm_package( include_transitive_sources = True, include_declarations = True, include_transitive_declarations = True, - # TODO(2.0): flip include_runfiles default to False - include_runfiles = True, + include_runfiles = False, hardlink = "auto", verbose = False, **kwargs):