ghtui 0.2.0

A keyboard-driven terminal client for GitHub, with a pull request diff viewer that goes further than GitHub's
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

//! Review threads and draft comments as shown in the diff.
//!
//! Both GitHub threads and local drafts become [`Annotation`]s anchored by
//! file path, side and line number (never by row). Line annotations show a
//! gutter marker and expand in place below their line; file-level comments,
//! and outdated threads that can't be mapped onto the current diff, sit
//! under the file header.

use crate::diff::anchor::LinePos;

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AnnotationKey {
    Thread(crate::api::model::NodeId),
    Draft(u64),
    /// A check run's annotation on the head, by its place among them.
    Check(usize),
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AnnotationComment {
    pub author: String,
    pub body: String,
    /// ISO 8601; empty for drafts.
    pub created_at: String,
    /// In the viewer's unsubmitted review on GitHub.
    pub pending: bool,
    /// Came in since you started looking.
    pub new: bool,
    /// What edits name it by, what you may do to it, and its reactions;
    /// `None` for a draft.
    pub editable: Option<crate::api::edit::Editable>,
}

/// Where an annotation sits in the current diff.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Place {
    /// On the whole file.
    File { outdated: bool },
    /// On a current line, or lines `start..=at.line` when `start` is set.
    Line { at: LinePos, start: Option<u32> },
    /// Outdated, but its line still exists unchanged and it was moved there.
    Moved(LinePos),
    /// Outdated and not mapped onto the current diff, with the line it was
    /// written on, if known.
    Outdated(Option<u32>),
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Annotation {
    pub key: AnnotationKey,
    pub path: String,
    pub place: Place,
    pub resolved: bool,
    pub comments: Vec<AnnotationComment>,
    /// Replies on GitHub between the first comment and the rest, not
    /// fetched (a thread brings its first comment and its newest 99).
    pub left_out: u64,
    /// For drafts: GitHub's reason for rejecting it last time.
    pub error: Option<String>,
    pub can_reply: bool,
    pub can_resolve: bool,
    pub can_unresolve: bool,
    /// Started since you started looking.
    pub new: bool,
}

impl Annotation {
    pub fn is_draft(&self) -> bool {
        matches!(self.key, AnnotationKey::Draft(_))
    }

    /// Placed on a line (as opposed to under the file header).
    pub fn on_line(&self) -> Option<LinePos> {
        match self.place {
            Place::Line { at, .. } | Place::Moved(at) => Some(at),
            Place::File { .. } | Place::Outdated(_) => None,
        }
    }

    /// Expanded unless resolved (drafts are always open).
    pub fn open_by_default(&self) -> bool {
        self.is_draft() || !self.resolved
    }
}

/// What a thread row shows.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ThreadRowKind {
    /// A collapsed thread under a file header: one summary line.
    Summary,
    /// A comment's author line; `first` also carries the thread's state.
    Head {
        comment: usize,
        first: bool,
    },
    Body,
    /// The reactions under comment `comment`.
    Reactions {
        comment: usize,
    },
    /// The replies left out, after the first comment.
    Gap,
    /// Why GitHub rejected a draft.
    Error,
    Footer,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ThreadRow {
    /// Index into `Doc::annotations`.
    pub ann: u32,
    pub kind: ThreadRowKind,
    /// What it says: a line of a comment's rendered Markdown, or plain
    /// text.
    pub line: crate::ui::comment::CommentLine,
}