Embabel Agent Documentation/com.embabel.agent.domain.library.code/SoftwareProject

SoftwareProject

open class SoftwareProject constructor(val root: String, val url: String? = null, val tech: String = "Java,Embabel,Spring Boot,Maven", val defaultCodingStyle: String = """ No coding style guide found at ${DEFAULT_CODING_STYLE_GUIDE}. Try to follow the conventions of files you read in the project. """.trimIndent(), val buildCommand: String = "mvn clean test", val wasCreated: Boolean = false) : LlmReference, FileTools, SymbolSearch, FileChangeLog, FileReadLog

Open to allow extension

Constructors

SoftwareProject

constructor(root: String, url: String? = null, tech: String = "Java,Embabel,Spring Boot,Maven", defaultCodingStyle: String = """ No coding style guide found at ${DEFAULT_CODING_STYLE_GUIDE}. Try to follow the conventions of files you read in the project. """.trimIndent(), buildCommand: String = "mvn clean test", wasCreated: Boolean = false)

Types

Companion

object Companion

Properties

buildCommand

val buildCommand: String

val ci: Ci

codingStyle

val codingStyle: String

defaultCodingStyle

val defaultCodingStyle: String

description

open val description: String

fileContentTransformers

open override val fileContentTransformers: List<StringTransformer>

Provide sanitizers that run on file content before returning it. They must be sure not to change any content that may need to be replaced as this will break editing if editing is done in the same session.

name

open val name: <Error class: unknown class>

root

open override val root: String

Root on host machine

tech

val tech: String

toolCallbacks

open override val toolCallbacks: List<<Error class: unknown class>>

Tool callbacks referenced or exposed.

url

val url: String? = null

wasCreated

val wasCreated: Boolean = false

Functions

appendFile

open fun appendFile(path: String, content: String): String

appendToFile

open fun appendToFile(path: String, content: String, createIfNotExists: Boolean)

Append content to a file, creating it if it doesn't exist. If create is true, the file will be created if it doesn't exist. If createIfNotExists is false, an exception will be thrown if the file doesn't exist.

asInterface

fun <T> ToolCallbackPublisher.asInterface(intf: Class<T>): T

Expose the ToolGroup as an interface

build

fun build(): BuildResult

fun build(command: String): String

classPattern

open fun classPattern(className: String): <Error class: unknown class>

contribution

open fun contribution(): String

createDirectory

open fun createDirectory(path: String): String

createFile

open fun createFile(path: String, content: String): String

Create a file at the relative path under the root

open fun createFile(path: String, content: String, overwrite: Boolean): Path

Create a file with the given content.

delete

open fun delete(path: String): String

editFile

open fun editFile(path: String, oldContent: String, newContent: String): String

exists

open fun exists(): Boolean

Does this file exist?

fileCount

open fun fileCount(): Int

Count the total number of files in the repository (excluding .git directory). Uses FileVisitor for cross-platform compatibility (Windows and Linux).

findClass

fun findClass(name: String): String

findClassInProject

open fun findClassInProject(className: String, globPattern: String = "**/*.{kt,java}", useParallelSearch: Boolean = true): List<PatternSearch.PatternMatch>

findFiles

open fun findFiles(glob: String): List<String>

open fun findFiles(glob: String, findHighest: Boolean): List<String>

Find files using glob patterns.

findPattern

fun findPattern(regex: String, globPattern: String): String

findPatternInProject

open fun findPatternInProject(pattern: String, globPattern: String): String

open fun findPatternInProject(pattern: <Error class: unknown class>, globPattern: String, useParallelSearch: Boolean = true): List<PatternSearch.PatternMatch>

Finds files containing the specified pattern using glob patterns

flushChanges

open override fun flushChanges()

flushReads

open override fun flushReads()

getChanges

open override fun getChanges(): List<FileModification>

getPathsAccessed

open override fun getPathsAccessed(): List<String>

getPathsRead

open override fun getPathsRead(): List<String>

getReads

open override fun getReads(): List<FileReads>

listFiles

open fun listFiles(path: String): List<String>

matchesGlob

open fun matchesGlob(path: String, globPattern: String): Boolean

Checks if a file path matches a glob pattern

notes

open override fun notes(): <Error class: unknown class>

Notes about this reference, such as usage guidance. Does not need to consider prompt prefix, name or description as they will be added automatically.

readFile

open fun readFile(path: String): String

recordChange

open override fun recordChange(c: FileModification)

recordRead

open override fun recordRead(path: String)

resolveAndValidateFile

open fun resolveAndValidateFile(path: String): Path

resolvePath

open fun resolvePath(path: String): Path

safeReadFile

open fun safeReadFile(path: String): String?

Use for safe reading of files. Returns null if the file doesn't exist or is not readable.

toolObject

open fun toolObject(): ToolObject

Create a tool object for this reference.

toolPrefix

open fun toolPrefix(): String

A safe prefix for LLM tools associated with this reference. Defaults to the name lowercased with spaces replaced by underscores. Subclasses can override it

toString

open override fun toString(): String