bun-types - npm Package Compare versions

docs/cli/bun-install.md

		@@ -50,2 +50,5 @@ ### `bun install`

		# Save a text-based lockfile? This is equivalent to the "--save-text-lockfile" CLI argument
		saveTextLockfile = false

		# Disallow changes to lockfile? This is the equivalent to the "--frozen-lockfile" CLI argument
		@@ -112,2 +115,3 @@ frozenLockfile = false
		production: boolean;
		saveTextLockfile: boolean;
		frozenLockfile: boolean;
		@@ -114,0 +118,0 @@ dryRun: boolean;

docs/cli/install.md

		@@ -177,2 +177,5 @@ The `bun` CLI contains a Node.js-compatible package manager designed to be a dramatically faster replacement for `npm`, `yarn`, and `pnpm`. It's a standalone tool that will work in pre-existing Node.js projects; if your project has a `package.json`, `bun install` can help you speed up your workflow.

		# equivalent to `--save-text-lockfile` flag
		saveTextLockfile = false

		# equivalent to `--frozen-lockfile` flag
		@@ -179,0 +182,0 @@ frozenLockfile = false

docs/install/index.md

		@@ -89,2 +89,5 @@ The `bun` CLI contains an `npm`-compatible package manager designed to be a faster replacement for existing package management tools like `npm`, `yarn`, and `pnpm`. It's designed for Node.js compatibility; use it in any Bun or Node.js project.

		# equivalent to `--save-text-lockfile` flag
		saveTextLockfile = false

		# equivalent to `--frozen-lockfile` flag
		@@ -91,0 +94,0 @@ frozenLockfile = false

docs/install/lockfile.md

		@@ -75,2 +75,20 @@ Running `bun install` will create a binary lockfile called `bun.lockb`.

		### Text-based lockfile

		Bun v1.1.39 introduced `bun.lock`, a JSONC formatted lockfile. `bun.lock` is human-readable and git-diffable without configuration, at [no cost to performance](https://bun.sh/blog/bun-lock-text-lockfile#cached-bun-install-gets-30-faster).

		To generate the lockfile, use `--save-text-lockfile` with `bun install`. You can do this for new projects and existing projects already using `bun.lockb` (resolutions will be preserved).

		```bash
		$ bun install --save-text-lockfile
		$ head -n3 bun.lock
		{
		"lockfileVersion": 0,
		"workspaces": {
		```

		Once `bun.lock` is generated, Bun will use it for all subsequent installs and updates through commands that read and modify the lockfile. If both lockfiles exist, `bun.lock` will be choosen over `bun.lockb`.

		Bun v1.2.0 will switch the default lockfile format to `bun.lock`.

		{% /codetabs %}
		@@ -77,0 +95,0 @@

docs/runtime/bunfig.md

		@@ -241,2 +241,13 @@ Bun's behavior can be configured using its configuration file, `bunfig.toml`.

		### `install.saveTextLockfile`

		Generate `bun.lock`, a human-readable text-based lockfile. Once generated, Bun will use this file instead of `bun.lockb`, choosing it over the binary lockfile if both are present.

		Default `false`. In Bun v1.2.0 the default lockfile format will change to `bun.lock`.

		```toml
		[install]
		saveTextLockfile = true
		```

		<!--
		@@ -243,0 +254,0 @@ ### `install.prefer`

package.json

New alerts