Files
Ed Zynda 922e246098 feat(prompts): auto-reload prompts and extensions from XDG config
- Add prompts.GlobalDir() resolving $XDG_CONFIG_HOME/kit/prompts/
  (default ~/.config/kit/prompts/) so prompt templates live alongside
  extensions and skills under the same XDG-aligned root.
- LoadAll now discovers templates from both the legacy ~/.kit/prompts/
  and the XDG location; existing legacy paths keep precedence.
- Include GlobalDir() in the prompts/skills file watcher so edits
  under ~/.config/kit/prompts/ hot-reload automatically.
- Surface a visible 'Extensions reloaded.' (or error) message when
  the extension watcher fires, matching /reload-ext feedback.
- Restore examples/extensions/subagent-monitor.go alongside its test
  and update the test load path; previous move left the test broken.
2026-05-15 14:31:51 +03:00

218 lines
6.5 KiB
Go

package prompts
import (
"fmt"
"log"
"os"
"path/filepath"
"strings"
)
// LoadOptions configures how templates are discovered and loaded.
type LoadOptions struct {
// Cwd is the current working directory for project-local discovery.
// If empty, the current working directory is used.
Cwd string
// HomeDir is the user's home directory. If empty, os.UserHomeDir() is used.
HomeDir string
// ExtraPaths are additional explicit paths to search for templates.
ExtraPaths []string
// ConfigPaths are paths from configuration files to search.
ConfigPaths []string
// IncludeDefaults determines whether to include built-in default templates.
IncludeDefaults bool
}
// Diagnostic reports a template collision or loading issue.
type Diagnostic struct {
// Name is the template name that had a collision.
Name string
// KeptPath is the path of the template that was kept (higher precedence).
KeptPath string
// DroppedPath is the path of the template that was dropped.
DroppedPath string
// Reason explains why the collision occurred.
Reason string
}
// LoadAll discovers and loads all prompt templates from standard locations
// and any extra paths. Templates are loaded in order of precedence (highest
// to lowest); the first source to define a given name wins, later definitions
// of the same name are dropped with a diagnostic.
//
// Discovery paths searched in order:
// 1. Default templates (if IncludeDefaults)
// 2. ~/.kit/prompts/ (legacy global)
// 3. $XDG_CONFIG_HOME/kit/prompts/ (XDG global, default ~/.config/kit/prompts/)
// 4. <cwd>/.kit/prompts/ (project-local templates)
// 5. ConfigPaths (from configuration)
// 6. ExtraPaths (explicit paths, lowest precedence)
func LoadAll(opts LoadOptions) ([]*PromptTemplate, []Diagnostic, error) {
if opts.Cwd == "" {
opts.Cwd, _ = os.Getwd()
}
if opts.HomeDir == "" {
home, err := os.UserHomeDir()
if err != nil {
return nil, nil, fmt.Errorf("getting home directory: %w", err)
}
opts.HomeDir = home
}
var all []*PromptTemplate
var diagnostics []Diagnostic
seen := make(map[string]*PromptTemplate) // name -> template
// Helper to add templates with deduplication tracking
addTemplates := func(templates []*PromptTemplate, source string) {
for _, tpl := range templates {
if existing, ok := seen[tpl.Name]; ok {
// Collision: report diagnostic, keep existing (lower precedence wins)
diagnostics = append(diagnostics, Diagnostic{
Name: tpl.Name,
KeptPath: existing.FilePath,
DroppedPath: tpl.FilePath,
Reason: fmt.Sprintf("template from %s overridden by %s", source, existing.Source),
})
log.Printf("DEBUG template collision: name=%s dropped=%s kept=%s", tpl.Name, tpl.FilePath, existing.FilePath)
} else {
tpl.Source = source
seen[tpl.Name] = tpl
all = append(all, tpl)
}
}
}
// 1. Default templates (lowest precedence)
if opts.IncludeDefaults {
defaults := loadDefaultTemplates()
addTemplates(defaults, "default")
}
// 2. Legacy global user templates: ~/.kit/prompts/
legacyGlobalDir := filepath.Join(opts.HomeDir, ".kit", "prompts")
if templates, err := LoadFromDir(legacyGlobalDir); err == nil {
addTemplates(templates, "global")
}
// 3. XDG global user templates: $XDG_CONFIG_HOME/kit/prompts/
// Default: ~/.config/kit/prompts/. Aligns with extensions and skills.
if xdgDir := GlobalDir(); xdgDir != "" && xdgDir != legacyGlobalDir {
if templates, err := LoadFromDir(xdgDir); err == nil {
addTemplates(templates, "global")
}
}
// 4. Project-local templates: .kit/prompts/
localDir := filepath.Join(opts.Cwd, ".kit", "prompts")
if templates, err := LoadFromDir(localDir); err == nil {
addTemplates(templates, "local")
}
// 4. Config paths
for _, path := range opts.ConfigPaths {
info, err := os.Stat(path)
if err != nil {
continue
}
if info.IsDir() {
if templates, err := LoadFromDir(path); err == nil {
addTemplates(templates, "config")
}
} else if strings.HasSuffix(path, ".md") {
if tpl, err := ParseTemplate(path); err == nil {
addTemplates([]*PromptTemplate{tpl}, "config")
}
}
}
// 5. Extra paths (highest precedence)
for _, path := range opts.ExtraPaths {
info, err := os.Stat(path)
if err != nil {
continue
}
if info.IsDir() {
if templates, err := LoadFromDir(path); err == nil {
addTemplates(templates, "explicit")
}
} else if strings.HasSuffix(path, ".md") {
if tpl, err := ParseTemplate(path); err == nil {
addTemplates([]*PromptTemplate{tpl}, "explicit")
}
}
}
return all, diagnostics, nil
}
// LoadFromDir scans a directory for .md files and loads them as templates.
// It looks for *.md files directly in the directory.
// Files that fail to parse are logged and skipped.
func LoadFromDir(dir string) ([]*PromptTemplate, error) {
info, err := os.Stat(dir)
if err != nil || !info.IsDir() {
return nil, nil // directory doesn't exist — not an error
}
entries, err := os.ReadDir(dir)
if err != nil {
return nil, fmt.Errorf("reading prompts directory %s: %w", dir, err)
}
var templates []*PromptTemplate
var errs []string
for _, entry := range entries {
if entry.IsDir() {
continue
}
name := entry.Name()
if !strings.HasSuffix(name, ".md") {
continue
}
full := filepath.Join(dir, name)
tpl, err := ParseTemplate(full)
if err != nil {
errs = append(errs, err.Error())
continue
}
templates = append(templates, tpl)
}
if len(errs) > 0 {
return templates, fmt.Errorf("some templates failed to load: %s", strings.Join(errs, "; "))
}
return templates, nil
}
// loadDefaultTemplates returns the built-in default templates.
// These are embedded templates that ship with Kit.
func loadDefaultTemplates() []*PromptTemplate {
// Default templates can be added here as needed
// For now, return an empty slice - users can define their own templates
return nil
}
// GlobalDir returns the XDG-aligned global prompts directory, respecting
// $XDG_CONFIG_HOME. Defaults to ~/.config/kit/prompts/. Returns an empty
// string if the user's home directory cannot be resolved.
//
// This is the canonical location for user-wide prompt templates and aligns
// with the discovery paths used for extensions ($XDG_CONFIG_HOME/kit/extensions/)
// and skills ($XDG_CONFIG_HOME/kit/skills/).
func GlobalDir() string {
base := os.Getenv("XDG_CONFIG_HOME")
if base == "" {
home, err := os.UserHomeDir()
if err != nil {
return ""
}
base = filepath.Join(home, ".config")
}
return filepath.Join(base, "kit", "prompts")
}