coders

Documentation

Overview

Package coders provides interfaces and types for working with code editors.

Package coders provides command execution capabilities for the AI terminal. It handles commands like adding/removing files, asking questions, coding with AI, committing changes, and more.

Index

• Constants
• type AutoCoder
  • func NewAutoCoder(opts ...AutoCoderOption) *AutoCoder
  • func (a *AutoCoder) Run() error
• type AutoCoderOption
  • func WithCodeBasePath(path string) AutoCoderOption
  • func WithConfig(cfg *options.Config) AutoCoderOption
  • func WithEngine(engine *ai.Engine) AutoCoderOption
  • func WithLoadedContexts(contexts []*convo.LoadContext) AutoCoderOption
  • func WithPrompt(prompt string) AutoCoderOption
  • func WithRepo(repo *git.Command) AutoCoderOption
  • func WithStore(store convo.Store) AutoCoderOption
• type Coder
• type CoderContext
  • func NewCoderContext(cfg *options.Config) (*CoderContext, error)
• type CommandCompleter
  • func NewCommandCompleter(repo *git.Command) CommandCompleter
  • func (c CommandCompleter) Complete(d prompt.Document) []prompt.Suggest
• type CommandExecutor
  • func NewCommandExecutor(coder *AutoCoder) *CommandExecutor
  • func (c *CommandExecutor) Executor(input string)
• type EditBlockCoder
  • func NewEditBlockCoder(coder *AutoCoder, fence []string) *EditBlockCoder
  • func (e *EditBlockCoder) ApplyEdits(ctx context.Context, edits []PartialCodeBlock) error
  • func (e *EditBlockCoder) Execute(ctx context.Context, messages []llms.ChatMessage) error
  • func (e *EditBlockCoder) FormatMessages(values map[string]any) ([]llms.ChatMessage, error)
  • func (e *EditBlockCoder) GetEdits(_ context.Context) ([]PartialCodeBlock, error)
  • func (e *EditBlockCoder) GetModifiedFiles(ctx context.Context) ([]string, error)
  • func (e *EditBlockCoder) Name() string
  • func (e *EditBlockCoder) Prompt() prompts.ChatPromptTemplate
  • func (e *EditBlockCoder) UpdateCodeFences(_ context.Context, code string) (string, string)
• type PartialCodeBlock
  • func (p PartialCodeBlock) String() string
• type PromptMode
  • func GetPromptModeFromString(s string) PromptMode
  • func (m PromptMode) String() string

Constants

const (
	HEAD    = "<<<<<<< SEARCH"
	DIVIDER = "======="
	UPDATED = ">>>>>>> REPLACE"
)

const (
	FlagVerbose = "verbose"
)

Types

type AutoCoder

type AutoCoder struct {
	// contains filtered or unexported fields
}

func NewAutoCoder

func NewAutoCoder(opts ...AutoCoderOption) *AutoCoder

func (*AutoCoder) Run

func (a *AutoCoder) Run() error

type AutoCoderOption

type AutoCoderOption func(*AutoCoder)

func WithCodeBasePath

func WithCodeBasePath(path string) AutoCoderOption

func WithConfig

func WithConfig(cfg *options.Config) AutoCoderOption

func WithEngine

func WithEngine(engine *ai.Engine) AutoCoderOption

func WithLoadedContexts

func WithLoadedContexts(contexts []*convo.LoadContext) AutoCoderOption

func WithPrompt

func WithPrompt(prompt string) AutoCoderOption

func WithRepo

func WithRepo(repo *git.Command) AutoCoderOption

func WithStore

func WithStore(store convo.Store) AutoCoderOption

type Coder

