Struct PackageJson 

pub struct PackageJson {
    pub path: PathBuf,
    pub name: Option<String>,
    pub workspaces: Option<Vec<String>>,
    pub dependencies: Option<HashSet<String>>,
    pub dev_dependencies: Option<HashSet<String>>,
    pub peer_dependencies: Option<HashSet<String>>,
}

Handles interactions with package.json

Fields

path: PathBuf

Path to package.json. Contains the package.json filename.

name: Option<String>

The name of the project.

workspaces: Option<Vec<String>>

The workspaces of the project.

dependencies: Option<HashSet<String>>

The dependencies of the project.

dev_dependencies: Option<HashSet<String>>

The dev dependencies of the project.

peer_dependencies: Option<HashSet<String>>

The peer dependencies of the project.

Implementations

impl PackageJson

pub fn read(path: &PathBuf, with_dependencies: bool) -> Option<Self>

Creates a new PackageJson instance by reading package.json from the given path

Arguments

• path - The path to the package.json file.
• with_dependencies - Whether to parse dependencies in the package.json. This will increase usage of memory.

pub fn get_all_dependencies(&self) -> Option<HashSet<String>>

Gets all dependencies (both regular and dev dependencies)

pub fn find_dependency(&self, name: &str) -> Option<String>

Finds a dependency by name in dependencies, devDependencies, or peerDependencies

Arguments

• name - The name of the dependency to find.

Trait Implementations

impl Clone for PackageJson

fn clone(&self) -> PackageJson

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageJson

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

Formats the value using the given formatter.

impl Default for PackageJson

fn default() -> PackageJson

Returns the “default value” for a type.