docs: document bins attr for bzlmod

aspect-build · Oct 18, 2023 · b688a52 · b688a52
1 parent 6d72ff4
commit b688a52
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/docs/npm_translate_lock.md b/docs/npm_translate_lock.md
diff --git a/npm/private/npm_translate_lock.bzl b/npm/private/npm_translate_lock.bzl
@@ -386,6 +386,18 @@ def npm_translate_lock(
             In the future, this field may be automatically populated from information in the pnpm lock
             file. That feature is currently blocked on https://github.com/pnpm/pnpm/issues/5131.
 
+            Note: Bzlmod users must use an alternative syntax due to module extensions not supporting
+            dict-of-dict attributes:
+
+            ```
+            bins = {
+                "@foo/bar": [
+                    "foo=./foo.js",
+                    "bar=./bar.js"
+                ],
+            }
+            ```
+
         verify_node_modules_ignored: node_modules folders in the source tree should be ignored by Bazel.
 
             This points to a `.bazelignore` file to verify that all nested node_modules directories