Skip to content

docs: clarify trustedDependencies replaces the default allow list #31027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alii merged 4 commits into from
May 26, 2026
+13 −1
Merged

docs: clarify trustedDependencies replaces the default allow list #31027

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76756b4
docs: clarify trustedDependencies replaces the default allow list
robobun May 19, 2026
4003b70
docs: reword trustedDependencies follow-up to match replace-not-exten…
robobun May 19, 2026
37e98da
docs: drop stale ~500/top 500 figure for default trusted dependencies
robobun May 19, 2026
d86b8a3
[autofix.ci] apply automated fixes
autofix-ci[bot] May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/pm/lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Instead of executing arbitrary scripts, Bun uses a "default-secure" approach. Yo

Once added to `trustedDependencies`, install/re-install the package. Bun will read this field and run lifecycle scripts for `my-trusted-package`.

The top 500 npm packages with lifecycle scripts are allowed by default. You can see the full list [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt).
A curated list of popular npm packages with lifecycle scripts is allowed by default. You can see the full list [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt).

<Note>
The default trusted dependencies list only applies to packages installed from npm. For packages from other sources
Expand All @@ -53,6 +53,18 @@ The top 500 npm packages with lifecycle scripts are allowed by default. You can
packages from spoofing trusted package names through local file paths or git repositories.
</Note>

### Behavior of the `trustedDependencies` field

Defining `trustedDependencies` in `package.json` **replaces** the default list rather than extending it. Exactly one of three modes applies per project:

| `package.json` | Packages allowed to run lifecycle scripts |
| ------------------------------------- | ---------------------------------------------------------- |
| `trustedDependencies` omitted | The packages in Bun's built-in list (npm sources only). |
| `trustedDependencies: ["pkg-a", ...]` | **Only** the listed packages. The default list is ignored. |
| `trustedDependencies: []` | **No** packages, including none from the default list. |

Set `trustedDependencies: []` when you want to opt out of the default allow list entirely without passing `--ignore-scripts` on every install. If you define `trustedDependencies` with an explicit list, include any packages from the [default list](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt) whose lifecycle scripts you still need (for example, `sharp` or `esbuild`) — they are no longer trusted implicitly.

---

## `--ignore-scripts`
Expand Down
Loading