scarb 0.5.2

The Cairo package manager
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! `Scarb.toml` editor.

use std::str::FromStr;

use anyhow::{Context, Result};
use camino::Utf8Path;
use toml_edit::Document;

pub use add::AddDependency;
pub use dep_id::DepId;
pub use remove::RemoveDependency;

use crate::core::Config;
use crate::internal::fsx;
use crate::internal::fsx::PathBufUtf8Ext;

mod add;
mod dep_id;
mod remove;
mod tomlx;

pub trait Op {
    fn apply_to(self: Box<Self>, doc: &mut Document, ctx: OpCtx<'_>) -> Result<()>;
}

pub struct OpCtx<'c> {
    pub manifest_path: &'c Utf8Path,
    pub opts: &'c EditManifestOptions<'c>,
}

pub struct EditManifestOptions<'c> {
    pub config: &'c Config,
    pub dry_run: bool,
}

/// Edit manifest file (for example, add dependencies).
#[tracing::instrument(level = "trace", skip(ops, opts))]
pub fn edit(
    manifest_path: &Utf8Path,
    ops: Vec<Box<dyn Op>>,
    opts: EditManifestOptions<'_>,
) -> Result<()> {
    let manifest_path = fsx::canonicalize(manifest_path)?.try_into_utf8()?;

    let original_raw_manifest = fsx::read_to_string(&manifest_path)?;
    let mut doc = Document::from_str(&original_raw_manifest)
        .with_context(|| format!("failed to read manifest at `{manifest_path}`"))?;

    for op in ops {
        op.apply_to(
            &mut doc,
            OpCtx {
                manifest_path: &manifest_path,
                opts: &opts,
            },
        )?;
    }

    // TODO(#128): Sort dependencies and scripts etc.

    let new_raw_manifest = doc.to_string();
    if new_raw_manifest == original_raw_manifest {
        opts.config.ui().warn("no changes have to be made");
    } else if opts.dry_run {
        opts.config.ui().warn("aborting due to dry run");
    } else {
        fsx::write(manifest_path, new_raw_manifest.as_bytes())?;
    }

    Ok(())
}