task-commander 0.0.1

TaskCommander
Documentation 
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

//! # Definition of result and errors

use antex::{ColorMode, StyledText, Text};

/// Common result type.
pub type Result<T, E = TaskCommanderError> = std::result::Result<T, E>;

/// Errors.
#[derive(PartialEq, Eq)]
pub enum TaskCommanderError {
    SpawnCommandFailed(String),
    DuplicatedTask(String),
    TaskNotFound(String),
    DependencyCycle(String),
    UnexpectedNode(String),
    ZeroOrOneAttributeAllowed(String),
    MissingDefinitions,
}

impl TaskCommanderError {
    /// Returns a colored error message.
    #[must_use]
    pub fn as_text(&self, cm: ColorMode) -> Text {
        match self {
            Self::SpawnCommandFailed(reason) => Text::new(cm)
                .s("failed to spawn command, reason: ")
                .cyan()
                .s(reason)
                .reset(),
            Self::DuplicatedTask(name) => {
                Text::new(cm).s("duplicated task: ").cyan().s(name).reset()
            }
            Self::TaskNotFound(name) => Text::new(cm).s("task not found: ").cyan().s(name).reset(),
            Self::DependencyCycle(name) => Text::new(cm)
                .s("dependency cycle for task: ")
                .cyan()
                .s(name)
                .reset(),
            Self::UnexpectedNode(name) => {
                Text::new(cm).s("unexpected node: ").cyan().s(name).reset()
            }
            Self::ZeroOrOneAttributeAllowed(name) => Text::new(cm)
                .s("at most one attribute '")
                .cyan()
                .s(name)
                .reset()
                .s("' allowed"),
            Self::MissingDefinitions => {
                Text::new(cm).s("task definitions file is missing or inaccessible")
            }
        }
    }
}

#[must_use]
pub const fn err_command_spawn(reason: String) -> TaskCommanderError {
    TaskCommanderError::SpawnCommandFailed(reason)
}

#[must_use]
pub const fn err_duplicated_task(task_name: String) -> TaskCommanderError {
    TaskCommanderError::DuplicatedTask(task_name)
}

#[must_use]
pub const fn err_task_not_found(name: String) -> TaskCommanderError {
    TaskCommanderError::TaskNotFound(name)
}

#[must_use]
pub const fn err_dependency_cycle(name: String) -> TaskCommanderError {
    TaskCommanderError::DependencyCycle(name)
}

#[must_use]
pub const fn err_unexpected_node(name: String) -> TaskCommanderError {
    TaskCommanderError::UnexpectedNode(name)
}

#[must_use]
pub const fn err_zero_or_one_attribute_allowed(name: String) -> TaskCommanderError {
    TaskCommanderError::ZeroOrOneAttributeAllowed(name)
}

#[must_use]
pub const fn err_definitions_not_found() -> TaskCommanderError {
    TaskCommanderError::MissingDefinitions
}