Struct Npm

pub struct Npm { /* private fields */ }

This struct is used to execute npm commands. Can be created from NpmEnv of using Default.

After queuing the desired commands, use Npm::exec() to execute them.

Example

use npm_rs::*;

Npm::default().install(Some(&["tailwindcss"])).exec()?;

Implementations

impl Npm

pub fn init(self) -> Self

Same behaviour as npm-init -y. Initializes a package, creating a package.json file with the default template.

pub fn install(self, args: Option<&[&str]>) -> Self

Same behaviour as npm-install.

• If args =None: Installs all the dependencies listed in package.json into the local node_modules folder.
• If args =Some: Installs any package in args into the local node_modules folder.

pub fn uninstall(self, pkg: &[&str]) -> Self

Same behaviour as npm-uninstall. Uninstalls the given packages in pkg.

pub fn update(self, pkg: Option<&[&str]>) -> Self

Same behaviour as npm-update.

• If args =None: Updates all the local dependencies (local node_modules folder).
• If args =Some: Updates any package in pkg.

pub fn run(self, command: &str) -> Self

Same behaviour as npm-run-script. Runs an arbitrary command from package.json’s “scripts” object.

pub fn custom(self, command: &str, args: Option<&[&str]>) -> Self

Runs a custom npm command.

Arguments

• command: command to execute.
• args: arguments of command.

Example

use npm_rs::*;

Npm::default().custom("audit", None).exec()?; // Equivalent to `npm audit`.

pub fn exec(self) -> Result<ExitStatus, Error>

Executes all the commands in the invokation order used, waiting for its completion status.

Example

use npm_rs::*;

let status = Npm::default().install(None).run("build").exec()?; // Executes npm install && npm run build.
assert!(status.success()); // Will `panic` if not completed successfully.

Trait Implementations

impl Default for Npm

fn default() -> Self

Returns the “default value” for a type.