Struct PackageJson 

pub struct PackageJson {

    pub name: Option<String>,
    pub private: Option<bool>,
    pub main: Option<String>,
    pub module: Option<String>,
    pub types: Option<String>,
    pub typings: Option<String>,
    pub source: Option<String>,
    pub files: Vec<String>,
    pub browser: Option<Value>,
    pub bin: Option<Value>,
    pub exports: Option<Value>,
    pub imports: 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 napi: Option<NapiConfig>,
    pub workspaces: Option<Value>,
    pub package_manager: Option<String>,
}

Parsed package.json with fields relevant to fallow.

Fields

name: Option<String>

The name field: the package’s npm name, used to identify workspace packages and match public_packages config entries.

private: Option<bool>

The private field. Non-boolean values become None rather than failing manifest parsing.

main: Option<String>

The main field: CommonJS entry-point path, seeded as an entry point.

module: Option<String>

The module field: ESM entry-point path, seeded as an entry point.

types: Option<String>

The types field: type-declaration entry-point path.

typings: Option<String>

The typings field: legacy spelling of types.

source: Option<String>

The source field: unbundled source entry point used by bundler-based packages (Parcel convention).

files: Vec<String>

The files field: publish allowlist patterns. Non-array values become empty rather than failing manifest parsing.

browser: Option<Value>

The browser field, kept raw because it is either a string entry point or a path-remap object.

bin: Option<Value>

The bin field, kept raw because it is either a string path or a name-to-path object; every referenced file is an entry point.

exports: Option<Value>

The exports field, kept raw because of its many shapes (string, conditions object, subpath map); referenced files are entry points and the map drives subpath resolution.

imports: Option<Value>

The imports field (#-prefixed internal subpath map), kept raw and consumed by the module resolver.

dependencies: Option<HashMap<String, String>>

The dependencies map (package name to version range), the base set for unused/unlisted-dependency accounting.

dev_dependencies: Option<HashMap<String, String>>

The devDependencies map, checked by unused-dev-dependencies and dev-dependency-in-production.

peer_dependencies: Option<HashMap<String, String>>

The peerDependencies map. Peers are provided by the consumer, so they are exempt from unused-dependency reporting.

peer_dependencies_meta: Option<HashMap<String, PeerDependencyMeta>>

The peerDependenciesMeta map, marking which peers are optional.

optional_dependencies: Option<HashMap<String, String>>

The optionalDependencies map, checked by unused-optional-dependencies.

scripts: Option<HashMap<String, String>>

The scripts map, scanned so packages invoked from scripts count as used tooling dependencies.

napi: Option<NapiConfig>

The NAPI-RS napi block; see NapiConfig. Non-object values become None rather than failing manifest parsing.

workspaces: Option<Value>

The workspaces field, kept raw because it is either a pattern array or an object with a packages array; drives workspace discovery.

package_manager: Option<String>

The packageManager field (e.g. "pnpm@9.1.0"), used to determine the canonical package manager for the project.

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.