common/tools.samt.common

Package-level declarations

Types

DiagnosticAnnotation

interface DiagnosticAnnotation

DiagnosticAnnotationHelp

class DiagnosticAnnotationHelp(val message: String) : DiagnosticAnnotation

DiagnosticAnnotationInformation

class DiagnosticAnnotationInformation(val message: String) : DiagnosticAnnotation

DiagnosticContext

class DiagnosticContext(val source: SourceFile)

DiagnosticController

class DiagnosticController(val workingDirectory: URI)

DiagnosticException

class DiagnosticException(message: DiagnosticMessage) : RuntimeException

DiagnosticGlobalMessage

data class DiagnosticGlobalMessage(val severity: DiagnosticSeverity, val message: String)

DiagnosticHighlight

data class DiagnosticHighlight(val message: String?, val location: Location, val changeSuggestion: String?, val highlightBeginningOnly: Boolean)

DiagnosticMessage

data class DiagnosticMessage(val severity: DiagnosticSeverity, val message: String, val highlights: List<DiagnosticHighlight>, val annotations: List<DiagnosticAnnotation>)

DiagnosticMessageBuilder

class DiagnosticMessageBuilder(severity: DiagnosticSeverity)

DiagnosticSeverity

enum DiagnosticSeverity : Enum<DiagnosticSeverity>

FileOffset

data class FileOffset(val charIndex: Int, val row: Int, val col: Int)

row and column information are 0-indexed.

Location

data class Location(val source: SourceFile, val start: FileOffset, val end: FileOffset)

start and end file offsets of a location. file offset in start is inclusive file offset in end is exclusive.

NamingConventionsConfiguration

SamtConfiguration

data class SamtConfiguration(val source: Path, val plugins: List<SamtPluginConfiguration>, val generators: List<SamtGeneratorConfiguration>)

SamtGeneratorConfiguration

data class SamtGeneratorConfiguration(val name: String, val output: Path, val options: Map<String, String>)

SamtLinterConfiguration

data class SamtLinterConfiguration(val splitModelAndProviders: SplitModelAndProvidersConfiguration, val namingConventions: NamingConventionsConfiguration)

SamtLocalPluginConfiguration

data class SamtLocalPluginConfiguration(val path: Path) : SamtPluginConfiguration

SamtMavenPluginConfiguration

data class SamtMavenPluginConfiguration(val groupId: String, val artifactId: String, val version: String, val repository: String) : SamtPluginConfiguration

SamtPluginConfiguration

interface SamtPluginConfiguration

SamtRuleConfiguration

interface SamtRuleConfiguration

SourceFile

data class SourceFile(val path: URI, val content: String)

SplitModelAndProvidersConfiguration

data class SplitModelAndProvidersConfiguration(val level: DiagnosticSeverity?) : SamtRuleConfiguration

Functions

collectSamtFiles

fun collectSamtFiles(directory: URI): List<File>

readSamtSource

fun List<File>.readSamtSource(controller: DiagnosticController): List<SourceFile>