docs: add note about issue #58

aspect-build · Nov 27, 2023 · dd1309b · dd1309b
1 parent fe7efca
commit dd1309b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/esbuild.md b/docs/esbuild.md
diff --git a/esbuild/private/esbuild.bzl b/esbuild/private/esbuild.bzl
@@ -433,5 +433,9 @@ esbuild_bundle = rule(
 Runs the esbuild bundler under Bazel
 
 For further information about esbuild, see https://esbuild.github.io/
+
+Note: esbuild currently follows symlinks and leaves the bazel sandbox, see https://github.com/aspect-build/rules_esbuild/issues/58 for potential issues and workarounds.
+
+For example, escaping the sandbox may require extra configuration such as overriding the default `resolveExtensions` to not load .ts[x] files that are pre-compiled by other rules.
 """,
 )