diff options
| author |  Tiago Teixeira <tiagocmtex@gmail.com>
| 2023-06-26 01:43:39 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-06-25 16:43:39 -0700 |
| commit | d8817c2d32a237440a7677622ba351aa95f47c22 (patch) | |
| tree | 7dd24039b7c56f0e59b14e3b3f2a6debc2ed8985 /docs/cli | |
| parent | 15ac08474ef0b18b94bbf4863b2497e18e968379 (diff) | |
| download | bun-d8817c2d32a237440a7677622ba351aa95f47c22.tar.gz bun-d8817c2d32a237440a7677622ba351aa95f47c22.tar.zst bun-d8817c2d32a237440a7677622ba351aa95f47c22.zip | |
Add support for install with --frozen-lockfile (#3365)
* Add support for install with --frozen-lockfile
* Add test
* Add test for frozenLockfile in config file
Diffstat (limited to 'docs/cli')
| -rw-r--r-- | docs/cli/bun-install.md | 4 | ||||
| -rw-r--r-- | docs/cli/install.md | 9 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/cli/bun-install.md b/docs/cli/bun-install.md index 11cf3ee81..8050070be 100644 --- a/docs/cli/bun-install.md +++ b/docs/cli/bun-install.md @@ -47,6 +47,9 @@ registry = "https://registry.yarnpkg.com/" # Install for production? This is the equivalent to the "--production" CLI argument production = false +# Disallow changes to lockfile? This is the equivalent to the "--fozen-lockfile" CLI argument +frozenLockfile = false + # Don't actually install dryRun = true @@ -108,6 +111,7 @@ export interface Install { scopes: Scopes; registry: Registry; production: boolean; + frozenLockfile: boolean; dryRun: boolean; optional: boolean; dev: boolean; diff --git a/docs/cli/install.md b/docs/cli/install.md index 695c975f9..4489a0d4a 100644 --- a/docs/cli/install.md +++ b/docs/cli/install.md @@ -49,6 +49,12 @@ To install in production mode (i.e. without `devDependencies`): $ bun install --production ``` +To install dependencies without allowing changes to lockfile (useful on CI): + +```bash +$ bun install --frozen-lockfile +``` + To perform a dry run (i.e. don't actually install anything): ```bash @@ -80,6 +86,9 @@ peer = false # equivalent to `--production` flag production = false +# equivalent to `--frozen-lockfile` flag +frozenLockfile = false + # equivalent to `--dry-run` flag dryRun = false ``` |