repo-trust 0.1.1

A command-line tool that tells you whether an open-source repository deserves your trust — beyond the star count.
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

use serde::{Deserialize, Serialize};
use time::OffsetDateTime;

use super::scores::ModuleWeights;
use crate::api::deps_dev::Client as DepsDevClient;
use crate::api::github::Client as GithubClient;
use crate::api::osv::Client as OsvClient;
use crate::api::scorecard::Client as ScorecardClient;
use crate::cli::scan::Mode as CliMode;
use crate::storage::Cache;

/// Public-facing repository summary in the report.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RepositorySummary {
    pub full_name: String,
    pub url: String,
    pub default_branch: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub primary_language: Option<String>,
    pub stars: u64,
    #[serde(with = "crate::utils::time::iso8601")]
    pub snapshot_at: OffsetDateTime,
}

/// Internal context shared across the run.
///
/// Not serialised — holds API clients, cache handles, etc. Cheap to clone;
/// every handle is `Arc`-internal. See ADR-0012 for the rationale on
/// carrying runtime handles directly on a `models` struct.
#[derive(Debug, Clone)]
pub struct RepositoryContext {
    pub full_name: String,
    pub canonical_url: url::Url,
    pub mode: CliMode,
    pub scoring_version: semver::Version,
    pub weights: ModuleWeights,
    pub rng_seed: u64,
    pub snapshot_at: OffsetDateTime,
    pub cache: Cache,
    pub github: GithubClient,
    pub scorecard: ScorecardClient,
    pub osv: OsvClient,
    /// Carries the deps.dev federated client that the Adoption Signals
    /// module consumes (per ADR-0012).
    pub deps_dev: DepsDevClient,
}

impl RepositoryContext {
    /// `(owner, repo)` split of `full_name`. Panics only if the constructor
    /// accepted an invalid identifier — call sites already normalize via
    /// `utils::repo_url::parse`.
    #[must_use]
    pub fn owner_repo(&self) -> (&str, &str) {
        self.full_name
            .split_once('/')
            .expect("full_name is owner/repo per utils::repo_url::parse")
    }
}