waalge
/
aiken
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Preserve warning display rework, but without breaking the LSP quickfixes.

This commit is contained in:
KtorZ 2024-05-30 19:20:11 +02:00
parent 649e5163fc
commit e9e26b969a
No known key found for this signature in database
GPG Key ID: 33173CB6F77F4277
2 changed files with 140 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
crates/aiken-lang/src/tipo/error.rs
View File

@ -1475,31 +1475,29 @@ fn suggest_import_constructor() -> String {
#[derive(Debug, PartialEq, Clone, thiserror::Error, Diagnostic)]
pub enum Warning {
#[error("I found a record update using all fields; thus redundant.\n")]
#[error("I found a record update using all fields; thus redundant.")]
#[diagnostic(url("https://aiken-lang.org/language-tour/custom-types#record-updates"))]
#[diagnostic(code("record_update::all_fields"))]
AllFieldsRecordUpdate {
#[label]
#[label("redundant record update")]
location: Span,
},
#[error(
"I realized the following expression returned a result that is implicitly discarded.\n"
)]
#[error("I realized the following expression returned a result that is implicitly discarded.")]
#[diagnostic(help(
"You can use the '_' symbol should you want to explicitly discard a result."
))]
#[diagnostic(code("implicit_discard"))]
ImplicitlyDiscardedResult {
#[label]
#[label("implicitly discarded result")]
location: Span,
},
#[error("I found a record update with no fields; effectively updating nothing.\n")]
#[error("I found a record update with no fields; effectively updating nothing.")]
#[diagnostic(url("https://aiken-lang.org/language-tour/custom-types#record-updates"))]
#[diagnostic(code("record_update::no_fields"))]
NoFieldsRecordUpdate {
#[label]
#[label("useless record update")]
location: Span,
},
@ -1519,17 +1517,20 @@ pub enum Warning {
},
#[error(
"I found an {} trying to match a type with one constructor",
"expect".if_supports_color(Stderr, |s| s.purple())
"I found an {} {}",
"expect".if_supports_color(Stderr, |s| s.purple()),
"trying to match a type with one constructor".if_supports_color(Stderr, |s| s.yellow())
)]
#[diagnostic(
code("single_constructor_expect"),
help(
"If your type has one constructor, unless you are casting {} {}, you can\nprefer using a {} binding like so...\n\n{}",
"from".if_supports_color(Stderr, |s| s.bold()),
"Data".if_supports_color(Stderr, |s| s.bright_blue()),
"Data"
.if_supports_color(Stderr, |s| s.bold())
.if_supports_color(Stderr, |s| s.bright_blue()),
"let".if_supports_color(Stderr, |s| s.purple()),
format_suggestion(sample)
format_suggestion(sample),
)
)]
SingleConstructorExpect {
@ -1542,7 +1543,7 @@ pub enum Warning {
sample: UntypedExpr,
},
#[error("I found a todo left in the code.\n")]
#[error("I found a todo left in the code.")]
#[diagnostic(help("You probably want to replace that with actual code... eventually."))]
#[diagnostic(code("todo"))]
Todo {
@ -1551,7 +1552,7 @@ pub enum Warning {
tipo: Rc<Type>,
},
#[error("I found a type hole in an annotation.\n")]
#[error("I found a type hole in an annotation.")]
#[diagnostic(code("unexpected::type_hole"))]
UnexpectedTypeHole {
#[label("{}", tipo.to_pretty(0))]
@ -1560,93 +1561,95 @@ pub enum Warning {
},
#[error(
"I discovered an unused constructor: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I discovered an unused constructor: {}",
name.if_supports_color(Stderr, |s| s.default_color())
)]
#[diagnostic(help(
"No big deal, but you might want to remove it to get rid of that warning."
))]
#[diagnostic(code("unused::constructor"))]
UnusedConstructor {
#[label]
#[label("unused constructor")]
location: Span,
name: String,
},
#[error(
"I discovered an unused imported module: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I discovered an unused imported module: {}",
name.if_supports_color(Stderr, |s| s.default_color()),
)]
#[diagnostic(help(
"No big deal, but you might want to remove it to get rid of that warning."
))]
#[diagnostic(code("unused::import::module"))]
UnusedImportedModule {
#[label]
#[label("unused module")]
location: Span,
name: String,
},
#[error(
"I discovered an unused imported value: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple()),
"I discovered an unused imported value: {}",
name.if_supports_color(Stderr, |s| s.default_color()),
)]
#[diagnostic(help(
"No big deal, but you might want to remove it to get rid of that warning."
))]
#[diagnostic(code("unused:import::value"))]
UnusedImportedValueOrType {
#[label]
#[label("unused import")]
location: Span,
name: String,
},
#[error(
"I found an unused private function: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple()),
"I found an unused private function: {}",
name.if_supports_color(Stderr, |s| s.default_color()),
)]
#[diagnostic(help(
"Perhaps your forgot to make it public using the '{keyword_pub}' keyword?\n\
"Perhaps your forgot to make it public using the {keyword_pub} keyword?\n\
Otherwise, you might want to get rid of it altogether.",
keyword_pub = "pub".if_supports_color(Stderr, |s| s.bright_blue())
))]
#[diagnostic(code("unused::function"))]
UnusedPrivateFunction {
#[label]
#[label("unused (private) function")]
location: Span,
name: String,
},
#[error(
"I found an unused (private) module constant: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I found an unused (private) module constant: {}",
name.if_supports_color(Stderr, |s| s.default_color()),
)]
#[diagnostic(help(
"Perhaps your forgot to make it public using the '{keyword_pub}' keyword?\n\
"Perhaps your forgot to make it public using the {keyword_pub} keyword?\n\
Otherwise, you might want to get rid of it altogether.",
keyword_pub = "pub".if_supports_color(Stderr, |s| s.bright_blue())
))]
#[diagnostic(code("unused::constant"))]
UnusedPrivateModuleConstant {
#[label]
#[label("unused (private) constant")]
location: Span,
name: String,
},
#[error(
"I discovered an unused type: '{}'.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I discovered an unused type: {}",
name
.if_supports_color(Stderr, |s| s.bright_blue())
.if_supports_color(Stderr, |s| s.bold())
)]
#[diagnostic(code("unused::type"))]
UnusedType {
#[label]
#[label("unused (private) type")]
location: Span,
name: String,
},
#[error(
"I came across an unused variable: {}.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I came across an unused variable: {}",
name.if_supports_color(Stderr, |s| s.default_color()),
)]
#[diagnostic(help("{}", formatdoc! {
r#"No big deal, but you might want to remove it or use a discard {name} to get rid of that warning.
@ -1663,14 +1666,14 @@ pub enum Warning {
}))]
#[diagnostic(code("unused::variable"))]
UnusedVariable {
#[label("unused")]
#[label("unused identifier")]
location: Span,
name: String,
},
#[error(
"I came across a discarded variable in a let assignment: {}.\n",
name.if_supports_color(Stderr, |s| s.purple())
"I came across a discarded variable in a let assignment: {}",
name.if_supports_color(Stderr, |s| s.default_color())
)]
#[diagnostic(help("{}", formatdoc! {
r#"If you do want to enforce some side-effects, use {keyword_expect} with {name} instead of {keyword_let}.
@ -1685,14 +1688,15 @@ pub enum Warning {
}))]
#[diagnostic(code("unused::discarded_let_assignment"))]
DiscardedLetAssignment {
#[label("discarded")]
#[label("discarded result")]
location: Span,
name: String,
},
#[error(
"I came across a validator in a {} module which means\nI'm going to ignore it.\n",
"lib/".if_supports_color(Stderr, |s| s.purple())
"I came across a validator in a {} {}",
"lib/".if_supports_color(Stderr, |s| s.purple()),
"module which means\nI'm going to ignore it.\n".if_supports_color(Stderr, |s| s.yellow()),
)]
#[diagnostic(help(
"No big deal, but you might want to move it to a {} module\nor remove it to get rid of that warning.",
@ -1700,15 +1704,16 @@ pub enum Warning {
))]
#[diagnostic(code("unused::validator"))]
ValidatorInLibraryModule {
#[label("unused")]
#[label("unused validator")]
location: Span,
},
#[error(
"I noticed a suspicious {type_ByteArray} UTF-8 literal which resembles a hash digest.",
"I noticed a suspicious {type_ByteArray} {tail}",
type_ByteArray = "ByteArray"
.if_supports_color(Stderr, |s| s.bright_blue())
.if_supports_color(Stderr, |s| s.bold())
.if_supports_color(Stderr, |s| s.bold()),
tail = "UTF-8 literal which resembles a hash digest.".if_supports_color(Stderr, |s| s.yellow()),
)]
#[diagnostic(help("{}", formatdoc! {
r#"When you specify a {type_ByteArray} literal using plain double-quotes, it's interpreted as an array of UTF-8 bytes. For example, the literal {literal_foo} is interpreted as the byte sequence {foo_bytes}.
@ -1793,11 +1798,9 @@ fn format_suggestion(sample: &UntypedExpr) -> String {
.enumerate()
.map(|(ix, line)| {
if ix == 0 {
format!("╰─▶ {}", line.if_supports_color(Stdout, |s| s.yellow()))
format!("╰─▶ {line}")
} else {
format!(" {line}")
.if_supports_color(Stdout, |s| s.yellow())
.to_string()
}
})
.collect::<Vec<_>>()

122
crates/aiken-project/src/error.rs
View File

@ -1,4 +1,4 @@
use crate::{blueprint::error as blueprint, deps::manifest::Package, package_name::PackageName};
use crate::{blueprint, deps::manifest::Package, package_name::PackageName};
use aiken_lang::{
ast::{self, Span},
error::ExtraData,
@ -6,7 +6,8 @@ use aiken_lang::{
tipo,
};
use miette::{
Diagnostic, EyreContext, LabeledSpan, MietteHandlerOpts, NamedSource, RgbColors, SourceCode,
Diagnostic, EyreContext, LabeledSpan, MietteHandler, MietteHandlerOpts, NamedSource, RgbColors,
SourceCode,
};
use owo_colors::{
OwoColorize,
@ -157,20 +158,11 @@ impl Error {
impl Debug for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let miette_handler = MietteHandlerOpts::new()
// For better support of terminal themes use the ANSI coloring
.rgb_colors(RgbColors::Never)
// If ansi support is disabled in the config disable the eye-candy
.color(true)
.unicode(true)
.terminal_links(true)
.build();
// Ignore error to prevent format! panics. This can happen if span points at some
// inaccessible location, for example by calling `report_error()` with wrong working set.
let _ = miette_handler.debug(self, f);
Ok(())
default_miette_handler(2)
.debug(self, f)
// Ignore error to prevent format! panics. This can happen if span points at some
// inaccessible location, for example by calling `report_error()` with wrong working set.
.or(Ok(()))
}
}
@ -504,9 +496,9 @@ impl Diagnostic for Error {
#[derive(thiserror::Error)]
pub enum Warning {
#[error("{}", "You do not have any validators to build!".if_supports_color(Stderr, |s| s.yellow()))]
#[error("You do not have any validators to build!")]
NoValidators,
#[error("{}", "While trying to make sense of your code...".if_supports_color(Stderr, |s| s.yellow()))]
#[error("{}", warning)]
Type {
path: PathBuf,
src: String,
@ -514,9 +506,9 @@ pub enum Warning {
#[source]
warning: tipo::error::Warning,
},
#[error("{}", format!("{name} is already a dependency.").if_supports_color(Stderr, |s| s.yellow()))]
#[error("{name} is already a dependency.")]
DependencyAlreadyExists { name: PackageName },
#[error("{}", format!("Ignoring file with invalid module name at: {path:?}").if_supports_color(Stderr, |s| s.yellow()))]
#[error("Ignoring file with invalid module name at: {path:?}")]
InvalidModuleName { path: PathBuf },
}
@ -573,7 +565,17 @@ impl Diagnostic for Warning {
}
fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
None
match self {
Warning::Type { warning, .. } => Some(Box::new(format!(
"aiken::check{}",
warning.code().map(|s| format!("::{s}")).unwrap_or_default()
))),
Warning::NoValidators => Some(Box::new("aiken::check")),
Warning::InvalidModuleName { .. } => Some(Box::new("aiken::project::module_name")),
Warning::DependencyAlreadyExists { .. } => {
Some(Box::new("aiken::packages::already_exists"))
}
}
}
fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
@ -607,20 +609,63 @@ impl Warning {
impl Debug for Warning {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let miette_handler = MietteHandlerOpts::new()
// For better support of terminal themes use the ANSI coloring
.rgb_colors(RgbColors::Never)
// If ansi support is disabled in the config disable the eye-candy
.color(true)
.unicode(true)
.terminal_links(true)
.build();
default_miette_handler(0)
.debug(
&DisplayWarning {
title: &self.to_string(),
source_code: self.source_code(),
labels: self.labels().map(|ls| ls.collect()),
help: self.help().map(|s| s.to_string()),
},
f,
)
// Ignore error to prevent format! panics. This can happen if span points at some
// inaccessible location, for example by calling `report_error()` with wrong working set.
.or(Ok(()))
}
}
// Ignore error to prevent format! panics. This can happen if span points at some
// inaccessible location, for example by calling `report_error()` with wrong working set.
let _ = miette_handler.debug(self, f);
#[derive(thiserror::Error)]
#[error("{}", title.if_supports_color(Stderr, |s| s.yellow()))]
struct DisplayWarning<'a> {
title: &'a str,
source_code: Option<&'a dyn miette::SourceCode>,
labels: Option<Vec<LabeledSpan>>,
help: Option<String>,
}
Ok(())
impl<'a> Diagnostic for DisplayWarning<'a> {
fn severity(&self) -> Option<miette::Severity> {
Some(miette::Severity::Warning)
}
fn source_code(&self) -> Option<&dyn SourceCode> {
self.source_code
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>> {
self.labels
.as_ref()
.map(|ls| ls.iter().cloned())
.map(Box::new)
.map(|b| b as Box<dyn Iterator<Item = LabeledSpan>>)
}
fn code<'b>(&'b self) -> Option<Box<dyn Display + 'b>> {
None
}
fn help<'b>(&'b self) -> Option<Box<dyn Display + 'b>> {
self.help
.as_ref()
.map(Box::new)
.map(|b| b as Box<dyn Display + 'b>)
}
}
impl<'a> Debug for DisplayWarning<'a> {
fn fmt(&self, _f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
unreachable!("Display warning are never shown directly.");
}
}
@ -631,3 +676,14 @@ pub struct Unformatted {
pub input: String,
pub output: String,
}
fn default_miette_handler(context_lines: usize) -> MietteHandler {
MietteHandlerOpts::new()
// For better support of terminal themes use the ANSI coloring
.rgb_colors(RgbColors::Never)
// If ansi support is disabled in the config disable the eye-candy
.unicode(true)
.terminal_links(true)
.context_lines(context_lines)
.build()
}