bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/{cli/outdated.md → pm/cli/outdated.mdx}

@@ -1,6 +1,30 @@
+---
+title: "bun outdated"
+description: "Check for outdated dependencies"
+---
+
+import Outdated from "/snippets/cli/outdated.mdx";
+
 Use `bun outdated` to check for outdated dependencies in your project. This command displays a table of dependencies that have newer versions available.
 
-{% bunOutdatedTerminal displayGlob="" filter="" glob="" /%}
+```sh terminal icon="terminal"
+bun outdated
+```
+
+```txt
+| Package                        | Current | Update    | Latest     |
+| ------------------------------ | ------- | --------- | ---------- |
+| @sinclair/typebox              | 0.34.15 | 0.34.16   | 0.34.16    |
+| @types/bun (dev)               | 1.2.0   | 1.2.23    | 1.2.23     |
+| eslint (dev)                   | 8.57.1  | 8.57.1    | 9.20.0     |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1     | 3.0.1      |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0    | 3.0.1      |
+| expect-type (dev)              | 0.16.0  | 0.16.0    | 1.1.0      |
+| prettier (dev)                 | 3.4.2   | 3.5.0     | 3.5.0      |
+| tsup (dev)                     | 8.3.5   | 8.3.6     | 8.3.6      |
+| typescript (dev)               | 5.7.2   | 5.7.3     | 5.7.3      |
+
+```
 
 ## Version Information
 
@@ -16,40 +40,121 @@ The output table shows three version columns:
 
 To check if specific dependencies are outdated, pass the package names as positional arguments:
 
-{% bunOutdatedTerminal displayGlob="eslint-plugin-security eslint-plugin-sonarjs" glob="eslint-plugin-*"  /%}
+```sh terminal icon="terminal"
+bun outdated eslint-plugin-security eslint-plugin-sonarjs
+```
+
+```txt
+| Package                        | Current | Update | Latest    |
+| ------------------------------ | ------- | ------ | --------- |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1  | 3.0.1     |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0 | 3.0.1     |
+
+```
 
 You can also pass glob patterns to check for outdated packages:
 
-{% bunOutdatedTerminal displayGlob="'eslint*'" glob="eslint*"  /%}
+```sh terminal icon="terminal"
+bun outdated eslint*
+```
+
+```txt
+| Package                        | Current | Update | Latest     |
+| ------------------------------ | ------- | ------ | ---------- |
+| eslint (dev)                   | 8.57.1  | 8.57.1 | 9.20.0     |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1  | 3.0.1      |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0 | 3.0.1      |
+```
 
 For example, to check for outdated `@types/*` packages:
 
-{% bunOutdatedTerminal displayGlob="'@types/*'" glob="@types/*"  /%}
+```sh terminal icon="terminal"
+bun outdated '@types/*'
+```
+
+```txt
+| Package            | Current | Update | Latest |
+| ------------------ | ------- | ------ | ------ |
+| @types/bun (dev)   | 1.2.0   | 1.2.23 | 1.2.23 |
+```
 
 Or to exclude all `@types/*` packages:
 
-{% bunOutdatedTerminal displayGlob="'!@types/*'" glob="!@types/*"  /%}
+```sh terminal icon="terminal"
+bun outdated '!@types/*'
+```
+
+```txt
+| Package                        | Current | Update    | Latest     |
+| ------------------------------ | ------- | --------- | ---------- |
+| @sinclair/typebox              | 0.34.15 | 0.34.16   | 0.34.16    |
+| eslint (dev)                   | 8.57.1  | 8.57.1    | 9.20.0     |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1     | 3.0.1      |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0    | 3.0.1      |
+| expect-type (dev)              | 0.16.0  | 0.16.0    | 1.1.0      |
+| prettier (dev)                 | 3.4.2   | 3.5.0     | 3.5.0      |
+| tsup (dev)                     | 8.3.5   | 8.3.6     | 8.3.6      |
+| typescript (dev)               | 5.7.2   | 5.7.3     | 5.7.3      |
+```
 
 ### Workspace Filters
 
 Use the `--filter` flag to check for outdated dependencies in a different workspace package:
 
