stig-gradle-plugin/com.stigway.gradle.config

Package-level declarations

Types

Canonical path-builder for the stig-code-analyzer pipeline.

data class StigProjectConfigContext(val defaults: StigProjectDefaults, val reposByName: Map<String, StigSourceProfileConfig>, val groupsByName: Map<String, StigGroupConfig>, val basePackagePrefix: String, val sourceCodeAnalysis: SourceCodeAnalysisConfig, val generateHtml: GenerateHtmlConfig, val publish: PublishConfig, val review: ReviewConfig = ReviewConfig(), val bitcodeTransformRegistry: BitcodeTransformRegistryConfig = BitcodeTransformRegistryConfig(), val settingsDir: File, val groupAnalyzerExecutionDsls: Map<String, AnalyzerExecutionDsl> = emptyMap(), val defaultsAnalyzerExecutionDsl: AnalyzerExecutionDsl? = null, val groupAnalyzerInputDsls: Map<String, AnalyzerInputDsl> = emptyMap(), val defaultsAnalyzerInputDsl: AnalyzerInputDsl? = null, val repoBazelBuildDsls: Map<String, BazelBuildDsl> = emptyMap(), val groupBazelBuildDsls: Map<String, BazelBuildDsl> = emptyMap(), val defaultsBazelBuildDsl: BazelBuildDsl? = null, val groupSourceCodeSelectionConfigs: Map<String, SourceCodeSelectionConfig> = emptyMap(), val defaultsSourceCodeSelectionConfig: SourceCodeSelectionConfig? = null, val groupComplexityMetricsConfigs: Map<String, ComplexityMetricsConfig> = emptyMap(), val defaultsComplexityMetricsConfig: ComplexityMetricsConfig? = null, val groupFunctionDescriptionsConfigs: Map<String, FunctionDescriptionsConfig> = emptyMap(), val defaultsFunctionDescriptionsConfig: FunctionDescriptionsConfig? = null, val groupDiagramOutputDsls: Map<String, DiagramOutputFormatsDsl> = emptyMap(), val defaultsDiagramOutputsDsl: DiagramOutputFormatsDsl? = null)

Project-wide STIG configuration resolved from the root project's stigProject { ... } block. Used by per-module com.stigway.gradle.plugin.StigPlugin to merge with per-module element configs.

StigRepoBuildProvenance

data class StigRepoBuildProvenance(val name: String, val root: File, val branch: String, val commitMode: String, val remoteUrl: String, val remotePath: String, val commit: String, val codeBrowser: CodeBrowser = CodeBrowser.AUTO, val editRef: String = "", val reviewUrl: String = "", val reviewLabel: String = "")

StigRepoLocationContext

data class StigRepoLocationContext(val repoRootDirs: List<File>, val resolvedPublishSourceRepos: String, val dokkaRepoInfos: List<GitRepoInfo>, val buildProvenanceRepos: List<StigRepoBuildProvenance>)

Resolved repository locations for Dokka source links and documentation publishing. Derived from the configured repos in stigProject { repo(...) { ... } }.

StigTargetModule

data class StigTargetModule(val project: Project, val moduleDirRel: String, val extension: StigExtension)

Resolved target module for a STIG pipeline task. Returned by resolveStigSingleModule.

Functions

applyProxySettings

fun DokkaExtension.applyProxySettings()

dokkaAggregateImagesPrefix

fun dokkaAggregateImagesPrefix(dokkaModuleName: String): String

Relative prefix from a package-level HTML page to the Dokka images/ directory in the aggregate layout. Use this in <img src="..."> attributes written into markdown that Dokka will render as part of the aggregate site.

dokkaAggregateModuleImagesPrefix

fun dokkaAggregateModuleImagesPrefix(dokkaModuleName: String): String

Relative prefix from an aggregate module landing page to the shared images/ directory.

dokkaAggregatePackageDepth

fun dokkaAggregatePackageDepth(dokkaModuleName: String): Int

Number of directory levels from the Dokka HTML root (build/dokka/html/) to a package-level page rendered by Dokka's aggregate HTML publication.

dokkaModulePreviewImagesPrefix

fun dokkaModulePreviewImagesPrefix(): String

