Struct PackageJson

Source

pub struct PackageJson { /* private fields */ }

Expand description

Partial practical package.json metadata.

Implementations§

Source §

impl PackageJson

Source

pub fn new() -> Self

Creates empty package metadata.

Examples found in repository ?

examples/basic_usage.rs (line 7)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub fn with_name(self, name: PackageName) -> Self

Sets the package name.

Examples found in repository ?

examples/basic_usage.rs (line 8)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub fn with_version(self, version: PackageVersion) -> Self

Sets the package version.

Examples found in repository ?

examples/basic_usage.rs (line 9)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub const fn with_package_type(self, package_type: PackageType) -> Self

Sets the package type.

Examples found in repository ?

examples/basic_usage.rs (line 10)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub fn with_script(self, name: PackageScriptName, script: PackageScript) -> Self

Adds a script entry.

Examples found in repository ?

examples/basic_usage.rs (lines 11-14)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub fn with_dependency( self, kind: DependencyKind, name: PackageName, version: PackageVersion, ) -> Self

Adds a dependency entry under a dependency kind.

Examples found in repository ?

examples/basic_usage.rs (lines 15-19)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}

Source

pub const fn name(&self) -> Option<&PackageName>

Returns the optional package name.

Examples found in repository ?

examples/basic_usage.rs (line 21)

6fn main() -> Result<(), use_package_json::PackageJsonTextError> {
7    let manifest = PackageJson::new()
8        .with_name(PackageName::new("@rustuse/example")?)
9        .with_version(PackageVersion::new("0.1.0")?)
10        .with_package_type(PackageType::Module)
11        .with_script(
12            PackageScriptName::new("test")?,
13            PackageScript::new("vitest")?,
14        )
15        .with_dependency(
16            DependencyKind::Dependencies,
17            PackageName::new("react")?,
18            PackageVersion::new("^18")?,
19        );
20
21    assert!(manifest.name().is_some_and(PackageName::is_scoped));
22    Ok(())
23}