git-vet 0.4.0

Git-based review gate for tracked file contents
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
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
117
118
119

use std::fmt;

use thiserror::Error;

use crate::channel::ChannelTransferError;
use crate::path::{PathError, RepoPath, RepoPathScope};
use crate::remote::RemoteError;

#[derive(Debug, Error)]
pub enum AppError {
    #[error("git operation failed while {operation}: {details}")]
    Git {
        operation: &'static str,
        details: String,
    },
    #[error("repository has no worktree")]
    MissingWorktree,
    #[error("path is not valid UTF-8")]
    NonUtf8Path,
    #[error("path escapes the repository root")]
    PathOutsideRepo,
    #[error("path must be absolute")]
    NonAbsolutePath,
    #[error("empty paths are not valid tracked files")]
    EmptyPath,
    #[error("repo path is invalid: {details}")]
    InvalidRepoPath { details: &'static str },
    #[error("path is not tracked at HEAD: {0}")]
    PathNotTracked(RepoPath),
    #[error("pathspec did not match any tracked files at HEAD: {0}")]
    PathspecNotMatched(RepoPathScope),
    #[error("path is a submodule/gitlink and is out of scope: {0}")]
    PathIsSubmodule(RepoPath),
    #[error("failed to read vetignore file: {0}")]
    Vetignore(String),
    #[error("missing git config user.name")]
    MissingUserName,
    #[error("missing git config user.email")]
    MissingUserEmail,
    #[error("git config {key} is not valid UTF-8: {details}")]
    NonUtf8GitConfig { key: &'static str, details: String },
    #[error(
        "target paths have uncommitted working-tree changes; rerun with --allow-dirty to proceed with committed HEAD contents"
    )]
    DirtyPathsRequireAllowDirty,
    #[error("aborted because target paths have uncommitted working-tree changes")]
    DirtyPathsDeclined,
    #[error("invalid review channel {channel:?}: {details}")]
    InvalidChannel { channel: String, details: String },
    #[error("source and destination channels must differ")]
    SameChannelTransfer,
    #[error("source channel {channel:?} has no local review notes")]
    MissingSourceChannelNotes { channel: String },
    #[error("review channel {channel:?} does not exist locally")]
    MissingChannelNotes { channel: String },
    #[error("destination channel {channel:?} already has local review notes")]
    ExistingDestinationChannelNotes { channel: String },
    #[error("source channel {channel:?} has a symbolic notes ref; expected a direct ref")]
    SymbolicChannelNotesRef { channel: String },
    #[error("--channel cannot be used with `{command}`; pass SOURCE and DESTINATION explicitly")]
    ChannelOptionNotAllowed { command: &'static str },
    #[error("--channel cannot be used with `channel list`; listing is not channel-scoped")]
    ChannelOptionNotAllowedForList,
    #[error("--channel cannot be used with `channel remove`; pass CHANNEL explicitly")]
    ChannelOptionNotAllowedForRemove,
    #[error(
        "--channel cannot be used with `install-man`; manual installation is not channel-scoped"
    )]
    ChannelOptionNotAllowedForInstallMan,
    #[error("failed to install manual: {details}")]
    ManPageInstall { details: String },
    #[error("aborted removing review channel")]
    ChannelRemovalDeclined,
    #[error("non-interactive channel removal requires --force")]
    ChannelRemovalRequiresForce,
    #[error("sync remote error: {0}")]
    Remote(#[from] RemoteError),
    #[error("terminal interaction failed: {0}")]
    Dialog(#[from] dialoguer::Error),
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),
}

impl From<ChannelTransferError> for AppError {
    fn from(error: ChannelTransferError) -> Self {
        match error {
            ChannelTransferError::SameChannel => Self::SameChannelTransfer,
        }
    }
}

impl From<PathError> for AppError {
    fn from(error: PathError) -> Self {
        match error {
            PathError::NonUtf8 => Self::NonUtf8Path,
            PathError::OutsideRepo => Self::PathOutsideRepo,
            PathError::NonAbsolute => Self::NonAbsolutePath,
            PathError::EmptyPath => Self::EmptyPath,
            PathError::EmptyComponent => Self::InvalidRepoPath {
                details: "path contains an empty component",
            },
            PathError::CurrentDirComponent => Self::InvalidRepoPath {
                details: "path contains a current-directory component",
            },
            PathError::NulByte => Self::InvalidRepoPath {
                details: "path contains a NUL byte",
            },
        }
    }
}

pub(crate) fn git_error(operation: &'static str, source: impl fmt::Display) -> AppError {
    AppError::Git {
        operation,
        details: source.to_string(),
    }
}