diff options
| author |  Guilherme J. Tramontina <guilherme.tramontina@gmail.com>
| 2023-09-14 03:27:32 +1000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-09-13 10:27:32 -0700 |
| commit | 687e31dc3a16e76926f0eb06155c5357741b05ab (patch) | |
| tree | 773c05d083e64f974632ce2341770f20793e0e01 | |
| parent | c3455c0ceee6bbe399781819a42fff6cf24792e2 (diff) | |
| download | bun-687e31dc3a16e76926f0eb06155c5357741b05ab.tar.gz bun-687e31dc3a16e76926f0eb06155c5357741b05ab.tar.zst bun-687e31dc3a16e76926f0eb06155c5357741b05ab.zip | |
docs: update lockfile diff instructions (#5275)
| -rw-r--r-- | docs/install/lockfile.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/install/lockfile.md b/docs/install/lockfile.md index cf1dc3794..c7306c1b9 100644 --- a/docs/install/lockfile.md +++ b/docs/install/lockfile.md @@ -10,16 +10,20 @@ Run `bun install -y` to generate a Yarn-compatible `yarn.lock` (v1) that can be #### How do I `git diff` Bun's lockfile? -To add to the global gitattributes file: +Add the following to your local or global `.gitattributes` file: -To enable diffing in the local gitattributes file (per-repository): +``` +*.lockb binary diff=lockb +``` + +Then add the following to you local git config with: ```sh $ git config diff.lockb.textconv bun $ git config diff.lockb.binary true ``` -To enable diffing in the global gitattributes file (system-wide), use the `--global` option: +Or to your global git config (system-wide) with the `--global` option: ```sh $ git config --global diff.lockb.textconv bun |