provenant-cli 1.0.0

Fast Rust scanner for licenses, copyrights, 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

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

//! Field metadata for file-level evidence surfaces (authors, copyrights, emails, holders, URLs).

use super::OutputFieldDoc;

pub(super) const AUTHOR_FIELDS: &[OutputFieldDoc] = &[
    OutputFieldDoc {
        json_name: "author",
        rust_field: "author",
        value_shape: "string",
        presence: "Always emitted.",
        meaning: "Extracted author string.",
    },
    OutputFieldDoc {
        json_name: "start_line",
        rust_field: "start_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "First line where the author evidence appeared.",
    },
    OutputFieldDoc {
        json_name: "end_line",
        rust_field: "end_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "Last line where the author evidence appeared.",
    },
];

pub(super) const COPYRIGHT_FIELDS: &[OutputFieldDoc] = &[
    OutputFieldDoc {
        json_name: "copyright",
        rust_field: "copyright",
        value_shape: "string",
        presence: "Always emitted.",
        meaning: "Rendered copyright string, using native or ScanCode compatibility mode as selected.",
    },
    OutputFieldDoc {
        json_name: "start_line",
        rust_field: "start_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "First line where the copyright evidence appeared.",
    },
    OutputFieldDoc {
        json_name: "end_line",
        rust_field: "end_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "Last line where the copyright evidence appeared.",
    },
];

pub(super) const EMAIL_FIELDS: &[OutputFieldDoc] = &[
    OutputFieldDoc {
        json_name: "email",
        rust_field: "email",
        value_shape: "string",
        presence: "Always emitted.",
        meaning: "Extracted email address.",
    },
    OutputFieldDoc {
        json_name: "start_line",
        rust_field: "start_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "First line where the email evidence appeared.",
    },
    OutputFieldDoc {
        json_name: "end_line",
        rust_field: "end_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "Last line where the email evidence appeared.",
    },
];

pub(super) const HOLDER_FIELDS: &[OutputFieldDoc] = &[
    OutputFieldDoc {
        json_name: "holder",
        rust_field: "holder",
        value_shape: "string",
        presence: "Always emitted.",
        meaning: "Extracted copyright holder string.",
    },
    OutputFieldDoc {
        json_name: "start_line",
        rust_field: "start_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "First line where the holder evidence appeared.",
    },
    OutputFieldDoc {
        json_name: "end_line",
        rust_field: "end_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "Last line where the holder evidence appeared.",
    },
];

pub(super) const URL_FIELDS: &[OutputFieldDoc] = &[
    OutputFieldDoc {
        json_name: "url",
        rust_field: "url",
        value_shape: "string",
        presence: "Always emitted.",
        meaning: "Extracted URL string.",
    },
    OutputFieldDoc {
        json_name: "start_line",
        rust_field: "start_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "First line where the URL evidence appeared.",
    },
    OutputFieldDoc {
        json_name: "end_line",
        rust_field: "end_line",
        value_shape: "integer",
        presence: "Always emitted.",
        meaning: "Last line where the URL evidence appeared.",
    },
];