documents

package

v0.2.1 Latest Latest Go to latest Published: Nov 25, 2024 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func IsValidUTF8File(filePath string) (bool, error)

Based on a sample of the file, checks if the file contains valid UTF-8 encoding.

type Document struct {
	// Relative path within the project directory.
	Path    string
	Content string
}

A Document represents a text file from the project directory, such as `README.md`, to be included in the context sent to the LLM.

func LoadDocuments(projectPath string, excludePatterns []string, maxFileSize int64) ([]Document, error)

Given the project path, loads documents that will be included in the context sent to the LLM.

It accepts additional .gitignore glob patterns for files to be excluded and respects any .gitignore files in the project directory.

It excludes files whose size exceeds the maxFileSize argument.