npm-utils 0.5.3

Pure-Rust utilities for the npm registry: resolve a package version, download npm tarballs and GitHub archives, and extract files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! `install` — resolve `package.json`'s `dependencies`, write `package-lock.json`, and install
//! `node_modules/` (= `npm install`).
//!
//! Two flags mirror the ecosystem's "lockfile vs install" knobs:
//! - `--lockfile-only` (npm `--package-lock-only`, pnpm `--lockfile-only`): resolve and write the
//!   lock, but don't touch `node_modules/`.
//! - `--no-lockfile` (yarn `--no-lockfile`, npm `--no-package-lock`): install `node_modules/`
//!   without writing a lock.

use std::path::Path;

use super::common::{read_manifest, report_installed, sync};
use super::Res;
use crate::install::node_modules;
use crate::package_json::lock::write_from_manifest;
use crate::registry::{PackumentDetail, Registry};

/// Resolve the manifest's transitive registry dependencies. By default (npm parity) write a fresh,
/// licensed v3 `package-lock.json` and install the locked tree from it (the same `sync` `add` and
/// `upgrade` use). `lockfile_only` stops after writing the lock; `no_lockfile` installs straight
/// from the manifest and leaves any lock untouched (the pre-0.5 behavior). clap makes the two flags
/// mutually exclusive.
pub(super) fn run(
    dir: &Path,
    lockfile_only: bool,
    no_lockfile: bool,
    detail: PackumentDetail,
) -> Res {
    if no_lockfile {
        report_installed(&node_modules(&dir.join("package.json"), dir)?);
        return Ok(());
    }

    if lockfile_only {
        let lockfile = dir.join("package-lock.json");
        write_from_manifest(
            &dir.join("package.json"),
            &lockfile,
            &Registry::npm().with_detail(detail),
        )?;
        println!("wrote {}", lockfile.display());
        return Ok(());
    }

    let doc = read_manifest(dir)?;
    sync(dir, &doc, detail)
}