type Coder interface {
	// Name returns the name of the code editor.
	Name() string
	// Prompt returns the prompt template used by the code editor.
	Prompt() prompts.ChatPromptTemplate
	// FormatMessages formats the messages with the provided values and returns the formatted messages.
	FormatMessages(values map[string]any) ([]llms.ChatMessage, error)
	// GetEdits retrieves the list of edits made to the code.
	GetEdits(ctx context.Context) ([]PartialCodeBlock, error)
	// GetModifiedFiles retrieves the list of files that have been modified.
	GetModifiedFiles(ctx context.Context) ([]string, error)
	// UpdateCodeFences updates the code fence for the given code.
	UpdateCodeFences(ctx context.Context, code string) (string, string)
	// ApplyEdits applies the given list of edits to the code.
	ApplyEdits(ctx context.Context, edits []PartialCodeBlock) error
	// Execute runs the code editor with the specified input messages.
	Execute(ctx context.Context, messages []llms.ChatMessage) error
}

Coder defines the interface for a code editor.

type CoderContext

type CoderContext struct {
	context.Context
	// contains filtered or unexported fields
}

func NewCoderContext

func NewCoderContext(cfg *options.Config) (*CoderContext, error)

type CommandCompleter

type CommandCompleter struct {
	// contains filtered or unexported fields
}

func NewCommandCompleter

func NewCommandCompleter(repo *git.Command) CommandCompleter

func (CommandCompleter) Complete

func (c CommandCompleter) Complete(d prompt.Document) []prompt.Suggest

type CommandExecutor

type CommandExecutor struct {
	// contains filtered or unexported fields
}

func NewCommandExecutor

func NewCommandExecutor(coder *AutoCoder) *CommandExecutor

func (*CommandExecutor) Executor

func (c *CommandExecutor) Executor(input string)

Executor handles command execution. It parses the input, validates the command, and executes the corresponding handler function.

type EditBlockCoder

type EditBlockCoder struct {
	// contains filtered or unexported fields
}

func NewEditBlockCoder

func NewEditBlockCoder(coder *AutoCoder, fence []string) *EditBlockCoder

func (*EditBlockCoder) ApplyEdits

func (e *EditBlockCoder) ApplyEdits(ctx context.Context, edits []PartialCodeBlock) error

func (*EditBlockCoder) Execute

func (e *EditBlockCoder) Execute(ctx context.Context, messages []llms.ChatMessage) error

func (*EditBlockCoder) FormatMessages

func (e *EditBlockCoder) FormatMessages(values map[string]any) ([]llms.ChatMessage, error)

func (*EditBlockCoder) GetEdits

func (e *EditBlockCoder) GetEdits(_ context.Context) ([]PartialCodeBlock, error)

func (*EditBlockCoder) GetModifiedFiles

func (e *EditBlockCoder) GetModifiedFiles(ctx context.Context) ([]string, error)

func (*EditBlockCoder) Name

func (e *EditBlockCoder) Name() string

func (*EditBlockCoder) Prompt

func (e *EditBlockCoder) Prompt() prompts.ChatPromptTemplate

func (*EditBlockCoder) UpdateCodeFences

func (e *EditBlockCoder) UpdateCodeFences(_ context.Context, code string) (string, string)

type PartialCodeBlock

type PartialCodeBlock struct {
	// Path is the file path of the code block.
	Path string
	// OriginalText is the original text of the code block.
	OriginalText string
	// UpdatedText is the updated text of the code block.
	UpdatedText string
}

PartialCodeBlock represents a partial code block with its file path and original and updated text.

func (PartialCodeBlock) String

func (p PartialCodeBlock) String() string

type PromptMode

type PromptMode int

PromptMode represents the mode of the prompt.

const (
	ExecPromptMode    PromptMode = iota // ExecPromptMode represents the execution mode.
	ChatPromptMode                      // ChatPromptMode represents the chat mode.
	DefaultPromptMode                   // DefaultPromptMode represents the default mode.
)

Constants representing different prompt modes.

func GetPromptModeFromString

func GetPromptModeFromString(s string) PromptMode

GetPromptModeFromString returns the PromptMode corresponding to the given string.

func (PromptMode) String

func (m PromptMode) String() string

String returns the string representation of the PromptMode.