docs: document exclude_types_from_npm_packages as deprecated

aspect-build · Nov 7, 2024 · db066ec · db066ec
1 parent a829760
commit db066ec
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 4 deletions.
diff --git a/docs/npm_package.md b/docs/npm_package.md
diff --git a/npm/BUILD.bazel b/npm/BUILD.bazel
@@ -10,12 +10,14 @@ exports_files(
 
 # Allows for faster dev roundtrip by excluding type-checking from libraries that are
 # internally used via npm_package
+# TODO(3.0): remove
 bool_flag(
     name = "exclude_types_from_npm_packages",
     build_setting_default = False,
     visibility = ["//visibility:public"],
 )
 
+# TODO(3.0): remove
 config_setting(
     name = "exclude_types_from_npm_packages_flag",
     flag_values = {":exclude_types_from_npm_packages": "true"},

diff --git a/npm/private/npm_package.bzl b/npm/private/npm_package.bzl
@@ -195,8 +195,6 @@ def npm_package(
 
     The two `include*_types` options may cause type-check actions to run, which slows down your
     development round-trip.
-    You can pass the Bazel option `--@aspect_rules_js//npm:exclude_types_from_npm_packages`
-    to override these two attributes for an individual `bazel` invocation, avoiding the type-check.
 
     As of rules_js 2.0, the recommended solution for avoiding eager type-checking when linking
     1p deps is to link `js_library` or any `JsInfo` producing targets directly without the