provenant-cli 1.0.14

Fast Rust scanner for licenses, copyrights, package metadata, SBOMs, and provenance data.
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

// SPDX-FileCopyrightText: Provenant contributors
// SPDX-License-Identifier: Apache-2.0

//! Copyright detection module.
//!
//! Detects copyright statements, holder names, and author information
//! from source code files using a four-stage pipeline:
//! 1. Text preparation (normalization)
//! 2. Candidate line selection
//! 3. Lexing (POS tagging) and parsing (grammar rules)
//! 4. Refinement and junk filtering

use crate::cancel::CancelToken;
use std::time::Duration;

mod candidates;
mod credits;
mod detector;
mod detector_input_normalization;
pub mod golden_utils;
mod grammar;
mod hints;
mod lexer;
mod line_tracking;
mod parser;
mod patterns;
mod prepare;
mod refiner;
mod types;

pub use credits::{detect_credits_authors, is_credits_file};
pub(crate) use detector::is_pod_author_heading;
pub(crate) use prepare::prepare_text_line;
pub(crate) use refiner::has_copyright_year;
pub(crate) use refiner::looks_like_source_code;
pub(crate) use refiner::refine_author;
pub use refiner::refine_copyright;
pub use types::{AuthorDetection, CopyrightDetection, HolderDetection};

pub fn detect_copyrights(
    content: &str,
    max_runtime: Option<Duration>,
) -> (
    Vec<CopyrightDetection>,
    Vec<HolderDetection>,
    Vec<AuthorDetection>,
) {
    let token = max_runtime.map(CancelToken::with_timeout);
    detect_copyrights_with_cancel(content, token.as_ref())
}

/// Like [`detect_copyrights`], but stops early once `cancel` trips.
pub fn detect_copyrights_with_cancel(
    content: &str,
    cancel: Option<&CancelToken>,
) -> (
    Vec<CopyrightDetection>,
    Vec<HolderDetection>,
    Vec<AuthorDetection>,
) {
    detector::detect_copyrights_from_text_with_cancel(content, cancel)
}