-{% bunOutdatedTerminal  glob="t*" filter="@monorepo/types"  /%}
+```sh terminal icon="terminal"
+bun outdated --filter='@monorepo/types'
+```
+
+```txt
+| Package            | Current | Update | Latest |
+| ------------------ | ------- | ------ | ------ |
+| tsup (dev)         | 8.3.5   | 8.3.6  | 8.3.6  |
+| typescript (dev)   | 5.7.2   | 5.7.3  | 5.7.3  |
+```
 
 You can pass multiple `--filter` flags to check multiple workspaces:
 
-{% bunOutdatedTerminal  glob="{e,t}*" displayGlob="--filter @monorepo/types --filter @monorepo/cli" /%}
+```sh terminal icon="terminal"
+bun outdated --filter @monorepo/types --filter @monorepo/cli
+```
+
+```txt
+| Package                        | Current | Update | Latest     |
+| ------------------------------ | ------- | ------ | ---------- |
+| eslint (dev)                 	 | 8.57.1  | 8.57.1 | 9.20.0     |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1  | 3.0.1      |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0 | 3.0.1      |
+| expect-type (dev)              | 0.16.0  | 0.16.0 | 1.1.0      |
+| tsup (dev)                     | 8.3.5   | 8.3.6  | 8.3.6      |
+| typescript (dev)               | 5.7.2   | 5.7.3  | 5.7.3      |
+```
 
 You can also pass glob patterns to filter by workspace names:
 
-{% bunOutdatedTerminal  glob="{e,t}*" displayGlob="--filter='@monorepo/{types,cli}'" /%}
+```sh terminal icon="terminal"
+bun outdated --filter='@monorepo/{types,cli}'
+```
+
+```txt
+| Package                        | Current | Update | Latest     |
+| ------------------------------ | ------- | ------ | ---------- |
+| eslint (dev)                   | 8.57.1  | 8.57.1 | 9.20.0     |
+| eslint-plugin-security (dev)   | 2.1.1   | 2.1.1  | 3.0.1      |
+| eslint-plugin-sonarjs (dev)    | 0.23.0  | 0.23.0 | 3.0.1      |
+| expect-type (dev)              | 0.16.0  | 0.16.0 | 1.1.0      |
+| tsup (dev)                     | 8.3.5   | 8.3.6  | 8.3.6      |
+| typescript (dev)               | 5.7.2   | 5.7.3  | 5.7.3      |
+```
 
 ### Catalog Dependencies
 
-`bun outdated` supports checking catalog dependencies defined in `package.json`:
+`bun outdated` supports checking catalog dependencies defined in`package.json`:
 
-```sh
-$ bun outdated -r
+```sh terminal icon="terminal"
+bun outdated -r
+```
+
+```txt
 ┌────────────────────┬─────────┬─────────┬─────────┬────────────────────────────────┐
 │ Package            │ Current │ Update  │ Latest  │ Workspace                      │
 ├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
