fix DFanso#121 : improve error messages with context and actionable guidance

[adeeshperera]

• Add file paths to config file not found errors
• Replace vague credential errors with descriptive messages
• Include specific commands (e.g., 'commit llm setup') to guide users
• Apply proper error wrapping across all store operations

Summary by CodeRabbit

Release Notes

• Improvements
  • Enhanced error messages throughout the application with clearer context and actionable guidance.
  • Added helpful instructions (e.g., setup commands) when configuration or credential issues occur.
  • Improved error reporting to include relevant details like file paths and setup steps for better troubleshooting.

[coderabbitai]

Walkthrough

The PR enhances error reporting in the store module by wrapping errors with contextual information (file paths and setup instructions) and replacing generic error messages with more descriptive alternatives, without modifying control flow or core logic.

Changes

Cohort / File(s)	Summary
Error message and error wrapping improvements cmd/cli/store/store.go	Replaces generic error returns with fmt.Errorf and error wrapping (%w), adding context such as file paths and setup guidance. Clarifies missing-config scenarios with "run 'commit llm setup'" instructions and improves empty-config and default-model error messages while preserving control flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

The changes are localized to a single file with homogeneous, repetitive improvements to error messages and wrapping patterns. No logic or control-flow modifications are present, making this a straightforward review focused on verifying message clarity and error handling consistency.

Possibly related PRs

• Fix: Improve error handling for config loading #109: Both PRs modify error handling in cmd/cli/store/store.go to wrap and unify config-load/unmarshal errors with setup re-run guidance.
• Secure API storage #102: Both PRs modify cmd/cli/store/store.go; this PR updates error messages and wrapping while the other refactors storage implementation.

Suggested labels

bug, go

Suggested reviewers

• DFanso

Poem

🐰 Errors now bloom with helpful light,
Paths and guidance, oh what a sight!
No control-flow surprise,
Just clearer advice—
Wrapped messages making things right! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "fix #121 : improve error messages with context and actionable guidance" directly and clearly summarizes the main change in the changeset. The PR modifies error handling in cmd/cli/store/store.go to add file paths, include specific guidance commands (like 'commit llm setup'), and wrap errors with additional context. The title accurately reflects this core objective and is concise, specific, and avoids vague terminology. A teammate reviewing the commit history would immediately understand that this PR focuses on enhancing error reporting with contextual information and user guidance.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f097ae and 091365e.

📒 Files selected for processing (1)

• cmd/cli/store/store.go (11 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Build Go Binary (windows-latest)
• GitHub Check: Test (1.22)
• GitHub Check: Test (1.23)

🔇 Additional comments (4)

cmd/cli/store/store.go (4)

87-87: Excellent error wrapping for keyring operations.

The enhanced error messages now clearly indicate keyring credential storage/update failures while properly preserving underlying error details with %w. This provides much better context for debugging credential-related issues.

Also applies to: 102-102, 345-345

---

129-129: Great improvement to config-not-found errors.

Including the file path (%s, configPath) and the actionable command 'commit llm setup' transforms generic errors into helpful guidance. This consistency across all functions (DefaultLLMKey, ListSavedModels, ChangeDefault, DeleteModel, UpdateAPIKey) significantly improves the user experience.

Also applies to: 175-175, 209-209, 259-259, 321-321

---

144-144: Improved empty config handling.

The new error messages clearly distinguish empty config files from missing ones and provide actionable guidance to add the first LLM provider. This helps users understand the difference between these two scenarios and how to resolve them.

Also applies to: 190-190

---

160-160: Excellent context for missing default model.

Including the specific model name ('%s') in the error message helps users quickly identify which provider is misconfigured, and the actionable command guides them to resolution.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[DFanso]

approved 🎊