plan

package

v2026.615.0 Latest Latest Go to latest Published: Jun 15, 2026 License: MIT Imports: 12 Imported by: 0

Details

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

Repository

github.com/SAPPHIR3-ROS3/Solomon

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AppendTodoLine(body string, text string) string
func ComputeStatus(total, checked int) string
func CountPending(plansDir string) (int, error)
func FormatTodoLine(text string, checked bool) string
func ReadFile(path string) (Meta, Sections, []byte, error)
func RemoveTodoLine(body string, sha string) (string, bool, error)
func ReplaceTodoChecked(body string, sha string) (string, bool, error)
func ResolvePath(plansDir, name string) (string, error)
func SkeletonBody(goal string) []byte
func StatusFromItems(items []TodoItem) string
func TodoSHA(text string) string
func WriteDocument(meta Meta, body []byte) ([]byte, error)
func WriteFile(path string, content []byte) error
type GitMeta
- func GitMetaFromRoot(projRoot string) GitMeta
type Meta
- func NewMeta(git GitMeta, status string) Meta
- func ParseDocument(b []byte) (Meta, []byte, error)
- func RefreshStatus(body []byte) ([]byte, Meta, error)
type Sections
- func ParseSections(body []byte) Sections
type TodoItem
- func OpenTodos(items []TodoItem) []TodoItem
- func ParseChecklist(lines []string) []TodoItem
type TodoSection

Constants ¶

View Source

const (
	StatusNotBuilt       = "not_built"
	StatusPartiallyBuilt = "partially_built"
	StatusBuilt          = "built"
)

Variables ¶

This section is empty.

Functions ¶

func AppendTodoLine ¶

func AppendTodoLine(body string, text string) string

func ComputeStatus ¶

func ComputeStatus(total, checked int) string

func CountPending ¶

func CountPending(plansDir string) (int, error)

func FormatTodoLine ¶

func FormatTodoLine(text string, checked bool) string

func ReadFile ¶

func ReadFile(path string) (Meta, Sections, []byte, error)

func RemoveTodoLine ¶

func RemoveTodoLine(body string, sha string) (string, bool, error)

func ReplaceTodoChecked ¶

func ReplaceTodoChecked(body string, sha string) (string, bool, error)

func ResolvePath ¶

func ResolvePath(plansDir, name string) (string, error)

func SkeletonBody ¶

func SkeletonBody(goal string) []byte

func StatusFromItems ¶

func StatusFromItems(items []TodoItem) string

func TodoSHA ¶

func TodoSHA(text string) string

func WriteDocument ¶

func WriteDocument(meta Meta, body []byte) ([]byte, error)

func WriteFile ¶

func WriteFile(path string, content []byte) error

Types ¶

type GitMeta ¶

type GitMeta struct {
	CommitHash   string
	LastCommitAt string
}

func GitMetaFromRoot ¶

func GitMetaFromRoot(projRoot string) GitMeta

type Meta ¶

type Meta struct {
	CreatedAt    string `yaml:"created_at"`
	CommitHash   string `yaml:"commit_hash"`
	LastCommitAt string `yaml:"last_commit_at"`
	Status       string `yaml:"status"`
}

func NewMeta ¶

func NewMeta(git GitMeta, status string) Meta

func ParseDocument ¶

func ParseDocument(b []byte) (Meta, []byte, error)

func RefreshStatus ¶

func RefreshStatus(body []byte) ([]byte, Meta, error)

type Sections ¶

type Sections struct {
	Goal    string
	Context string
	Design  string
	Todo    TodoSection
}

func ParseSections ¶

func ParseSections(body []byte) Sections

type TodoItem ¶

type TodoItem struct {
	SHA     string
	Text    string
	Checked bool
	Line    string
}

func OpenTodos ¶

func OpenTodos(items []TodoItem) []TodoItem

func ParseChecklist ¶

func ParseChecklist(lines []string) []TodoItem

type TodoSection ¶

type TodoSection struct {
	Rules     string
	Mermaid   string
	Checklist []TodoItem
	RawBody   string
}

Source Files ¶

View all Source files

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