Context not appearing for error messages?

[jemarq04]

Hello, I am trying to get the nice printed message with the ContextKind::Suggested context similar to in the answer for the following discussion: #5318. However, when creating a new error from the struct derived from the Parser trait, it doesn't seem to display any inserted context.

I've added my attempt to this rust playground: https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=99840c8a34dae9dbb841ec615a27611f. As shown, when the error is thrown no additional context is provided. When the error is printed with Debug, I can see the context is included in the error, just not printed.

I made sure to have the ContextValue variant be StyledStrs so that the RichFormatter can print with it properly, but it's still not printing. Is there something I'm missing here?

[epage]

When using Error::raw / Command::error, you are providing a nearly complete message and little to no additional formatting is added. If you instead use Error::new, the message will be built up from the supplied context.

[jemarq04]

I see. Then is there no way to have a custom message with the supplied context? I'm trying to throw my own error after the parsing with a nicer printout, and I think it would be easier to read if it included the suggested tip along with it, like in #5318.

[epage]

Currently the only way to do it is to put your error in a IoError and use clap::Error::from.

Or you could render your message with the suggestion and pass that to clap.

If those aren't enough, some possible ways we can change clap

• Add a conversion from any error
• Add a Context to override the Kind's message

[jemarq04]

I played around with it and in the end adding the formatted message myself into the error similar to how it's done in the source code worked like a charm, as you suggested. Thank you for helping!