Repository navigation
Expand file tree
/
Copy pathexport.js
More file actions
232 lines (219 loc) · 6.66 KB
/
Copy pathexport.js
File metadata and controls
232 lines (219 loc) · 6.66 KB
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// const csv = require("csv");
const fs = require("fs");
const converter = require("json-2-csv");
// Gets a single comment
const getComment = async (octokit, values, issueNumber) => {
return new Promise((resolve, reject) => {
const issueOptions = octokit.issues.listComments.endpoint.merge({
owner: values.userOrOrganization,
repo: values.repo,
issue_number: issueNumber,
});
octokit.paginate(issueOptions).then(
(commentsData) => {
resolve(commentsData);
},
(err) => {
console.error(err);
reject(err);
}
);
});
};
// Given the full list of issues, returns back an array of all comments,
// each with the issue data also included.
const getFullCommentData = async (octokit, values, data, verbose = false) => {
const fullComments = [];
for (let i = 0; i < data.length; i++) {
const issueObject = data[i];
fullComments.push({
issue: issueObject,
});
if (verbose === true) {
console.log("getting comments for issue #: ", issueObject.number);
}
const commentsData = await getComment(octokit, values, issueObject.number);
commentsData.forEach((comment) => {
fullComments.push({
issue: issueObject,
comment: {
user: comment.user.login,
created_at: comment.created_at,
updated_at: comment.updated_at,
body: comment.body,
},
});
});
}
return fullComments;
};
const writeFile = async (data, fileName = false) => {
return new Promise((resolve, reject) => {
converter.json2csv(
data,
(err, csvString) => {
if (err) {
reject(new Error("Invalid!"));
}
if (!fileName) {
const now = new Date();
fileName = `${now.getFullYear()}-${twoPadNumber(
now.getMonth() + 1
)}-${twoPadNumber(now.getDate())}-${twoPadNumber(
now.getHours()
)}-${twoPadNumber(now.getMinutes())}-${twoPadNumber(
now.getSeconds()
)}-issues.csv`;
}
fs.writeFile(fileName, csvString, "utf8", function (err) {
if (err) {
reject(new Error("Error writing the file."));
} else {
resolve(fileName);
}
});
},
{
emptyFieldValue: "",
}
);
});
};
const twoPadNumber = (number) => {
return String(number).padStart(2, "0");
};
const defaultExportColumns = (data) => {
return data.map((issueObject) => {
const ret = {
number: issueObject.number,
title: issueObject.title,
state: issueObject.state,
labels: "", // will be filled in below, if it exists
milestone: "", // will be filled in below, if it exists
user: "", // will be filled in below, if it exists
assignee: "", // will be filled in below, if it exists
assignees: "", // will be filled in below, if it exists
created_at: issueObject.created_at,
updated_at: issueObject.updated_at,
closed_at: issueObject.closed_at !== null ? issueObject.closed_at : "",
body: issueObject.body,
};
if (issueObject.user) {
ret.user = issueObject.user.login;
}
if (issueObject.labels) {
ret.labels = issueObject.labels
.map((labelObject) => {
return labelObject.name;
})
.join(",");
}
if (issueObject.assignee && issueObject.assignee.login) {
ret.assignee = issueObject.assignee.login;
}
if (issueObject.assignees && issueObject.assignees.length > 0) {
ret.assignees = issueObject.assignees
.map((assigneeObject) => {
return assigneeObject.login;
})
.join(",");
}
if (issueObject.milestone && issueObject.milestone.title) {
ret.milestone = issueObject.milestone.title;
}
return ret;
});
};
const getDataAttribute = (issueObject, attribute) => {
if (attribute.indexOf(".") > 0) {
const parts = attribute.split(".");
let currentObject = issueObject;
parts.forEach((part) => {
if (
currentObject &&
currentObject !== "" &&
Object.prototype.hasOwnProperty.call(currentObject, part)
) {
currentObject = currentObject[part];
} else {
currentObject = "";
}
});
return currentObject;
} else {
return issueObject[attribute];
}
};
const specificAttributeColumns = (data, attributes) => {
return data.map((issueObject) => {
const ret = {};
attributes.forEach((attribute) => {
ret[attribute] = getDataAttribute(issueObject, attribute);
});
return ret;
});
};
const exportIssues = (octokit, values) => {
// Getting all the issues:
const options = octokit.issues.listForRepo.endpoint.merge({
owner: values.userOrOrganization,
repo: values.repo,
state: "all",
});
octokit.paginate(options).then(
async (data) => {
// default export - columns that are compatible to be imported into GitHub
let filteredData = defaultExportColumns(data);
if (values.exportAll) {
// Just pass "data", it will flatten the JSON object we got from the API and use that (lots of data!)
filteredData = data;
} else if (values.exportAttributes) {
filteredData = specificAttributeColumns(data, values.exportAttributes);
}
// Add on comments, if requested.
let csvData = filteredData;
if (values.exportComments === true) {
if (values.exportComments === true) {
// If we want comments, replace the data that will get pushed into
// the CSV with our full comments data:
if (
csvData[0] &&
Object.prototype.hasOwnProperty.call(csvData[0], "number")
) {
csvData = await getFullCommentData(
octokit,
values,
csvData,
values.verbose
);
} else {
console.error(
"Error: Must include issue number when exporting comments."
);
csvData = false;
}
}
}
// write the data out to file.
writeFile(csvData, values.exportFileName).then(
(fileName) => {
console.log(`Success! check ${fileName}`);
console.log(
"❤ ❗ If this project has provided you value, please ⭐ star the repo to show your support: ➡ https://github.com/gavinr/github-csv-tools"
);
process.exit(0);
},
(err) => {
console.log("Error writing the file. Please try again.");
console.error(err);
process.exit(0);
}
);
},
(err) => {
console.log("error", err);
process.exit(0);
}
);
};
module.exports = { exportIssues };