plan

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GroupMatch

type GroupMatch struct {
	Name  string   `json:"name"`
	Desc  string   `json:"desc,omitempty"`
	Tasks []string `json:"tasks"`
}

type GuardMatch

type GuardMatch struct {
	Name  string   `json:"name"`
	Steps []string `json:"steps"`
}

type Output

type Output struct {
	Files    []string              `json:"files"`
	Scopes   []ScopeMatch          `json:"scopes,omitempty"`
	Tasks    []TaskMatch           `json:"tasks,omitempty"`
	Groups   []GroupMatch          `json:"groups,omitempty"`
	Guards   []GuardMatch          `json:"guards,omitempty"`
	Packages []codemap.Explanation `json:"packages,omitempty"`
	Markdown string                `json:"markdown"`
}

func Generate

func Generate(cfg *config.Config, repoRoot string, files []string) (Output, error)

func GenerateFromGitDiff

func GenerateFromGitDiff(cfg *config.Config, repoRoot string) (Output, error)

type ScopeMatch

type ScopeMatch struct {
	Name  string   `json:"name"`
	Desc  string   `json:"desc,omitempty"`
	Paths []string `json:"paths"`
}

type TaskMatch

type TaskMatch struct {
	Name   string   `json:"name"`
	Desc   string   `json:"desc"`
	Type   string   `json:"type"`
	Scope  string   `json:"scope,omitempty"`
	Safety string   `json:"safety"`
	Needs  []string `json:"needs,omitempty"`
	Steps  []string `json:"steps,omitempty"`
	Groups []string `json:"groups,omitempty"`
}

Jump to

Keyboard shortcuts

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