bun-types 1.3.2-canary.20251106T140813 → 1.3.2-canary.20251108T140624

package/docs/pm/cli/outdated.mdx

@@ -0,0 +1,197 @@
+---
+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.
+
+```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
+
+The output table shows three version columns:
+
+- **Current**: The version currently installed
+- **Update**: The latest version that satisfies your package.json version range
+- **Latest**: The latest version published to the registry
+
+### Dependency Filters
+
+`bun outdated` supports searching for outdated dependencies by package names and glob patterns.
+
+To check if specific dependencies are outdated, pass the package names as positional arguments:
+
+```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:
+
+```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:
+
+```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:
+
+```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:
+
+```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:
+
+```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:
+
+```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`:
+
+```sh terminal icon="terminal"
+bun outdated -r
+```
+
+```txt
+┌────────────────────┬─────────┬─────────┬─────────┬────────────────────────────────┐
+│ Package            │ Current │ Update  │ Latest  │ Workspace                      │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ body-parser        │ 1.19.0  │ 1.19.0  │ 2.2.0   │ @test/shared                   │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ cors               │ 2.8.0   │ 2.8.0   │ 2.8.5   │ @test/shared                   │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ chalk              │ 4.0.0   │ 4.0.0   │ 5.6.2   │ @test/utils                    │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ uuid               │ 8.0.0   │ 8.0.0   │ 13.0.0  │ @test/utils                    │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ axios              │ 0.21.0  │ 0.21.0  │ 1.12.2  │ catalog (@test/app)            │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ lodash             │ 4.17.15 │ 4.17.15 │ 4.17.21 │ catalog (@test/app, @test/app) │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ react              │ 17.0.0  │ 17.0.0  │ 19.1.1  │ catalog (@test/app)            │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ react-dom          │ 17.0.0  │ 17.0.0  │ 19.1.1  │ catalog (@test/app)            │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ express            │ 4.17.0  │ 4.17.0  │ 5.1.0   │ catalog (@test/shared)         │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ moment             │ 2.24.0  │ 2.24.0  │ 2.30.1  │ catalog (@test/utils)          │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ @types/node (dev)  │ 14.0.0  │ 14.0.0  │ 24.5.2  │ @test/shared                   │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ @types/react (dev) │ 17.0.0  │ 17.0.0  │ 19.1.15 │ catalog:testing (@test/app)    │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ eslint (dev)       │ 7.0.0   │ 7.0.0   │ 9.36.0  │ catalog:testing (@test/app)    │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ typescript (dev)   │ 4.9.5   │ 4.9.5   │ 5.9.2   │ catalog:build (@test/app)      │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ jest (dev)         │ 26.0.0  │ 26.0.0  │ 30.2.0  │ catalog:testing (@test/shared) │
+├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
+│ prettier (dev)     │ 2.0.0   │ 2.0.0   │ 3.6.2   │ catalog:build (@test/utils)    │
+└────────────────────┴─────────┴─────────┴─────────┴────────────────────────────────┘
+```
+
+---
+
+<Outdated />

package/docs/pm/cli/patch.mdx

@@ -0,0 +1,69 @@
+---
+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.
+
+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](/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
+
+#### Step 1. Prepare the package for patching
+
+To get started, use `bun patch <pkg>` to prepare the package for patching:
+
+```bash terminal icon="terminal"
+# you can supply the package name
+bun patch react
+
+# ...and a precise version in case multiple versions are installed
+bun patch react@17.0.2
+
+# or the path to the package
+bun patch node_modules/react
+```
+
+<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!
+
+</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](/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
+
+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 terminal icon="terminal"
+# you can supply the path to the patched package
+bun patch --commit node_modules/react
+
+# ... or the package name and optionally the version
+bun patch --commit react@17.0.2
+
+# choose the directory to store the patch files
+bun patch --commit react --patches-dir=mypatches
+
+# `patch-commit` is available for compatibility with pnpm
+bun patch-commit react
+```
+
+---
+
+<Patch />

package/docs/pm/cli/pm.mdx

