mc 0.1.11

Git-based knowledge management CLI — manage customers, projects, meetings, research and tasks with Markdown + YAML frontmatter
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

use std::path::PathBuf;
use thiserror::Error;

#[derive(Error, Debug)]
pub enum McError {
    #[error(
        "Could not find MissionControl repo root (looked for .mc/config.yml and config/config.yml)"
    )]
    RepoRootNotFound,

    #[error("Config file not found: {0}")]
    ConfigNotFound(PathBuf),

    #[error("Failed to parse config: {0}")]
    ConfigParse(String),

    #[error("Template not found: {0}")]
    TemplateNotFound(PathBuf),

    #[error("Entity not found: {0}")]
    EntityNotFound(String),

    #[error("Invalid ID format: {0}")]
    InvalidId(String),

    #[error("Frontmatter error in {path}: {message}")]
    Frontmatter { path: PathBuf, message: String },

    #[error("Validation failed: {0} issue(s) found")]
    ValidationFailed(usize),

    #[error("Already initialized: config exists at {0}")]
    AlreadyInitialized(PathBuf),

    #[error("{kind} entities are not available in embedded mode")]
    NotAvailableInMode { kind: String },

    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    #[error("YAML error: {0}")]
    Yaml(#[from] serde_yaml::Error),

    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    #[error("Zip error: {0}")]
    Zip(#[from] zip::result::ZipError),

    #[error("PDF generation error: {0}")]
    Pdf(String),

    #[error("{0}")]
    Other(String),
}

impl McError {
    /// Return an actionable hint for the user, if applicable.
    pub fn hint(&self) -> Option<String> {
        match self {
            McError::InvalidId(_) => Some(
                "Valid IDs look like CUST-001, PROJ-002, MTG-003, or RES-001.".into(),
            ),
            McError::EntityNotFound(_) => Some(
                "Try 'mc list customers' (or projects, meetings, research) to see available entities.".into(),
            ),
            McError::RepoRootNotFound => Some(
                "Run mc from inside a MissionControl repo, pass --root <path>, or run 'mc init' (or 'mc init --embedded') to create one.".into(),
            ),
            McError::AlreadyInitialized(_) => Some(
                "Use --force to reinitialize, or run mc init in a different directory.".into(),
            ),
            McError::TemplateNotFound(_) => Some(
                "Check that your templates/ directory contains the required .md templates.".into(),
            ),
            McError::NotAvailableInMode { .. } => Some(
                "Embedded mode (.mc/) only supports tasks, meetings, research, sprints, and proposals. Use a standalone repo for customers and projects.".into(),
            ),
            _ => None,
        }
    }
}

pub type McResult<T> = Result<T, McError>;