@@ -87,4 +192,6 @@ $ bun outdated -r
 └────────────────────┴─────────┴─────────┴─────────┴────────────────────────────────┘
 ```
 
-{% bunCLIUsage command="outdated" /%}
+---
+
+<Outdated />

package/docs/{install/patch.md → pm/cli/patch.mdx}

@@ -1,3 +1,10 @@
+---
+title: "bun patch"
+description: "Persistently patch node_modules packages in a git-friendly way"
+---
+
+import Patch from "/snippets/cli/patch.mdx";
+
 `bun patch` lets you persistently patch node_modules in a maintainable, git-friendly way.
 
 Sometimes, you need to make a small change to a package in `node_modules/` to fix a bug or add a feature. `bun patch` makes it easy to do this without vendoring the entire package and reuse the patch across multiple installs, multiple projects, and multiple machines.
@@ -7,7 +14,7 @@ Features:
 - Generates `.patch` files applied to dependencies in `node_modules` on install
 - `.patch` files can be committed to your repository, reused across multiple installs, projects, and machines
 - `"patchedDependencies"` in `package.json` keeps track of patched packages
-- `bun patch` lets you patch packages in `node_modules/` while preserving the integrity of Bun's [Global Cache](https://bun.com/docs/install/cache)
+- `bun patch` lets you patch packages in `node_modules/` while preserving the integrity of Bun's [Global Cache](/pm/global-cache)
 - Test your changes locally before committing them with `bun patch --commit <pkg>`
 - To preserve disk space and keep `bun install` fast, patched packages are committed to the Global Cache and shared across projects where possible
 
@@ -15,26 +22,27 @@ Features:
 
 To get started, use `bun patch <pkg>` to prepare the package for patching:
 
-```bash
+```bash terminal icon="terminal"
 # you can supply the package name
-$ bun patch react
+bun patch react
 
 # ...and a precise version in case multiple versions are installed
-$ bun patch react@17.0.2
+bun patch react@17.0.2
 
 # or the path to the package
-$ bun patch node_modules/react
+bun patch node_modules/react
 ```
 
-{% callout %}
-**Note** — Don't forget to call `bun patch <pkg>`! This ensures the package folder in `node_modules/` contains a fresh copy of the package with no symlinks/hardlinks to Bun's cache.
+<Note>
+Don't forget to call `bun patch <pkg>`! This ensures the package folder in `node_modules/` contains a fresh copy of the package with no symlinks/hardlinks to Bun's cache.
 
 If you forget to do this, you might end up editing the package globally in the cache!
-{% /callout %}
+
+</Note>
 
 #### Step 2. Test your changes locally
 
-`bun patch <pkg>` makes it safe to edit the `<pkg>` in `node_modules/` directly, while preserving the integrity of Bun's [Global Cache](https://bun.com/docs/install/cache). This works by re-creating an unlinked clone of the package in `node_modules/` and diffing it against the original package in the Global Cache.
+`bun patch <pkg>` makes it safe to edit the `<pkg>` in `node_modules/` directly, while preserving the integrity of Bun's [Global Cache](/pm/global-cache). This works by re-creating an unlinked clone of the package in `node_modules/` and diffing it against the original package in the Global Cache.
 
 #### Step 3. Commit your changes
 
@@ -42,18 +50,20 @@ Once you're happy with your changes, run `bun patch --commit <path or pkg>`.
 
 Bun will generate a patch file in `patches/`, update your `package.json` and lockfile, and Bun will start using the patched package:
 
-```bash
+```bash terminal icon="terminal"
 # you can supply the path to the patched package
-$ bun patch --commit node_modules/react
+bun patch --commit node_modules/react
 
 # ... or the package name and optionally the version
-$ bun patch --commit react@17.0.2
+bun patch --commit react@17.0.2
 
 # choose the directory to store the patch files
-$ bun patch --commit react --patches-dir=mypatches
+bun patch --commit react --patches-dir=mypatches
 
 # `patch-commit` is available for compatibility with pnpm
-$ bun patch-commit react
+bun patch-commit react
 ```
 
-{% bunCLIUsage command="patch" /%}
+---
+
+<Patch />

package/docs/{cli/pm.md → pm/cli/pm.mdx}

@@ -1,11 +1,16 @@
+---
+title: "bun pm"
+description: "Package manager utilities"
+---
+
 The `bun pm` command group provides a set of utilities for working with Bun's package manager.
 
 ## pack
 
 To create a tarball of the current workspace:
 
-```bash
-$ bun pm pack
+```bash terminal icon="terminal"
+bun pm pack
 ```
 
 This command creates a `.tgz` file containing all files that would be published to npm, following the same rules as `npm pack`.
@@ -14,23 +19,26 @@ This command creates a `.tgz` file containing all files that would be published
 
 Basic usage:
 
