stig-gradle-plugin/com.stigway.gradle.support/StigSourceActions

StigSourceActions

Shared resolution and HTML rendering for source actions in Dokka model and report content.

Types

data class Action(val kind: StigSourceActions.Kind, val url: String, val label: String, val icon: StigIcon, val newTab: Boolean)

Kind

enum Kind : Enum<StigSourceActions.Kind>

RepositoryTarget

enum RepositoryTarget : Enum<StigSourceActions.RepositoryTarget>

Settings

data class Settings(val view: Boolean, val edit: Boolean, val idea: Boolean)

Functions

locationHtml

fun locationHtml(label: String, actions: List<StigSourceActions.Action>, codeLabel: Boolean = false): String

resolve

fun resolve(absoluteFile: String?, relativePath: String?, fileLine: Int, contexts: List<CodeBrowserUrl.Context>, settings: StigSourceActions.Settings): List<StigSourceActions.Action>

resolveRepositoryTarget

fun resolveRepositoryTarget(context: CodeBrowserUrl.Context, target: StigSourceActions.RepositoryTarget, settings: StigSourceActions.Settings): List<StigSourceActions.Action>

Resolves the meaningful source action for a repository-level provenance target. Repository and commit pages can be viewed, but do not identify a source file that could be edited or opened in IDEA, so edit and IDEA actions are intentionally absent.

toHtml

fun toHtml(actions: List<StigSourceActions.Action>): String