stig-engine/com.stigway.engine.commands.initelement/InitElementRequest

InitElementRequest

data class InitElementRequest(val projectRoot: Path, val userRepoRoot: Path? = null, val elementDir: Path, val gradlePath: String? = null, val importEnabled: Boolean? = null, val createBuildFile: Boolean = true, val placement: ViewpointsPlacement = ViewpointsPlacement.STIG_SUBDIR, val basePackage: String? = null, val viewpoints: List<Viewpoint> = Viewpoint.entries, val mode: WriteMode = WriteMode.OVERWRITE, val createTemplates: Boolean = true, val templateMode: TemplateMode = TemplateMode.SKELETON, val elementType: String = "Component", val asil: ASIL? = null, val sourceCodeAnalysis: InitSourceCodeAnalysisConfiguration = InitSourceCodeAnalysisConfiguration.DISABLED, val dryRun: Boolean = false, val group: String? = null, val typedElementsConfigPath: String? = null, val elementName: String? = null)

Constructors

InitElementRequest

constructor(projectRoot: Path, userRepoRoot: Path? = null, elementDir: Path, gradlePath: String? = null, importEnabled: Boolean? = null, createBuildFile: Boolean = true, placement: ViewpointsPlacement = ViewpointsPlacement.STIG_SUBDIR, basePackage: String? = null, viewpoints: List<Viewpoint> = Viewpoint.entries, mode: WriteMode = WriteMode.OVERWRITE, createTemplates: Boolean = true, templateMode: TemplateMode = TemplateMode.SKELETON, elementType: String = "Component", asil: ASIL? = null, sourceCodeAnalysis: InitSourceCodeAnalysisConfiguration = InitSourceCodeAnalysisConfiguration.DISABLED, dryRun: Boolean = false, group: String? = null, typedElementsConfigPath: String? = null, elementName: String? = null)

Properties

asil

val asil: ASIL?

Optional explicit ASIL written to the generated element configuration.

basePackage

val basePackage: String?

createBuildFile

val createBuildFile: Boolean

createTemplates

val createTemplates: Boolean

dryRun

val dryRun: Boolean

Preview all write decisions without changing settings, creating directories, or writing files.

elementDir

val elementDir: Path

elementName

val elementName: String?

Explicit canonical Kotlin type name when it differs from the directory leaf.

elementType

val elementType: String

gradlePath

val gradlePath: String?

group

val group: String?

Explicit group name for the generated build.gradle.kts. When non-null/non-blank, used directly in group = groups["<value>"]. When null/blank, the generated file contains a commented your_group placeholder and inherits project defaults.

importEnabled

val importEnabled: Boolean?

mode

val mode: WriteMode

placement

val placement: ViewpointsPlacement

projectRoot

val projectRoot: Path

sourceCodeAnalysis

val sourceCodeAnalysis: InitSourceCodeAnalysisConfiguration

Whether the generated module inherits source-code-analysis settings or starts with every source-code-analysis kind explicitly disabled. A disabled scaffold can generate its model report before native-analysis inputs exist.

templateMode

val templateMode: TemplateMode

typedElementsConfigPath

val typedElementsConfigPath: String?

Repository-relative settings file containing the managed // STIG: end-includes marker. The legacy property name is retained for API compatibility. When null, defaults to settings.gradle.kts.

userRepoRoot

val userRepoRoot: Path?

viewpoints

val viewpoints: List<Viewpoint>