feat: enhance error formatting with wrapped errors

[yordis]

No description provided.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Updates adjust TrogonError string formatting: modified metadata and help sections, added optional wrapped error line, and refined debug/stack presentation. Tests were updated and expanded to validate new formatting and wrapping scenarios. Example and template outputs were trimmed of blank lines to match the revised format.

Changes

Cohort / File(s)	Summary
Core error string formatting error.go	Revised Error() string composition: new newline boundaries, metadata list formatting without trailing newline, extra spacing before help links, added “wrapped error:” line when present, and adjusted debug/stack block spacing.
Formatting tests and new wrapping scenarios error_format_test.go	Updated expected outputs to match new formatting; added tests for wrapped standard errors and wrapped TrogonErrors; validated ordering among wrapped error, metadata, help, retry, and stack trace.
Examples output tidy-up example_test.go	Removed standalone empty comment lines after metadata in examples to align with new output spacing.
Template example output tidy-up template_test.go	Removed extra blank lines in ExampleErrorTemplate_reusable Output block to reflect new formatting.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Caller
  participant TE as TrogonError
  participant F as Formatter

  Caller->>TE: Error()
  activate TE
  TE->>F: build string
  note right of F: Append domain, reason, message
  F-->>TE: base header

  alt has metadata
    F-->>TE: "metadata:" + per-item lines
  end

  alt has help links
    F-->>TE: blank line + links section
  end

  alt has wrapped error
    F-->>TE: "wrapped error: " + wrapped message
  end

  alt has debug/stack
    F-->>TE: newline + debug header, optional detail, stack entries
  end

  TE-->>Caller: final error string
  deactivate TE

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I nibble newlines, hop through stacks,
A tidy warren in error tracks.
Wrapped woes whisper, now shown true,
Metadata carrots lined up anew.
Links and traces, spaced just right—
Thump! The format lands light and tight.
Bug be gone; on to the night.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 4bbe395 and 13c2f69.

📒 Files selected for processing (4)

• error.go (1 hunks)
• error_format_test.go (7 hunks)
• example_test.go (0 hunks)
• template_test.go (0 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-print-wrapped-err

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.