Struct PackageJson 

pub struct PackageJson {
    pub path: InternedPath,
    pub realpath: PathBuf,
    pub name: Option<String>,
    pub type: Option<ModuleType>,
    pub side_effects: Option<SideEffects>,
    /* private fields */
}

Deserialized package.json

Fields

path: InternedPath

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

Stored interned: dependency tracking registers the file on every resolution that walks through its directory, so a handle turns that into a refcount bump instead of a rehash and re-intern.

realpath: PathBuf

Realpath to package.json. Contains the package.json filename.

name: Option<String>

The “name” field defines your package’s name. The “name” field can be used in addition to the “exports” field to self-reference a package using its name.

https://nodejs.org/api/packages.html#name

type: Option<ModuleType>

The “type” field.

https://nodejs.org/api/packages.html#type

side_effects: Option<SideEffects>

The “sideEffects” field.

https://webpack.js.org/guides/tree-shaking

Implementations

impl PackageJson

pub fn raw_json(&self) -> &Arc<Value>

Available on crate feature package_json_raw_json_api only.

Raw serde json value of package.json.

This is currently used in Rspack for:

• getting the sideEffects field
• query in https://www.rspack.dev/config/module.html#ruledescriptiondata - search on GitHub indicates query on the type field.

To reduce overall memory consumption, large fields that useless for pragmatic use are removed. They are: description, keywords, scripts, dependencies and devDependencies, peerDependencies, optionalDependencies.

pub fn directory(&self) -> &Path

Directory to package.json

Panics

• When the package.json path is misconfigured.

Trait Implementations

impl Debug for PackageJson

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

Formats the value using the given formatter.