mirror of
https://github.com/nushell/nushell.git
synced 2025-04-09 13:28:50 +02:00
# Description This makes `LabeledError` much more capable of representing close to everything a `miette::Diagnostic` can, including `ShellError`, and allows plugins to generate multiple error spans, codes, help, etc. `LabeledError` is now embeddable within `ShellError` as a transparent variant. This could also be used to improve `error make` and `try/catch` to reflect `LabeledError` exactly in the future. Also cleaned up some errors in existing plugins. # User-Facing Changes Breaking change for plugins. Nicer errors for users.
162 lines
4.6 KiB
Rust
162 lines
4.6 KiB
Rust
use nu_protocol::{ast::CellPath, LabeledError, Span, Value};
|
|
use semver::{BuildMetadata, Prerelease, Version};
|
|
|
|
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
|
|
pub enum Action {
|
|
SemVerAction(SemVerAction),
|
|
Default,
|
|
}
|
|
|
|
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
|
|
pub enum SemVerAction {
|
|
Major,
|
|
Minor,
|
|
Patch,
|
|
}
|
|
|
|
#[derive(Default, Clone)]
|
|
pub struct Inc {
|
|
pub error: Option<String>,
|
|
pub cell_path: Option<CellPath>,
|
|
pub action: Option<Action>,
|
|
}
|
|
|
|
impl Inc {
|
|
pub fn new() -> Self {
|
|
Default::default()
|
|
}
|
|
|
|
fn apply(&self, input: &str, head: Span) -> Value {
|
|
match &self.action {
|
|
Some(Action::SemVerAction(act_on)) => {
|
|
let mut ver = match semver::Version::parse(input) {
|
|
Ok(parsed_ver) => parsed_ver,
|
|
Err(_) => return Value::string(input, head),
|
|
};
|
|
|
|
match act_on {
|
|
SemVerAction::Major => Self::increment_major(&mut ver),
|
|
SemVerAction::Minor => Self::increment_minor(&mut ver),
|
|
SemVerAction::Patch => Self::increment_patch(&mut ver),
|
|
}
|
|
|
|
Value::string(ver.to_string(), head)
|
|
}
|
|
Some(Action::Default) | None => {
|
|
if let Ok(v) = input.parse::<u64>() {
|
|
Value::string((v + 1).to_string(), head)
|
|
} else {
|
|
Value::string(input, head)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn increment_patch(v: &mut Version) {
|
|
v.patch += 1;
|
|
v.pre = Prerelease::EMPTY;
|
|
v.build = BuildMetadata::EMPTY;
|
|
}
|
|
|
|
pub fn increment_minor(v: &mut Version) {
|
|
v.minor += 1;
|
|
v.patch = 0;
|
|
v.pre = Prerelease::EMPTY;
|
|
v.build = BuildMetadata::EMPTY;
|
|
}
|
|
|
|
pub fn increment_major(v: &mut Version) {
|
|
v.major += 1;
|
|
v.minor = 0;
|
|
v.patch = 0;
|
|
v.pre = Prerelease::EMPTY;
|
|
v.build = BuildMetadata::EMPTY;
|
|
}
|
|
|
|
pub fn for_semver(&mut self, part: SemVerAction) {
|
|
if self.permit() {
|
|
self.action = Some(Action::SemVerAction(part));
|
|
} else {
|
|
self.log_error("can only apply one");
|
|
}
|
|
}
|
|
|
|
fn permit(&mut self) -> bool {
|
|
self.action.is_none()
|
|
}
|
|
|
|
fn log_error(&mut self, message: &str) {
|
|
self.error = Some(message.to_string());
|
|
}
|
|
|
|
pub fn usage() -> &'static str {
|
|
"Usage: inc field [--major|--minor|--patch]"
|
|
}
|
|
|
|
pub fn inc(&self, head: Span, value: &Value) -> Result<Value, LabeledError> {
|
|
if let Some(cell_path) = &self.cell_path {
|
|
let working_value = value.clone();
|
|
let cell_value = working_value.follow_cell_path(&cell_path.members, false)?;
|
|
|
|
let cell_value = self.inc_value(head, &cell_value)?;
|
|
|
|
let mut value = value.clone();
|
|
value.update_data_at_cell_path(&cell_path.members, cell_value)?;
|
|
Ok(value)
|
|
} else {
|
|
self.inc_value(head, value)
|
|
}
|
|
}
|
|
|
|
pub fn inc_value(&self, head: Span, value: &Value) -> Result<Value, LabeledError> {
|
|
match value {
|
|
Value::Int { val, .. } => Ok(Value::int(val + 1, head)),
|
|
Value::String { val, .. } => Ok(self.apply(val, head)),
|
|
x => {
|
|
let msg = x.coerce_string().map_err(|e| {
|
|
LabeledError::new("Unable to extract string").with_label(
|
|
format!("value cannot be converted to string {x:?} - {e}"),
|
|
head,
|
|
)
|
|
})?;
|
|
|
|
Err(LabeledError::new("Incorrect value").with_label(msg, head))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
mod semver {
|
|
use nu_protocol::{Span, Value};
|
|
|
|
use crate::inc::SemVerAction;
|
|
use crate::Inc;
|
|
|
|
#[test]
|
|
fn major() {
|
|
let expected = Value::test_string("1.0.0");
|
|
let mut inc = Inc::new();
|
|
inc.for_semver(SemVerAction::Major);
|
|
assert_eq!(inc.apply("0.1.3", Span::test_data()), expected)
|
|
}
|
|
|
|
#[test]
|
|
fn minor() {
|
|
let expected = Value::test_string("0.2.0");
|
|
let mut inc = Inc::new();
|
|
inc.for_semver(SemVerAction::Minor);
|
|
assert_eq!(inc.apply("0.1.3", Span::test_data()), expected)
|
|
}
|
|
|
|
#[test]
|
|
fn patch() {
|
|
let expected = Value::test_string("0.1.4");
|
|
let mut inc = Inc::new();
|
|
inc.for_semver(SemVerAction::Patch);
|
|
assert_eq!(inc.apply("0.1.3", Span::test_data()), expected)
|
|
}
|
|
}
|
|
}
|