mirror of https://github.com/kdl-org/kdl-rs.git
refactor(deps): remove `miette-derive` from dependencies
This completes the removal of `syn` from `kdl-rs`s dependency tree!
This commit is contained in:
parent
cca8cac29c
commit
fbd1de4d9c
|
|
@ -27,10 +27,10 @@ winnow = { version = "=0.6.24", features = ["alloc", "unstable-recover"] }
|
||||||
kdlv1 = { package = "kdl", version = "4.7.0", optional = true }
|
kdlv1 = { package = "kdl", version = "4.7.0", optional = true }
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
miette = { git = "https://github.com/TheLostLambda/miette.git" }
|
miette = { git = "https://github.com/zkat/miette.git", default-features = false }
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
miette = { workspace = true, features = ["fancy"] }
|
miette = { workspace = true, features = ["derive", "fancy"] }
|
||||||
thiserror = "2.0.12"
|
thiserror = "2.0.12"
|
||||||
pretty_assertions = "1.3.0"
|
pretty_assertions = "1.3.0"
|
||||||
|
|
||||||
|
|
|
||||||
119
src/error.rs
119
src/error.rs
|
|
@ -1,6 +1,6 @@
|
||||||
use std::{error::Error, fmt::Display, sync::Arc};
|
use std::{error::Error, fmt::Display, iter, sync::Arc};
|
||||||
|
|
||||||
use miette::{Diagnostic, SourceSpan};
|
use miette::{Diagnostic, LabeledSpan, Severity, SourceSpan};
|
||||||
|
|
||||||
#[cfg(doc)]
|
#[cfg(doc)]
|
||||||
use {
|
use {
|
||||||
|
|
@ -33,14 +33,12 @@ use {
|
||||||
/// ╰────
|
/// ╰────
|
||||||
/// help: Floating point numbers must be base 10, and have numbers after the decimal point.
|
/// help: Floating point numbers must be base 10, and have numbers after the decimal point.
|
||||||
/// ```
|
/// ```
|
||||||
#[derive(Debug, Diagnostic, Clone, Eq, PartialEq)]
|
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||||
pub struct KdlError {
|
pub struct KdlError {
|
||||||
/// Original input that this failure came from.
|
/// Original input that this failure came from.
|
||||||
#[source_code]
|
|
||||||
pub input: Arc<String>,
|
pub input: Arc<String>,
|
||||||
|
|
||||||
/// Sub-diagnostics for this failure.
|
/// Sub-diagnostics for this failure.
|
||||||
#[related]
|
|
||||||
pub diagnostics: Vec<KdlDiagnostic>,
|
pub diagnostics: Vec<KdlDiagnostic>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -51,17 +49,27 @@ impl Display for KdlError {
|
||||||
}
|
}
|
||||||
impl Error for KdlError {}
|
impl Error for KdlError {}
|
||||||
|
|
||||||
|
impl Diagnostic for KdlError {
|
||||||
|
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
|
||||||
|
Some(&self.input)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn related<'a>(&'a self) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>> {
|
||||||
|
Some(Box::new(
|
||||||
|
self.diagnostics.iter().map(|d| d as &dyn Diagnostic),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// An individual diagnostic message for a KDL parsing issue.
|
/// An individual diagnostic message for a KDL parsing issue.
|
||||||
///
|
///
|
||||||
/// While generally signifying errors, they can also be treated as warnings.
|
/// While generally signifying errors, they can also be treated as warnings.
|
||||||
#[derive(Debug, Diagnostic, Clone, Eq, PartialEq)]
|
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||||
pub struct KdlDiagnostic {
|
pub struct KdlDiagnostic {
|
||||||
/// Shared source for the diagnostic.
|
/// Shared source for the diagnostic.
|
||||||
#[source_code]
|
|
||||||
pub input: Arc<String>,
|
pub input: Arc<String>,
|
||||||
|
|
||||||
/// Offset in chars of the error.
|
/// Offset in chars of the error.
|
||||||
#[label("{}", label.clone().unwrap_or_else(|| "here".into()))]
|
|
||||||
pub span: SourceSpan,
|
pub span: SourceSpan,
|
||||||
|
|
||||||
/// Message for the error itself.
|
/// Message for the error itself.
|
||||||
|
|
@ -71,12 +79,10 @@ pub struct KdlDiagnostic {
|
||||||
pub label: Option<String>,
|
pub label: Option<String>,
|
||||||
|
|
||||||
/// Suggestion for fixing the parser error.
|
/// Suggestion for fixing the parser error.
|
||||||
#[help]
|
|
||||||
pub help: Option<String>,
|
pub help: Option<String>,
|
||||||
|
|
||||||
/// Severity level for the Diagnostic.
|
/// Severity level for the Diagnostic.
|
||||||
#[diagnostic(severity)]
|
pub severity: Severity,
|
||||||
pub severity: miette::Severity,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for KdlDiagnostic {
|
impl Display for KdlDiagnostic {
|
||||||
|
|
@ -90,6 +96,27 @@ impl Display for KdlDiagnostic {
|
||||||
}
|
}
|
||||||
impl Error for KdlDiagnostic {}
|
impl Error for KdlDiagnostic {}
|
||||||
|
|
||||||
|
impl Diagnostic for KdlDiagnostic {
|
||||||
|
fn source_code(&self) -> Option<&dyn miette::SourceCode> {
|
||||||
|
Some(&self.input)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn severity(&self) -> Option<Severity> {
|
||||||
|
Some(self.severity)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
|
||||||
|
self.help.as_ref().map(|s| Box::new(s) as Box<dyn Display>)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn labels(&self) -> Option<Box<dyn Iterator<Item = miette::LabeledSpan> + '_>> {
|
||||||
|
let label = self.label.clone().unwrap_or_else(|| "here".to_owned());
|
||||||
|
let labeled_span = LabeledSpan::new_with_span(Some(label), self.span);
|
||||||
|
|
||||||
|
Some(Box::new(iter::once(labeled_span)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(feature = "v1")]
|
#[cfg(feature = "v1")]
|
||||||
impl From<kdlv1::KdlError> for KdlError {
|
impl From<kdlv1::KdlError> for KdlError {
|
||||||
fn from(value: kdlv1::KdlError) -> Self {
|
fn from(value: kdlv1::KdlError) -> Self {
|
||||||
|
|
@ -102,7 +129,7 @@ impl From<kdlv1::KdlError> for KdlError {
|
||||||
message: Some(format!("{}", value.kind)),
|
message: Some(format!("{}", value.kind)),
|
||||||
label: value.label.map(|x| x.into()),
|
label: value.label.map(|x| x.into()),
|
||||||
help: value.help.map(|x| x.into()),
|
help: value.help.map(|x| x.into()),
|
||||||
severity: miette::Severity::Error,
|
severity: Severity::Error,
|
||||||
}],
|
}],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -110,32 +137,54 @@ impl From<kdlv1::KdlError> for KdlError {
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn kdl_error() {
|
fn kdl_error() {
|
||||||
let kdl_error = KdlError {
|
let kdl_diagnostic = KdlDiagnostic {
|
||||||
input: Default::default(),
|
input: Default::default(),
|
||||||
diagnostics: Default::default(),
|
span: SourceSpan::new(0.into(), 0),
|
||||||
};
|
|
||||||
|
|
||||||
assert_eq!(kdl_error.to_string(), "Failed to parse KDL document");
|
|
||||||
assert!(kdl_error.source().is_none());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn kdl_diagnostic() {
|
|
||||||
let mut kdl_diagnostic = KdlDiagnostic {
|
|
||||||
input: Default::default(),
|
|
||||||
span: SourceSpan::new(0.into(), 1),
|
|
||||||
message: Default::default(),
|
message: Default::default(),
|
||||||
label: Default::default(),
|
label: Default::default(),
|
||||||
help: Default::default(),
|
help: Default::default(),
|
||||||
severity: Default::default(),
|
severity: Default::default(),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let kdl_error = KdlError {
|
||||||
|
input: Arc::new("bark? i guess?".to_owned()),
|
||||||
|
diagnostics: vec![kdl_diagnostic.clone(), kdl_diagnostic],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Test `Error` impl
|
||||||
|
assert_eq!(kdl_error.to_string(), "Failed to parse KDL document");
|
||||||
|
assert!(kdl_error.source().is_none());
|
||||||
|
|
||||||
|
// Test `Diagnostic` impl
|
||||||
|
let related: Vec<_> = kdl_error.related().unwrap().collect();
|
||||||
|
assert_eq!(related.len(), 2);
|
||||||
|
assert_eq!(
|
||||||
|
kdl_error
|
||||||
|
.source_code()
|
||||||
|
.unwrap()
|
||||||
|
.read_span(&SourceSpan::new(0.into(), 5), 0, 0)
|
||||||
|
.unwrap()
|
||||||
|
.data(),
|
||||||
|
b"bark?"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn kdl_diagnostic() {
|
||||||
|
let mut kdl_diagnostic = KdlDiagnostic {
|
||||||
|
input: Arc::new("Catastrophic failure!!!".to_owned()),
|
||||||
|
span: SourceSpan::new(0.into(), 3),
|
||||||
|
message: None,
|
||||||
|
label: Some("cute".to_owned()),
|
||||||
|
help: Some("try harder?".to_owned()),
|
||||||
|
severity: Severity::Error,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Test `Error` impl
|
||||||
assert_eq!(kdl_diagnostic.to_string(), "Unexpected error");
|
assert_eq!(kdl_diagnostic.to_string(), "Unexpected error");
|
||||||
assert!(kdl_diagnostic.source().is_none());
|
assert!(kdl_diagnostic.source().is_none());
|
||||||
|
|
||||||
|
|
@ -143,5 +192,21 @@ mod tests {
|
||||||
|
|
||||||
assert_eq!(kdl_diagnostic.to_string(), "mega bad news, kiddo");
|
assert_eq!(kdl_diagnostic.to_string(), "mega bad news, kiddo");
|
||||||
assert!(kdl_diagnostic.source().is_none());
|
assert!(kdl_diagnostic.source().is_none());
|
||||||
|
|
||||||
|
// Test `Diagnostic` impl
|
||||||
|
let labels: Vec<_> = kdl_diagnostic.labels().unwrap().collect();
|
||||||
|
assert_eq!(labels.len(), 1);
|
||||||
|
assert_eq!(labels[0].label().unwrap(), "cute");
|
||||||
|
assert_eq!(
|
||||||
|
kdl_diagnostic
|
||||||
|
.source_code()
|
||||||
|
.unwrap()
|
||||||
|
.read_span(labels[0].inner(), 0, 0)
|
||||||
|
.unwrap()
|
||||||
|
.data(),
|
||||||
|
b"Cat"
|
||||||
|
);
|
||||||
|
assert_eq!(kdl_diagnostic.help().unwrap().to_string(), "try harder?");
|
||||||
|
assert_eq!(kdl_diagnostic.severity().unwrap(), Severity::Error);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue