nu_plugin_semver 0.11.11

A nushell plugin for dealing with SemVer versions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use nu_plugin::{EvaluatedCall, SimplePluginCommand};
use nu_protocol::{Example, LabeledError, Signature, Spanned, SyntaxShape, Type, Value};

use crate::{SemverPlugin, custom_value::SemverCustomValue, version::Level};

use super::custom_type;

pub struct SemverBump;

impl SimplePluginCommand for SemverBump {
    type Plugin = SemverPlugin;

    fn name(&self) -> &str {
        "semver bump"
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
                .switch(
                    "ignore-errors",
                    "If the input is not a valid SemVer version, return the original string unchanged without raising an error",
                    Some('i')
                )
                .named(
                    "build-metadata",
                    SyntaxShape::String,
                    "Additionally set the build metadata",
                    Some('b')
                )
                .required(
                    "level",
                    SyntaxShape::String,
                    "The version level to bump. Valid values are: major, minor, patch, alpha, beta, rc, or release."
                )
                .input_output_types(vec![
                    (Type::String, custom_type()),
                    (custom_type(), custom_type()),
                ])
    }

    fn description(&self) -> &str {
        "Bump the version to the next level"
    }

    fn examples(&'_ self) -> Vec<Example<'_>> {
        vec![
            Example {
                example: r#""1.2.3-alpha.1+build" | semver bump major"#,
                description: "Bump major version",
                result: Some(SemverCustomValue::test_value("2.0.0")),
            },
            Example {
                example: r#""1.2.3-alpha.1+build" | semver bump minor"#,
                description: "Bump minor version",
                result: Some(SemverCustomValue::test_value("1.3.0")),
            },
            Example {
                example: r#""1.2.3+build" | semver bump patch"#,
                description: "Bump patch version with build metadata",
                result: Some(SemverCustomValue::test_value("1.2.4")),
            },
            Example {
                example: r#""1.2.3-alpha.1+build" | semver bump patch"#,
                description: "Bump patch version from pre-release",
                result: Some(SemverCustomValue::test_value("1.2.3+build")),
            },
            Example {
                example: r#""1.2.3-alpha.1+build" | semver bump alpha"#,
                description: "Bump current alpha pre-release to next alpha pre-release",
                result: Some(SemverCustomValue::test_value("1.2.3-alpha.2+build")),
            },
            Example {
                example: r#""1.2.3" | semver bump alpha"#,
                description: "Bump version to next alpha pre-release",
                result: Some(SemverCustomValue::test_value("1.2.4-alpha.1")),
            },
            Example {
                example: r#""1.2.3-rc.1" | semver bump release"#,
                description: "Release the current pre-release version",
                result: Some(SemverCustomValue::test_value("1.2.3")),
            },
        ]
    }

    fn run(
        &self,
        _plugin: &Self::Plugin,
        _engine: &nu_plugin::EngineInterface,
        call: &EvaluatedCall,
        input: &Value,
    ) -> Result<Value, LabeledError> {
        let ignore_errors = call.has_flag("ignore-errors")?;
        let span = call.head;

        let res = {
            let mut version: SemverCustomValue = input.try_into()?;
            let level: Spanned<String> = call.req(0)?;
            let level = level.item.parse::<Level>().map_err(|e| {
                LabeledError::new("Valid levels are: major, minor, patch, alpha, beta, rc")
                    .with_label(e.to_string(), level.span)
            })?;
            let meta: Option<String> = call.get_flag("build-metadata")?;

            version
                .bump(level, meta)
                .map_err(|e| e.into_labeled_error(span))?;

            Ok(version)
        };

        match res {
            Ok(v) => Ok(v.into_value(span)),
            Err(e) => {
                if ignore_errors {
                    Ok(input.clone())
                } else {
                    Err(e)
                }
            }
        }
    }
}