format

Documentation

Overview

Package format defines closed vocabulary for artifact format_profile and layout grouping hints.

Index

• Constants
• func FromFrontmatterTool(values ...string) string
• func FromPath(relPath string) string
• func LayoutGroup(relPath string) string
• func Normalize(s string) string

Constants

const (
	ProfileGeneric    = "generic"
	ProfileCursorPlan = "cursor_plan"
	ProfileSpeckit    = "speckit"
	ProfileBmad       = "bmad"
	ProfileOpenspec   = "openspec"
	ProfileADR        = "adr"
	ProfileClaude     = "claude"
	ProfileCodex      = "codex"
)

Canonical format_profile values (ingestion / layout convention).

Functions

func FromFrontmatterTool

func FromFrontmatterTool(values ...string) string

FromFrontmatterTool maps generator / tool / source frontmatter strings to a profile. Empty strings are ignored; first non-empty wins in caller order.

func FromPath

func FromPath(relPath string) string

FromPath infers format_profile from repository-relative path (slash-normalized).

func LayoutGroup

func LayoutGroup(relPath string) string

LayoutGroup returns a repo-relative grouping key for multi-file layouts (optional).

func Normalize

func Normalize(s string) string

Normalize returns a canonical profile slug or ProfileGeneric for unknown input.