@@ -0,0 +1,319 @@
+---
+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 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`.
+
+## Examples
+
+Basic usage:
+
+```bash terminal icon="terminal"
+bun pm pack
+# Creates my-package-1.0.0.tgz in current directory
+```
+
+Quiet mode for scripting:
+
+```bash terminal icon="terminal"
+TARBALL=$(bun pm pack --quiet)
+echo "Created: $TARBALL"
+```
+
+```txt
+Created: my-package-1.0.0.tgz
+```
+
+Custom destination:
+
+```bash terminal icon="terminal"
+bun pm pack --destination ./dist
+# Saves tarball in ./dist/ directory
+```
+
+## Options
+
+- `--dry-run`: Perform all tasks except writing the tarball to disk. Shows what would be included.
+- `--destination <dir>`: Specify the directory where the tarball will be saved.
+- `--filename <name>`: Specify an exact file name for the tarball to be saved at.
+- `--ignore-scripts`: Skip running pre/postpack and prepare scripts.
+- `--gzip-level <0-9>`: Set a custom compression level for gzip, ranging from 0 to 9 (default is 9).
+- `--quiet`: Only output the tarball filename, suppressing verbose output. Ideal for scripts and automation.
+
+> **Note:** `--filename` and `--destination` cannot be used at the same time.
+
+## Output Modes
+
+**Default output:**
+
+```bash terminal icon="terminal"
+bun pm pack
+```
+
+```txt
+bun pack v1.2.19
+
+packed 131B package.json
+packed 40B index.js
+
+my-package-1.0.0.tgz
+
+Total files: 2
+Shasum: f2451d6eb1e818f500a791d9aace80b394258a90
+Unpacked size: 171B
+Packed size: 249B
+```
+
+**Quiet output:**
+
+```bash terminal icon="terminal"
+bun pm pack --quiet
+```
+
+```txt
+my-package-1.0.0.tgz
+```
+
+The `--quiet` flag is particularly useful for automation workflows where you need to capture the generated tarball filename for further processing.
+
+## bin
+
+To print the path to the `bin` directory for the local project:
+
+```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 terminal icon="terminal"
+bun pm bin -g
+```
+
+```txt
+<$HOME>/.bun/bin
+```
+
+## ls
+
+To print a list of installed dependencies in the current project and their resolved versions, excluding their dependencies.
+
+```bash terminal icon="terminal"
+bun pm ls
+```
+
+```txt
+/path/to/project node_modules (135)
+├── eslint@8.38.0
+├── react@18.2.0
+├── react-dom@18.2.0
+├── typescript@5.0.4
+└── zod@3.21.4
+```
+
+To print all installed dependencies, including nth-order dependencies.
+
+```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
+├── @eslint/eslintrc@2.0.2
+├── @eslint/js@8.38.0
+├── @nodelib/fs.scandir@2.1.5
+├── @nodelib/fs.stat@2.0.5
+├── @nodelib/fs.walk@1.2.8
+├── acorn@8.8.2
+├── acorn-jsx@5.3.2
+├── ajv@6.12.6
+├── ansi-regex@5.0.1
+├── ...
+```
+
+## whoami
+
+Print your npm username. Requires you to be logged in (`bunx npm login`) with credentials in either `bunfig.toml` or `.npmrc`:
+
+```bash terminal icon="terminal"
+bun pm whoami
+```
+
+## hash
+
+To generate and print the hash of the current lockfile:
+
+```bash terminal icon="terminal"
+bun pm hash
+```
+
+To print the string used to hash the lockfile:
+
+```bash terminal icon="terminal"
+bun pm hash-string
+```
+
+To print the hash stored in the current lockfile:
+
+```bash terminal icon="terminal"
+bun pm hash-print
+```
+
+## cache
+
+To print the path to Bun's global module cache:
+
+```bash terminal icon="terminal"
+bun pm cache
+```
+
+To clear Bun's global module cache:
+
+```bash terminal icon="terminal"
+bun pm cache rm
+```
+
+## migrate
+
+To migrate another package manager's lockfile without installing anything:
+
+```bash terminal icon="terminal"
+bun pm migrate
+```
+
+## untrusted
+
+To print current untrusted dependencies with scripts:
+
+```bash terminal icon="terminal"
+bun pm untrusted
+```
+
+```txt
+./node_modules/@biomejs/biome @1.8.3
+ » [postinstall]: node scripts/postinstall.js
+
+These dependencies had their lifecycle scripts blocked during install.
+```
+
+## trust
+
+To run scripts for untrusted dependencies and add to `trustedDependencies`:
+
+```bash terminal icon="terminal"
+bun pm trust <names>
+```
+
+Options for the `trust` command:
+
+- `--all`: Trust all untrusted dependencies.
+
+## default-trusted
+
+To print the default trusted dependencies list:
+
+```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)
+
+## version
+
+To display current package version and help:
+
+```bash terminal icon="terminal"
+bun pm version
+```
+
+```txt
+bun pm version v1.3.1 (ca7428e9)
+Current package version: v1.0.0
+
+Increment:
+  patch      1.0.0 → 1.0.1
+  minor      1.0.0 → 1.1.0
+  major      1.0.0 → 2.0.0
+  prerelease 1.0.0 → 1.0.1-0
+  prepatch   1.0.0 → 1.0.1-0
+  preminor   1.0.0 → 1.1.0-0
+  premajor   1.0.0 → 2.0.0-0
+  from-git   Use version from latest git tag
+  1.2.3      Set specific version
+
+Options:
+  --no-git-tag-version Skip git operations
+  --allow-same-version Prevents throwing error if version is the same
+  --message=<val>, -m  Custom commit message, use %s for version substitution
+  --preid=<val>        Prerelease identifier (i.e beta → 1.0.1-beta.0)
+  --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"
+```
+
+To bump the version in `package.json`:
+
+```bash terminal icon="terminal"
+bun pm version patch
+```
+
+```txt
+v1.0.1
+```
+
+Supports `patch`, `minor`, `major`, `premajor`, `preminor`, `prepatch`, `prerelease`, `from-git`, or specific versions like `1.2.3`. By default creates git commit and tag unless `--no-git-tag-version` was used to skip.
+
+## pkg
+
+Manage `package.json` data with get, set, delete, and fix operations.
+
+All commands support dot and bracket notation:
+
+```bash terminal icon="terminal"
+scripts.build              # dot notation
+contributors[0]            # array access
+workspaces.0               # dot with numeric index
+scripts[test:watch]        # bracket for special chars
+```
+
+Examples:
+
+```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
+
+# 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
+
+# delete
+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
+```