-```bash
-$ bun pm pack
+```bash terminal icon="terminal"
+bun pm pack
 # Creates my-package-1.0.0.tgz in current directory
 ```
 
 Quiet mode for scripting:
 
-```bash
-$ TARBALL=$(bun pm pack --quiet)
-$ echo "Created: $TARBALL"
-# Output: Created: my-package-1.0.0.tgz
+```bash terminal icon="terminal"
+TARBALL=$(bun pm pack --quiet)
+echo "Created: $TARBALL"
+```
+
+```txt
+Created: my-package-1.0.0.tgz
 ```
 
 Custom destination:
 
-```bash
-$ bun pm pack --destination ./dist
+```bash terminal icon="terminal"
+bun pm pack --destination ./dist
 # Saves tarball in ./dist/ directory
 ```
 
@@ -49,8 +57,11 @@ $ bun pm pack --destination ./dist
 
 **Default output:**
 
-```bash
-$ bun pm pack
+```bash terminal icon="terminal"
+bun pm pack
+```
+
+```txt
 bun pack v1.2.19
 
 packed 131B package.json
@@ -66,8 +77,11 @@ Packed size: 249B
 
 **Quiet output:**
 
-```bash
-$ bun pm pack --quiet
+```bash terminal icon="terminal"
+bun pm pack --quiet
+```
+
+```txt
 my-package-1.0.0.tgz
 ```
 
@@ -77,15 +91,21 @@ The `--quiet` flag is particularly useful for automation workflows where you nee
 
 To print the path to the `bin` directory for the local project:
 
-```bash
-$ bun pm bin
+```bash terminal icon="terminal"
+bun pm bin
+```
+
+```txt
 /path/to/current/project/node_modules/.bin
 ```
 
 To print the path to the global `bin` directory:
 
-```bash
-$ bun pm bin -g
+```bash terminal icon="terminal"
+bun pm bin -g
+```
+
+```txt
 <$HOME>/.bun/bin
 ```
 
@@ -93,8 +113,11 @@ $ bun pm bin -g
 
 To print a list of installed dependencies in the current project and their resolved versions, excluding their dependencies.
 
-```bash
-$ bun pm ls
+```bash terminal icon="terminal"
+bun pm ls
+```
+
+```txt
 /path/to/project node_modules (135)
 ├── eslint@8.38.0
 ├── react@18.2.0
@@ -105,8 +128,11 @@ $ bun pm ls
 
 To print all installed dependencies, including nth-order dependencies.
 
-```bash
-$ bun pm ls --all
+```bash terminal icon="terminal"
+bun pm ls --all
+```
+
+```txt
 /path/to/project node_modules (135)
 ├── @eslint-community/eslint-utils@4.4.0
 ├── @eslint-community/regexpp@4.5.0
@@ -126,59 +152,61 @@ $ bun pm ls --all
 
 Print your npm username. Requires you to be logged in (`bunx npm login`) with credentials in either `bunfig.toml` or `.npmrc`:
 
-```bash
-$ bun pm whoami
+```bash terminal icon="terminal"
+bun pm whoami
 ```
 
 ## hash
 
 To generate and print the hash of the current lockfile:
 
-```bash
-$ bun pm hash
+```bash terminal icon="terminal"
+bun pm hash
 ```
 
 To print the string used to hash the lockfile:
 
-```bash
-$ bun pm hash-string
+```bash terminal icon="terminal"
+bun pm hash-string
 ```
 
 To print the hash stored in the current lockfile:
 
-```bash
-$ bun pm hash-print
+```bash terminal icon="terminal"
+bun pm hash-print
 ```
 
 ## cache
 
 To print the path to Bun's global module cache:
 
-```bash
-$ bun pm cache
+```bash terminal icon="terminal"
+bun pm cache
 ```
 
 To clear Bun's global module cache:
 
-```bash
-$ bun pm cache rm
+```bash terminal icon="terminal"
+bun pm cache rm
 ```
 
 ## migrate
 
 To migrate another package manager's lockfile without installing anything:
 
