codemap

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: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Infer added in v0.5.0

func Infer(repoRoot string) (map[string]config.CodemapPackage, []string, error)

func RenderRelevantPackages

func RenderRelevantPackages(pkgs []PackageExplanation) string

Types

type Explanation

type Explanation struct {
	Target      string               `json:"target"`
	Kind        string               `json:"kind"`
	Description string               `json:"description,omitempty"`
	Task        *TaskExplanation     `json:"task,omitempty"`
	Package     *PackageExplanation  `json:"package,omitempty"`
	Glossary    *GlossaryExplanation `json:"glossary,omitempty"`
	Markdown    string               `json:"markdown"`
}

func Explain

func Explain(cfg *config.Config, target string) (Explanation, error)

type GlossaryExplanation

type GlossaryExplanation struct {
	Term       string `json:"term"`
	Definition string `json:"definition"`
}

type PackageExplanation

type PackageExplanation struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	KeyTypes    []string `json:"key_types,omitempty"`
	EntryPoints []string `json:"entry_points,omitempty"`
	Conventions []string `json:"conventions,omitempty"`
	DependsOn   []string `json:"depends_on,omitempty"`
}

func RelevantPackages

func RelevantPackages(cfg *config.Config, scopePaths []string) []PackageExplanation

type TaskExplanation

type TaskExplanation struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Type        string   `json:"type"`
	Scope       string   `json:"scope,omitempty"`
	ScopePaths  []string `json:"scope_paths,omitempty"`
	Needs       []string `json:"needs,omitempty"`
	Steps       []string `json:"steps,omitempty"`
	Command     string   `json:"command,omitempty"`
}

Jump to

Keyboard shortcuts

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