* fix(workspace): align resolved workspace messaging and config lookup intent(workspace): pure worktrees and external BEADS_DIR setups should work without implying a local .beads directory is required decision(config): derive config repo roots from FindBeadsDir-backed workspace resolution instead of a local-only .beads walk constraint(workspace-detection): keep FindBeadsDir ordering and storage behavior unchanged while making bd where the primary diagnostic hint learned(testing): shared-server env and global .beads ignore rules can distort CGO suites, so regression coverage now normalizes those test paths * fix(bootstrap): align no-workspace JSON wording intent(bootstrap): machine-readable no-workspace output should match the resolved-workspace guidance used elsewhere on this branch decision(bootstrap-json): reuse the shared workspace error helpers through a dedicated payload builder so tests can lock the JSON contract constraint(review-loop): keep the bootstrap CLI flow unchanged outside the no-workspace JSON branch while adding a focused regression test * fix(where): allow no-workspace diagnostics without db (beads-9f74-5l1) intent(where): no-workspace guidance should point to a command that actually runs when workspace resolution fails decision(startup): treat top-level where as a no-db command so it reaches its own handler before database preflight constraint(where-tests): subprocess mode can change the exact hint text, so the regression test locks the JSON contract and stable guidance fragments instead * fix(bootstrap): restore bd where guidance for no-workspace output (beads-9f74-3c3) intent(bootstrap): no-workspace bootstrap guidance should match the resolved-workspace diagnostics introduced on this branch decision(no-workspace-hints): reuse the shared hint that mentions bd where instead of the bootstrap-specific fallback text constraint(bootstrap-tests): cover both the payload helper and subprocess CLI path so wording regressions are caught before release * fix(workspace): remove no-workspace .beads fallbacks (beads-9f74-gr1) intent(workspace-resolution): finish the GH#3124 follow-up for runtime paths that still fabricated local .beads state rejected(no-workspace-fallback): inventing ./ .beads paths outside an active workspace hid shared-worktree resolution and created stray files decision(setup-recipes): keep built-in bd setup recipes usable without a workspace but require an active workspace for custom recipe state constraint(worktree-support): completion and backup helpers still need to resolve shared main-repo workspaces from a git worktree * fix(config): skip no-workspace store init for store-free commands intent(config): review-fix-loop found no-workspace config commands should reach their own graceful paths instead of failing in PersistentPreRun decision(config-preflight): detect store-free config subcommands before DB synthesis so config.yaml, git-backed, and diagnostic flows can run without an opened store constraint(json-contract): keep bd config validate --json machine-readable on stdout once pre-run stops short-circuiting into low-level DB errors learned(config-preflight): the parent config command not being in noDbCommands leaked store init into show, validate, drift, apply, and yaml-only config helpers * fix(ci): restore init prefix normalization and formatting intent(ci): clear the current PR failures instead of leaving the branch blocked behind known red checks decision(init-prefix): normalize dotted prefixes before persisting issue_prefix so config, metadata.json, and Dolt database naming stay aligned for Julia-style repos constraint(fmt-check): CI runs gofmt over the whole repo, so the existing spacing drift in internal/jira/tracker_test.go had to be cleaned up on this branch to get a green run learned(ci): the latest main CI was already red on the same formatting file and the same embedded shard, so rebasing surfaced pre-existing blockers rather than introducing a new shard-only regression
149 lines
4.5 KiB
Go
149 lines
4.5 KiB
Go
package main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
)
|
|
|
|
func activeWorkspaceNotFoundError() string {
|
|
return "no active beads workspace found"
|
|
}
|
|
|
|
func activeWorkspaceNotFoundMessage() string {
|
|
return "No active beads workspace found."
|
|
}
|
|
|
|
// diagHint returns the appropriate diagnostic hint when the active beads
|
|
// workspace cannot be resolved. In embedded mode, 'bd doctor' is not
|
|
// available so the hint omits it.
|
|
func diagHint() string {
|
|
return workspaceDiagHint(true)
|
|
}
|
|
|
|
func whereDiagHint() string {
|
|
return workspaceDiagHint(false)
|
|
}
|
|
|
|
func workspaceDiagHint(includeWhere bool) string {
|
|
if includeWhere {
|
|
if isEmbeddedMode() {
|
|
return "run 'bd where' to inspect the resolved workspace, or 'bd init' to create a new database"
|
|
}
|
|
return "run 'bd where' to inspect the resolved workspace, run 'bd doctor' to diagnose, or 'bd init' to create a new database"
|
|
}
|
|
if isEmbeddedMode() {
|
|
return "check BEADS_DIR/worktree setup, or run 'bd init' to create a new database"
|
|
}
|
|
return "check BEADS_DIR/worktree setup, run 'bd doctor' to diagnose, or run 'bd init' to create a new database"
|
|
}
|
|
|
|
// FatalError writes an error message to stderr and exits with code 1.
|
|
// Use this for fatal errors that prevent the command from completing.
|
|
//
|
|
// Pattern A from ERROR_HANDLING.md:
|
|
// - User input validation failures
|
|
// - Critical preconditions not met
|
|
// - Unrecoverable system errors
|
|
//
|
|
// Example:
|
|
//
|
|
// if err := store.CreateIssue(ctx, issue, actor); err != nil {
|
|
// FatalError("%v", err)
|
|
// }
|
|
func FatalError(format string, args ...interface{}) {
|
|
msg := fmt.Sprintf(format, args...)
|
|
if jsonOutput {
|
|
data, _ := json.MarshalIndent(map[string]string{"error": msg}, "", " ")
|
|
fmt.Fprintln(os.Stderr, string(data))
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "Error: %s\n", msg)
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
|
|
// FatalErrorRespectJSON writes an error message and exits with code 1.
|
|
// If --json flag is set, outputs structured JSON to stdout.
|
|
// Otherwise, outputs plain text to stderr.
|
|
//
|
|
// Use this for errors in commands that support --json output.
|
|
//
|
|
// Example:
|
|
//
|
|
// if err := store.GetIssue(ctx, id); err != nil {
|
|
// FatalErrorRespectJSON("%v", err)
|
|
// }
|
|
func FatalErrorRespectJSON(format string, args ...interface{}) {
|
|
msg := fmt.Sprintf(format, args...)
|
|
if jsonOutput {
|
|
data, _ := json.MarshalIndent(map[string]string{"error": msg}, "", " ") // json.MarshalIndent on simple maps does not fail in practice
|
|
fmt.Println(string(data))
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "Error: %s\n", msg)
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
|
|
// FatalErrorWithHintRespectJSON writes an error message with a hint and exits.
|
|
// If --json is set, emits structured JSON to stdout so callers can parse it.
|
|
func FatalErrorWithHintRespectJSON(message, hint string) {
|
|
if jsonOutput {
|
|
outputJSON(map[string]string{"error": message, "hint": hint})
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "Error: %s\n", message)
|
|
fmt.Fprintf(os.Stderr, "Hint: %s\n", hint)
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
|
|
// FatalErrorWithHint writes an error message with a hint to stderr and exits.
|
|
// Use this when you can provide an actionable suggestion to fix the error.
|
|
//
|
|
// Example:
|
|
//
|
|
// FatalErrorWithHint("database not found", "Run 'bd init' to create a database")
|
|
func FatalErrorWithHint(message, hint string) {
|
|
if jsonOutput {
|
|
data, _ := json.MarshalIndent(map[string]string{"error": message, "hint": hint}, "", " ")
|
|
fmt.Fprintln(os.Stderr, string(data))
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "Error: %s\n", message)
|
|
fmt.Fprintf(os.Stderr, "Hint: %s\n", hint)
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
|
|
// WarnError writes a warning message to stderr and returns.
|
|
// Use this for optional operations that enhance functionality but aren't required.
|
|
//
|
|
// Pattern B from ERROR_HANDLING.md:
|
|
// - Metadata operations
|
|
// - Cleanup operations
|
|
// - Auxiliary features (git hooks, merge drivers)
|
|
//
|
|
// Example:
|
|
//
|
|
// if err := createConfigYaml(beadsDir, false); err != nil {
|
|
// WarnError("failed to create config.yaml: %v", err)
|
|
// }
|
|
func WarnError(format string, args ...interface{}) {
|
|
fmt.Fprintf(os.Stderr, "Warning: "+format+"\n", args...)
|
|
}
|
|
|
|
// CheckReadonly exits with an error if readonly mode is enabled.
|
|
// Call this at the start of write commands (create, update, close, delete, sync, etc.).
|
|
// Used by worker sandboxes that should only read beads, not modify them.
|
|
//
|
|
// Example:
|
|
//
|
|
// var createCmd = &cobra.Command{
|
|
// Run: func(cmd *cobra.Command, args []string) {
|
|
// CheckReadonly("create")
|
|
// // ... rest of command
|
|
// },
|
|
// }
|
|
func CheckReadonly(operation string) {
|
|
if readonlyMode {
|
|
FatalError("operation '%s' is not allowed in read-only mode", operation)
|
|
}
|
|
}
|