Enum Runner 

pub enum Runner {
    Npm,
    Yarn,
    Pnpm,
    Bun,
}

Supported package managers.

Variants

Npm

Node Package Manager (npm)

Yarn

Yarn package manager

Pnpm

pnpm - Fast, disk space efficient package manager

Bun

Bun - Fast all-in-one JavaScript runtime

Implementations

impl Runner

pub fn executable(&self) -> &'static str

Get the executable name for this runner.

pub fn run_prefix(&self) -> &'static str

Get the base run command (without script name).

Returns the command prefix used to run scripts:

• npm: “npm run”
• yarn: “yarn”
• pnpm: “pnpm”
• bun: “bun run”

pub fn run_command(&self, script: &str) -> Vec<String>

Get the command to run a script as a vector of arguments.

Examples

use npm_run_scripts::package::Runner;

let cmd = Runner::Npm.run_command("dev");
assert_eq!(cmd, vec!["npm", "run", "dev"]);

let cmd = Runner::Yarn.run_command("build");
assert_eq!(cmd, vec!["yarn", "build"]);

pub fn run_command_with_args( &self, script: &str, args: &[String], ) -> Vec<String>

Get the command to run a script with additional arguments.

Arguments

• script - The script name to run
• args - Additional arguments to pass to the script

Examples

use npm_run_scripts::package::Runner;

let args = vec!["--watch".to_string(), "--coverage".to_string()];
let cmd = Runner::Npm.run_command_with_args("test", &args);
assert_eq!(cmd, vec!["npm", "run", "test", "--", "--watch", "--coverage"]);

pub fn format_command(&self, script: &str) -> String

Format the run command as a string for display.

Examples

use npm_run_scripts::package::Runner;

assert_eq!(Runner::Npm.format_command("dev"), "npm run dev");
assert_eq!(Runner::Yarn.format_command("build"), "yarn build");

pub fn format_command_with_args(&self, script: &str, args: &[String]) -> String

Format the run command with arguments as a string for display.

Examples

use npm_run_scripts::package::Runner;

let args = vec!["--watch".to_string()];
assert_eq!(
    Runner::Npm.format_command_with_args("test", &args),
    "npm run test -- --watch"
);

pub fn display_name(&self) -> &'static str

Get the display name for the runner.

pub fn icon(&self) -> &'static str

Get the icon/emoji for the runner.

pub fn lock_file(&self) -> &'static str

Get the lock file name for this runner.

pub fn all() -> &'static [Runner]

Get all supported runners.

pub fn workspace_command(&self, workspace: &str, script: &str) -> Vec<String>

Get the command to run a workspace script.

Arguments

• workspace - The workspace/package name
• script - The script name to run

pub fn workspace_command_with_args( &self, workspace: &str, script: &str, args: &[String], ) -> Vec<String>

Get the command to run a workspace script with additional arguments.

Arguments

• workspace - The workspace/package name
• script - The script name to run
• args - Additional arguments to pass to the script

pub fn format_workspace_command(&self, workspace: &str, script: &str) -> String

Format the workspace run command as a string for display.

pub fn format_workspace_command_with_args( &self, workspace: &str, script: &str, args: &[String], ) -> String

Format the workspace run command with arguments as a string for display.

Trait Implementations

impl Clone for Runner

fn clone(&self) -> Runner

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Runner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Runner

fn default() -> Runner

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Runner

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Runner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<CliRunner> for Runner

fn from(runner: CliRunner) -> Self

Converts to this type from the input type.

impl FromStr for Runner

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Runner

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Runner

fn eq(&self, other: &Runner) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Runner

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Runner

impl Eq for Runner

impl StructuralPartialEq for Runner