How to Fix Text Provider

The reporter.how-to-fix-text-provider.kts file enables the injection of how-to-fix texts in Markdown format for ORT issues into the reports.

You can use the example how-to-fix-text-provider as the base script file to create your custom how-to-fix messages in the generated reports.

Command Line

To use a *.how-to-fix-text-provider.kts file, put it to $ORT_CONFIG_DIR/reporter.how-to-fix-text-provider.kts or pass it via the --how-to-fix-text-provider-script option to the reporter:

cli/build/install/ort/bin/ort report
  -i [evaluator-output-dir]/evaluation-result.yml
  -o [reporter-output-dir]
  --report-formats StaticHtml,WebApp
  --how-to-fix-text-provider-script example.how-to-fix-text-provider.kts

Example

example.how-to-fix-text-provider.kts

object : HowToFixTextProvider {
    fun Issue.matchesMessage(pattern: String): Boolean = pattern.toRegex().matches(message)

    override fun getHowToFixText(issue: Issue): String? {
        // How-to-fix instruction Markdown for scan timeout errors.
        if (issue.matchesMessage("ERROR: Timeout after .* seconds while scanning file.*")) {
            return """
                | To fix this issue please proceed with the following steps:
                |
                |1. Manually verify that the file does not contain any license information.
                |2. File an error resolution in the resolutions file of your configuration directory with a comment
                |   stating that the file does not contain any license information.
                |   ```
                |
            """.trimIndent()
        }

        return null
    }
}