-```bash
-$ bun pm migrate
+```bash terminal icon="terminal"
+bun pm migrate
 ```
 
 ## untrusted
 
 To print current untrusted dependencies with scripts:
 
-```bash
-$ bun pm untrusted
+```bash terminal icon="terminal"
+bun pm untrusted
+```
 
+```txt
 ./node_modules/@biomejs/biome @1.8.3
  » [postinstall]: node scripts/postinstall.js
 
@@ -189,8 +217,8 @@ These dependencies had their lifecycle scripts blocked during install.
 
 To run scripts for untrusted dependencies and add to `trustedDependencies`:
 
-```bash
-$ bun pm trust <names>
+```bash terminal icon="terminal"
+bun pm trust <names>
 ```
 
 Options for the `trust` command:
@@ -201,8 +229,8 @@ Options for the `trust` command:
 
 To print the default trusted dependencies list:
 
-```bash
-$ bun pm default-trusted
+```bash terminal icon="terminal"
+bun pm default-trusted
 ```
 
 see the current list on GitHub [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt)
@@ -211,9 +239,12 @@ see the current list on GitHub [here](https://github.com/oven-sh/bun/blob/main/s
 
 To display current package version and help:
 
-```bash
-$ bun pm version
-bun pm version v1.3.2-canary.20251105T140650 (ca7428e9)
+```bash terminal icon="terminal"
+bun pm version
+```
+
+```txt
+bun pm version v1.3.1 (ca7428e9)
 Current package version: v1.0.0
 
 Increment:
@@ -235,15 +266,18 @@ Options:
   --force, -f          Bypass dirty git history check
 
 Examples:
-  $ bun pm version patch
-  $ bun pm version 1.2.3 --no-git-tag-version
-  $ bun pm version prerelease --preid beta --message "Release beta: %s"
+  bun pm version patch
+  bun pm version 1.2.3 --no-git-tag-version
+  bun pm version prerelease --preid beta --message "Release beta: %s"
 ```
 
 To bump the version in `package.json`:
 
-```bash
-$ bun pm version patch
+```bash terminal icon="terminal"
+bun pm version patch
+```
+
+```txt
 v1.0.1
 ```
 
@@ -255,7 +289,7 @@ Manage `package.json` data with get, set, delete, and fix operations.
 
 All commands support dot and bracket notation:
 
-```bash
+```bash terminal icon="terminal"
 scripts.build              # dot notation
 contributors[0]            # array access
 workspaces.0               # dot with numeric index
@@ -264,22 +298,22 @@ scripts[test:watch]        # bracket for special chars
 
 Examples:
 
-```bash
+```bash terminal icon="terminal"
 # set
-$ bun pm pkg get name                               # single property
-$ bun pm pkg get name version                       # multiple properties
-$ bun pm pkg get                                    # entire package.json
-$ bun pm pkg get scripts.build                      # nested property
+bun pm pkg get name                               # single property
+bun pm pkg get name version                       # multiple properties
+bun pm pkg get                                    # entire package.json
+bun pm pkg get scripts.build                      # nested property
 
 # set
-$ bun pm pkg set name="my-package"                  # simple property
-$ bun pm pkg set scripts.test="jest" version=2.0.0  # multiple properties
-$ bun pm pkg set {"private":"true"} --json          # JSON values with --json flag
+bun pm pkg set name="my-package"                  # simple property
+bun pm pkg set scripts.test="jest" version=2.0.0  # multiple properties
+bun pm pkg set {"private":"true"} --json          # JSON values with --json flag
 
 # delete
-$ bun pm pkg delete description                     # single property
-$ bun pm pkg delete scripts.test contributors[0]    # multiple/nested
+bun pm pkg delete description                     # single property
+bun pm pkg delete scripts.test contributors[0]    # multiple/nested
 
 # fix
-$ bun pm pkg fix                                    # auto-fix common issues
+bun pm pkg fix                                    # auto-fix common issues
 ```