recipes

package

v0.2.39 Latest Latest Go to latest Published: Oct 15, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/reforgeapp/reforge

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ForFinding(category, ecosystem string) []string
func GeneratedPath(file string) bool
func Images(toolchains map[string]string) map[string]string
type Archetype
- func Archetypes() []Archetype
- func Lookup(name string) (Archetype, bool)
type Budget
- func (b Budget) Clamp() Budget
type Command
type Recipe
- func Build(name string, files map[string][]byte) (Recipe, error)
- func BuildOwner(name string, files map[string][]byte) (Recipe, error)

Constants ¶

View Source

const (
	ProofTests      = "tests"
	ProofStructural = "structural"
	ProofProvider   = "provider"
)

View Source

const (
	CurrentVersion = "v3"
)

Variables ¶

View Source

var Ceiling = Budget{Files: 200, Lines: 50000, Bytes: 2 << 20, GeneratedBytes: 8 << 20, Turns: 120}

View Source

var ErrUnsupported = errors.New("repository requires an explicit supported validation recipe")

View Source

var Toolchains = []string{"go", "javascript", "python"}

Functions ¶

func ForFinding ¶

func ForFinding(category, ecosystem string) []string

func GeneratedPath ¶

func GeneratedPath(file string) bool

func Images ¶

func Images(toolchains map[string]string) map[string]string

Types ¶

type Archetype ¶

type Archetype struct {
	Name         string
	Toolchain    string
	MinProof     string
	ReadOnly     bool
	Validator    string
	Categories   []string
	Ecosystems   []string
	AllowedPaths []string
	Budget       Budget
}

func Archetypes ¶

func Archetypes() []Archetype

func Lookup ¶

func Lookup(name string) (Archetype, bool)

type Budget ¶

type Budget struct {
	Files, Lines, Bytes, GeneratedBytes, Turns int
}

func (Budget) Clamp ¶

func (b Budget) Clamp() Budget

type Command ¶

type Command struct {
	ID             string   `json:"id"`
	Args           []string `json:"args"`
	Directory      string   `json:"directory"`
	TimeoutSeconds int      `json:"timeout_seconds"`
	ReportFormat   string   `json:"report_format"`
}

type Recipe ¶

type Recipe struct {
	Name           string    `json:"name"`
	Version        string    `json:"version"`
	Commands       []Command `json:"commands"`
	ProtectedPaths []string  `json:"protected_paths"`
	ManifestPaths  []string  `json:"manifest_paths"`
	AllowedPaths   []string  `json:"allowed_paths,omitempty"`
	MinProof       string    `json:"min_proof,omitempty"`
	ReviewOnly     bool      `json:"review_only,omitempty"`
	ReadOnly       bool      `json:"read_only,omitempty"`
	MinimumTests   int       `json:"minimum_tests"`
	MaxFiles       int       `json:"max_files"`
	MaxPatchBytes  int       `json:"max_patch_bytes"`
	MaxGenerated   int       `json:"max_generated_bytes,omitempty"`
	MaxTurns       int       `json:"max_turns"`
	TimeoutSeconds int       `json:"timeout_seconds"`
}

func Build ¶

func Build(name string, files map[string][]byte) (Recipe, error)

func BuildOwner ¶

func BuildOwner(name string, files map[string][]byte) (Recipe, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL