mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 18:57:44 +02:00
add rendered and json error messages in try/catch (#14082)
# Description This PR adds a couple more options for dealing with try/catch errors. It adds a `json` version of the error and a `rendered` version of the error. It also respects the error_style configuration point.  # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
This commit is contained in:
@ -35,6 +35,7 @@ miette = { workspace = true, features = ["fancy-no-backtrace"] }
|
||||
num-format = { workspace = true }
|
||||
rmp-serde = { workspace = true, optional = true }
|
||||
serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
thiserror = "1.0"
|
||||
typetag = "0.2"
|
||||
os_pipe = { workspace = true, features = ["io_safety"] }
|
||||
|
@ -139,6 +139,23 @@ impl LabeledError {
|
||||
self
|
||||
}
|
||||
|
||||
pub fn render_error_to_string(diag: impl miette::Diagnostic, fancy_errors: bool) -> String {
|
||||
let theme = if fancy_errors {
|
||||
miette::GraphicalTheme::unicode()
|
||||
} else {
|
||||
miette::GraphicalTheme::none()
|
||||
};
|
||||
|
||||
let mut out = String::new();
|
||||
miette::GraphicalReportHandler::new()
|
||||
.with_width(80)
|
||||
.with_theme(theme)
|
||||
.render_report(&mut out, &diag)
|
||||
.unwrap_or_default();
|
||||
|
||||
out
|
||||
}
|
||||
|
||||
/// Create a [`LabeledError`] from a type that implements [`miette::Diagnostic`].
|
||||
///
|
||||
/// # Example
|
||||
|
@ -1474,13 +1474,16 @@ impl ShellError {
|
||||
self.external_exit_code().map(|e| e.item).unwrap_or(1)
|
||||
}
|
||||
|
||||
pub fn into_value(self, span: Span) -> Value {
|
||||
pub fn into_value(self, span: Span, fancy_errors: bool) -> Value {
|
||||
let exit_code = self.external_exit_code();
|
||||
|
||||
let mut record = record! {
|
||||
"msg" => Value::string(self.to_string(), span),
|
||||
"debug" => Value::string(format!("{self:?}"), span),
|
||||
"raw" => Value::error(self, span),
|
||||
"raw" => Value::error(self.clone(), span),
|
||||
// "labeled_error" => Value::string(LabeledError::from_diagnostic_and_render(self.clone()), span),
|
||||
"rendered" => Value::string(ShellError::render_error_to_string(self.clone(), fancy_errors), span),
|
||||
"json" => Value::string(serde_json::to_string(&self).expect("Could not serialize error"), span),
|
||||
};
|
||||
|
||||
if let Some(code) = exit_code {
|
||||
@ -1499,6 +1502,21 @@ impl ShellError {
|
||||
span,
|
||||
)
|
||||
}
|
||||
pub fn render_error_to_string(diag: impl miette::Diagnostic, fancy_errors: bool) -> String {
|
||||
let theme = if fancy_errors {
|
||||
miette::GraphicalTheme::unicode()
|
||||
} else {
|
||||
miette::GraphicalTheme::none()
|
||||
};
|
||||
let mut out = String::new();
|
||||
miette::GraphicalReportHandler::new()
|
||||
.with_width(80)
|
||||
.with_theme(theme)
|
||||
.render_report(&mut out, &diag)
|
||||
.unwrap_or_default();
|
||||
|
||||
out
|
||||
}
|
||||
}
|
||||
|
||||
impl From<io::Error> for ShellError {
|
||||
|
Reference in New Issue
Block a user