balls 0.3.4

Git-native task tracker for parallel agent workflows
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

use serde::Deserialize;
use serde_json::Value;
use std::collections::BTreeMap;

/// What a plugin returns on stdout after a successful `push`.
/// Core stores this verbatim into `task.external.{plugin_name}`.
#[derive(Debug, Clone, Deserialize)]
pub struct PushResponse(pub serde_json::Map<String, Value>);

/// Full sync report returned by the plugin on stdout after `sync`.
#[derive(Debug, Clone, Deserialize)]
pub struct SyncReport {
    #[serde(default)]
    pub created: Vec<SyncCreate>,
    #[serde(default)]
    pub updated: Vec<SyncUpdate>,
    #[serde(default)]
    pub deleted: Vec<SyncDelete>,
}

/// A new task to create locally, reported by plugin sync.
#[derive(Debug, Clone, Deserialize)]
pub struct SyncCreate {
    pub title: String,
    #[serde(rename = "type", default = "default_task_type")]
    pub task_type: String,
    #[serde(default = "default_priority")]
    pub priority: u8,
    #[serde(default = "default_status")]
    pub status: String,
    #[serde(default)]
    pub description: String,
    #[serde(default)]
    pub tags: Vec<String>,
    #[serde(default)]
    pub external: serde_json::Map<String, Value>,
}

/// Fields to update on an existing local task.
#[derive(Debug, Clone, Deserialize)]
pub struct SyncUpdate {
    pub task_id: String,
    #[serde(default)]
    pub fields: BTreeMap<String, Value>,
    #[serde(default)]
    pub external: serde_json::Map<String, Value>,
    pub add_note: Option<String>,
}

/// A local task to mark as deferred.
#[derive(Debug, Clone, Deserialize)]
pub struct SyncDelete {
    pub task_id: String,
    #[serde(default)]
    pub reason: String,
}

/// A user-facing diagnostic emitted by a plugin on its diagnostics
/// channel (one JSON object per line on the fd referenced by
/// `BALLS_DIAG_FD`). Plugins that ignore the env var never write, and
/// the channel is a silent no-op for them.
#[derive(Debug, Clone, Deserialize)]
pub struct PluginDiagnostic {
    pub level: String,
    pub message: String,
    #[serde(default)]
    pub code: Option<String>,
    #[serde(default)]
    pub hint: Option<String>,
    #[serde(default)]
    pub task_id: Option<String>,
}

fn default_task_type() -> String {
    "task".into()
}
fn default_priority() -> u8 {
    3
}
fn default_status() -> String {
    "open".into()
}