-
Notifications
You must be signed in to change notification settings - Fork 308
/
Reporter.kt
55 lines (48 loc) · 1.99 KB
/
Reporter.kt
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
/*
* Copyright (C) 2017 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/
package org.ossreviewtoolkit.reporter
import java.io.File
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.config.PathExclude
import org.ossreviewtoolkit.model.config.ScopeExclude
import org.ossreviewtoolkit.utils.common.Plugin
import org.ossreviewtoolkit.utils.common.joinNonBlank
/**
* A reporter that creates a human-readable report from a given [OrtResult].
*/
interface Reporter : Plugin {
companion object {
/**
* All [reporters][Reporter] available in the classpath, associated by their names.
*/
val ALL by lazy { Plugin.getAll<Reporter>() }
}
/**
* Generate a report for the provided [input] and write the generated file(s) to the [outputDir]. If and how the
* [input] data is used depends on the specific reporter implementation, taking into account any format-specific
* [options]. The list of generated report files is returned.
*/
fun generateReport(
input: ReporterInput,
outputDir: File,
options: Map<String, String> = emptyMap()
): List<File>
}
internal val PathExclude.description: String get() = joinNonBlank(reason.toString(), comment)
internal val ScopeExclude.description: String get() = joinNonBlank(reason.toString(), comment)