Relative prefix from a package-level HTML page to the Dokka images/ directory in the module-preview layout (build/dokka/module-preview/).

dokkaModulePreviewModuleImagesPrefix

fun dokkaModulePreviewModuleImagesPrefix(): String

Relative prefix from the standalone module-preview root page to the shared images/ directory.

dokkaProxySystemProperties

fun dokkaProxySystemProperties(): Map<String, Any>

elementBaseDir

fun Project.elementBaseDir(): Directory?

Returns the element's base directory for this project.

isBazelLabel

fun isBazelLabel(path: String): Boolean

isStigSubdirPlacementProject

fun Project.isStigSubdirPlacementProject(): Boolean

moduleDirRel

fun Project.moduleDirRel(): String

Returns the module's directory path relative to the root project, normalized with forward slashes. Used as the basis for pipeline context IDs and relative path computations.

normalizeElementPath

fun normalizeElementPath(raw: String): String

parseBooleanFlag

fun parseBooleanFlag(raw: String): Boolean

parseEnumPropertyValue

fun <T : Enum<T>> parseEnumPropertyValue(raw: String, enumClass: Class<T>, propertyName: String): T

readStigElementsFromSettings

fun Project.readStigElementsFromSettings(): List<StigConfiguredElement>

readStigProjectConfigContext

fun Project.readStigProjectConfigContext(): StigProjectConfigContext?

Reads the StigProjectConfigContext from the root project's StigProjectExtension. Returns null when the root project does not have the extension.

resolveElementSelectorValue

fun Project.resolveElementSelectorValue(elementOverride: String?, implementationDirOverride: String? = null): String

resolveElementSpecs

fun resolveElementSpecs(rootProject: Project, configuredElements: List<StigConfiguredElement>): List<StigElementSpec>

resolvePlacementEnum

fun resolvePlacementEnum(placementName: String): Any

resolveStigRepoLocationContext

fun Project.resolveStigRepoLocationContext(configContext: StigProjectConfigContext?): StigRepoLocationContext

Resolves StigRepoLocationContext from the DSL-configured repos in StigProjectConfigContext. Falls back to the root project directory when no repos are configured.

resolveStigSingleModule

fun resolveStigSingleModule(modules: List<String>, rootProject: Project): StigTargetModule

Resolves a single-element modules: ListProperty<String> input to a StigTargetModule.

safeElementId

fun safeElementId(raw: String?): String

Derives a deterministic pipeline element slug from the selected element path/label. The result is a unique, filesystem-safe key (not a full path), used under build/stig/pipeline/<elementId>/....

sanitizeStigContextId

fun sanitizeStigContextId(value: String): String

setPlacementProperty

fun setPlacementProperty(prop: Property<*>, placementName: String)

splitArgs

fun splitArgs(raw: String): List<String>

stigAuthoredSourceRoots

fun Project.stigAuthoredSourceRoots(): List<File>

stigDocsDir

fun Project.stigDocsDir(): Provider<Directory?>?

stigDocsDirName

fun Project.stigDocsDirName(): String

stigDokkaModuleName

fun Project.stigDokkaModuleName(): String

Dotted Dokka module name derived from the Gradle subproject path: :activities:aeb:X → activities.aeb.X. Falls back to the project's leaf name when the subproject path is the root.

stigDokkaSourceRoots

fun Project.stigDokkaSourceRoots(): List<File>

stigGeneratedDocsAssets

fun Project.stigGeneratedDocsAssets(): FileTree

Returns the per-module Dokka asset tree: every .dot, .cyjson, .cyjson.gz, .sigma.json, .svg, source-browser manifest/shards, compressed model-check table JSON, and diagram pruning JSON files under the module's build/docs/ and build/stig/docs/ directories (recursive). Used by the root Dokka site to pick up STIG-generated diagrams from each subproject so they land in the publication's flat images/ directory.

taskOutputDir

fun Project.taskOutputDir(task: String, dirName: String = ""): Provider<Directory?>?

Returns the canonical output directory location for a pipeline task.

taskOutputFile

fun Project.taskOutputFile(task: String, fileName: String): Provider<RegularFile?>?

Returns the canonical output file location for a pipeline task.