forked from steveukx/git-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
response.d.ts
197 lines (164 loc) · 4.37 KB
/
response.d.ts
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
import { DefaultLogFields } from '../src/lib/tasks/log';
export interface CommitSummary {
author: null | {
email: string;
name: string;
};
branch: string;
commit: string;
summary: {
changes: number;
insertions: number;
deletions: number;
};
}
export interface DiffResultTextFile {
file: string;
changes: number;
insertions: number;
deletions: number;
binary: boolean;
}
export interface DiffResultBinaryFile {
file: string;
before: number;
after: number;
binary: boolean;
}
export interface DiffResult {
/** The total number of files changed as reported in the summary line */
changed: number;
/** When present in the diff, lists the details of each file changed */
files: Array<DiffResultTextFile | DiffResultBinaryFile>;
/** The number of files changed with insertions */
insertions: number;
/** The number of files changed with deletions */
deletions: number;
}
export interface FetchResult {
raw: string;
remote: string | null;
branches: {
name: string;
tracking: string;
}[];
tags: {
name: string;
tracking: string;
}[];
}
export interface MoveSummary {
moves: any[];
}
export interface PullResult {
/** Array of all files that are referenced in the pull */
files: string[];
/** Map of file names to the number of insertions in that file */
insertions: { [key: string]: number };
/** Map of file names to the number of deletions in that file */
deletions: any;
summary: {
changes: number;
insertions: number;
deletions: number;
};
/** Array of file names that have been created */
created: string[];
/** Array of file names that have been deleted */
deleted: string[];
}
export interface StatusResultRenamed {
from: string;
to: string;
}
export interface FileStatusResult {
/** Original location of the file, when the file has been moved */
from?: string
/** Path of the file */
path: string;
/** First digit of the status code of the file, e.g. 'M' = modified.
Represents the status of the index if no merge conflicts, otherwise represents
status of one side of the merge. */
index: string;
/** Second digit of the status code of the file. Represents status of the working directory
if no merge conflicts, otherwise represents status of other side of a merge. */
working_dir: string;
}
export interface StatusResult {
not_added: string[];
conflicted: string[];
created: string[];
deleted: string[];
modified: string[];
renamed: StatusResultRenamed[];
staged: string[];
files: FileStatusResult[];
ahead: number;
behind: number;
current: string | null;
tracking: string | null;
/**
* Gets whether this represents a clean working branch.
*/
isClean(): boolean;
}
/**
* Response retrieved when using the `git.tags` method
*/
export interface TagResult {
/**
* All tag names
*/
all: string[];
/**
* The semver latest tag name or `undefined` when no tags are named in the response
*/
latest: string | undefined;
}
/**
* The ListLogLine represents a single entry in the `git.log`, the properties on the object
* are mixed in depending on the names used in the format (see `DefaultLogFields`), but some
* properties are dependent on the command used.
*/
export interface ListLogLine {
/**
* When using a `--stat=4096` or `--shortstat` options in the `git.log` or `git.stashList`,
* each entry in the `ListLogSummary` will also have a `diff` property representing as much
* detail as was given in the response.
*/
diff?: DiffResult;
}
export interface ListLogSummary<T = DefaultLogFields> {
all: ReadonlyArray<T & ListLogLine>;
total: number;
latest: T & ListLogLine;
}
/**
* Where the file was deleted, if there is a modify/delete conflict
*/
export interface MergeConflictDeletion {
deleteRef: string;
}
/**
* Represents a single file with conflicts in the MergeSummary
*/
export interface MergeConflict {
/**
* Type of conflict
*/
reason: string;
/**
* Path to file
*/
file: string;
/**
* Additional detail for the specific type of conflict
*/
meta?: MergeConflictDeletion;
}
export interface MergeSummary extends PullResult {
conflicts: MergeConflict[];
merges: string[];
result: 'success' | string;
readonly failed: boolean;
}