summary

package

v0.9.0 Latest Latest Go to latest Published: Feb 8, 2026 License: MIT Imports: 5 Imported by: 0

Details

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

Repository

github.com/ytnobody/MAXAM

Links

Open Source Insights

Documentation ¶

Overview ¶

Package summary provides automatic generation of CLAUDE.summary.md

Index ¶

Constants
Variables
func EnsureUpToDate(workDir string) error
func ExtractSections(content string, sections []string) string
func Generate(workDir string) error
func NeedsRegeneration(workDir string) bool

Constants ¶

View Source

const (
	// SourceFile is the full CLAUDE.md filename
	SourceFile = "CLAUDE.md"
	// SummaryFile is the generated summary filename
	SummaryFile = "CLAUDE.summary.md"
)

View Source

const MaxLinesPerSection = 30

MaxLinesPerSection limits lines per section to keep summary concise

Variables ¶

View Source

var SectionsToExtract = []string{
	"プロジェクト概要",
	"チームメンバー",
	"コーディング規約",
	"通信規約",
	"エスカレーションルール",
	"Worktree運用",
}

SectionsToExtract defines which sections to include in summary These are H2 headers (## Section Name)

Functions ¶

func EnsureUpToDate ¶

func EnsureUpToDate(workDir string) error

EnsureUpToDate regenerates summary if needed

func ExtractSections ¶

func ExtractSections(content string, sections []string) string

ExtractSections extracts specified H2 sections from markdown content

func Generate ¶

func Generate(workDir string) error

Generate creates CLAUDE.summary.md from CLAUDE.md

func NeedsRegeneration ¶

func NeedsRegeneration(workDir string) bool

NeedsRegeneration checks if CLAUDE.summary.md needs to be regenerated Returns true if: - CLAUDE.md exists and CLAUDE.summary.md doesn't exist - CLAUDE.md is newer than CLAUDE.summary.md

Types ¶

This section is empty.

Source Files ¶

View all Source files

generator.go

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