5 releases (1 stable)

1.0.0 Nov 16, 2022
0.2.1 Sep 3, 2021
0.1.2 Aug 6, 2021
0.1.1 Jun 9, 2021
0.1.0 May 31, 2021

#288 in Build Utils

Download history 1718/week @ 2024-11-21 1174/week @ 2024-11-28 1229/week @ 2024-12-05 1121/week @ 2024-12-12 952/week @ 2024-12-19 756/week @ 2024-12-26 955/week @ 2025-01-02 896/week @ 2025-01-09 867/week @ 2025-01-16 934/week @ 2025-01-23 779/week @ 2025-01-30 1450/week @ 2025-02-06 1136/week @ 2025-02-13 1089/week @ 2025-02-20 1207/week @ 2025-02-27 1551/week @ 2025-03-06

5,198 downloads per month
Used in 18 crates (7 directly)

MIT/Apache

13KB
157 lines

npm_rs

License (MIT OR APACHE) GitHub Workflow Status Crates.io docs.rs

A library to run npm commands from your Rust build script.

Documentation

This library will aid you in executing npm commands when building your crate/bin, removing the burden of having to manually do so or by using a tool other than Cargo.

This crate provides an abstraction over Command to use npm in a simple and easy package with fluent API.

npm_rs exposes NpmEnv to configure the npm execution enviroment and Npm to use said enviroment to execute npm commands.

Examples

Manual NODE_ENV setup

// build.rs

use npm_rs::*;

let exit_status = NpmEnv::default()
       .with_node_env(&NodeEnv::Production)
       .with_env("FOO", "bar")
       .init_env()
       .install(None)
       .run("build")
       .exec()?;

Automatic NODE_ENV setup

// build.rs

use npm_rs::*;

let exit_status = NpmEnv::default()
       .with_node_env(&NodeEnv::from_cargo_profile().unwrap_or_default())
       .with_env("FOO", "bar")
       .init_env()
       .install(None)
       .run("build")
       .exec()?;

License

npm_rs is either distributed under MIT or Apache-2.0 license. Choose as you please.

Dependencies