taskdn 0.1.0

Rust library for parsing, querying, and manipulating Taskdn task files
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

//! Validation warnings for spec compliance.
//!
//! The parser validates required fields and formats. This module provides
//! additional validation for spec recommendations and advisory checks.

use std::path::Path;

/// A validation warning about spec compliance.
///
/// These are advisory - the data is still usable, but may not fully comply
/// with the Taskdn specification.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum ValidationWarning {
    /// The `projects` array has more than one element.
    /// Per spec, a task should belong to exactly one project.
    MultipleProjects {
        /// Number of projects in the array.
        count: usize,
    },

    /// A completed task (done/dropped) is missing the `completed-at` field.
    MissingCompletedAt,
}

impl ValidationWarning {
    /// Returns a human-readable message for this warning.
    #[must_use]
    pub fn message(&self) -> String {
        match self {
            Self::MultipleProjects { count } => {
                format!(
                    "projects array has {count} elements; spec requires exactly one project per task"
                )
            }
            Self::MissingCompletedAt => {
                "completed task is missing 'completed-at' field".to_string()
            }
        }
    }

    /// Returns a human-readable message with path context.
    #[must_use]
    pub fn message_with_path(&self, path: &Path) -> String {
        format!("{}: {}", path.display(), self.message())
    }
}

impl std::fmt::Display for ValidationWarning {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.message())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn multiple_projects_message() {
        let warning = ValidationWarning::MultipleProjects { count: 3 };
        assert!(warning.message().contains("3 elements"));
        assert!(warning.message().contains("exactly one"));
    }

    #[test]
    fn missing_completed_at_message() {
        let warning = ValidationWarning::MissingCompletedAt;
        assert!(warning.message().contains("completed-at"));
    }

    #[test]
    fn message_with_path() {
        let warning = ValidationWarning::MissingCompletedAt;
        let path = Path::new("/test/task.md");
        let msg = warning.message_with_path(path);
        assert!(msg.contains("/test/task.md"));
        assert!(msg.contains("completed-at"));
    }

    #[test]
    fn display_impl() {
        let warning = ValidationWarning::MultipleProjects { count: 2 };
        let display = format!("{warning}");
        assert!(display.contains("2 elements"));
    }
}