Struct PackageJson 

pub struct PackageJson {

    pub name: Option<String>,
    pub main: Option<String>,
    pub module: Option<String>,
    pub types: Option<String>,
    pub typings: Option<String>,
    pub source: Option<String>,
    pub browser: Option<Value>,
    pub bin: Option<Value>,
    pub exports: Option<Value>,
    pub dependencies: Option<HashMap<String, String>>,
    pub dev_dependencies: Option<HashMap<String, String>>,
    pub peer_dependencies: Option<HashMap<String, String>>,
    pub peer_dependencies_meta: Option<HashMap<String, PeerDependencyMeta>>,
    pub optional_dependencies: Option<HashMap<String, String>>,
    pub scripts: Option<HashMap<String, String>>,
    pub workspaces: Option<Value>,
}

Parsed package.json with fields relevant to fallow.

Fields

name: Option<String>

main: Option<String>

module: Option<String>

types: Option<String>

typings: Option<String>

source: Option<String>

browser: Option<Value>

bin: Option<Value>

exports: Option<Value>

dependencies: Option<HashMap<String, String>>

dev_dependencies: Option<HashMap<String, String>>

peer_dependencies: Option<HashMap<String, String>>

peer_dependencies_meta: Option<HashMap<String, PeerDependencyMeta>>

optional_dependencies: Option<HashMap<String, String>>

scripts: Option<HashMap<String, String>>

workspaces: Option<Value>

Implementations

impl PackageJson

pub fn load(path: &Path) -> Result<Self, String>

Load from a package.json file.

Errors

Returns an error string when the file cannot be read or parsed as JSON.

pub fn all_dependency_names(&self) -> Vec<String>

Get all dependency names (production + dev + peer + optional).

pub fn production_dependency_names(&self) -> Vec<String>

Get production dependency names only.

pub fn dev_dependency_names(&self) -> Vec<String>

Get dev dependency names only.

pub fn optional_dependency_names(&self) -> Vec<String>

Get optional dependency names only.

pub fn required_peer_dependency_names(&self) -> Vec<String>

Get required peer dependency names only.

pub fn entry_points(&self) -> Vec<String>

Extract entry points from package.json fields.

pub fn exports_subdirectories(&self) -> Vec<String>

Extract unique subdirectory names referenced by the exports field keys.

For exports like "./compat": { ... }, "./hooks/client": { ... }, this returns ["compat", "hooks"]. Used to discover sub-packages in projects that define their internal package structure via the exports map (e.g., preact with compat/, hooks/, debug/ sub-packages).

pub fn workspace_patterns(&self) -> Vec<String>

Extract workspace patterns from package.json.

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.

impl<'de> Deserialize<'de> for PackageJson

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PackageJson

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

where __S: Serializer,

Serialize this value into the given Serde serializer.