provenant-cli 0.0.33

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

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

//! # Provenant
//!
//! `provenant` is the library crate behind the `provenant` CLI. It
//! provides ScanCode-compatible scanning, package parsing, and output-writing
//! building blocks for Rust applications.
//!
//! The main entry points are:
//!
//! - [`collect_paths`] to discover files in a directory tree
//! - [`process_collected`] to scan collected files in parallel
//! - [`OutputFormat`], [`OutputWriter`], and [`write_output_file`] to serialize scan results
//! - [`parsers`] and [`models`] for lower-level package parsing and result inspection
//!
//! High-level crate organization:
//!
//! - [`scanner`] orchestrates traversal, filtering, and scan execution
//! - [`license_detection`] extracts license information from files
//! - [`parsers`] extracts package metadata from ecosystem-specific inputs
//! - [`copyright`] and [`finder`] extract text clues such as copyrights, emails, and URLs
//! - [`output`] renders ScanCode-compatible and SBOM-oriented output formats
//! - [`models`] defines the core scan result data structures
//!
//! User-facing installation, CLI usage, supported format coverage, and broader
//! architecture notes live in the repository documentation. The crate-level
//! rustdoc stays intentionally concise so fast-changing project details have a
//! single source of truth outside this file.

extern crate self as provenance;

pub mod assembly;
pub mod cache;
pub mod cli;
pub(crate) mod compare;
pub mod copyright;
pub mod finder;
pub mod golden_maintenance;
pub mod license_detection;
pub mod models;
pub mod output;
pub mod output_schema;
pub mod parsers;
#[cfg(feature = "golden-tests")]
pub mod post_processing;
#[cfg(not(feature = "golden-tests"))]
pub(crate) mod post_processing;
pub mod progress;
pub(crate) mod scan_result_shaping;
pub mod scanner;
#[cfg(test)]
pub(crate) mod test_support;
pub(crate) mod time;
pub mod utils;
pub mod version;

pub use models::{ExtraData, FileInfo, FileType, Header, Output, SystemEnvironment};
pub use output::{
    OutputFormat, OutputWriteConfig, OutputWriter, write_output_file, writer_for_format,
};
pub use parsers::{NpmParser, PackageParser};
pub use progress::{ProgressMode, ScanProgress};
pub use scanner::{
    CollectedPaths, ProcessResult, TextDetectionOptions, collect_paths, process_collected,
};