{{ message }}
Repository navigation
Expand file tree
/
Copy pathcopy-commit-reference-lib.js
More file actions
547 lines (499 loc) · 16.1 KB
/
Copy pathcopy-commit-reference-lib.js
File metadata and controls
547 lines (499 loc) · 16.1 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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
// ==UserScript==
// @name Git: copy commit reference library
// @namespace https://andrybak.dev
// @version 0.5-alpha
// @description Common library code for "Copy commit reference" userscripts for Git hostings
// @author Andrei Rybak
// @license AGPL-3.0-only
// @require https://cdn.jsdelivr.net/gh/rybak/userscript-libs@e86c722f2c9cc2a96298c8511028f15c45180185/waitForElement.js
// ==/UserScript==
/*
* Copyright (C) 2023-2024 Andrei Rybak
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/*
* CHANGELOG
*
* - 0.5-alpha
* - Fixed a bug in HTML escaping.
*
* - 0.4-alpha
* - HTML in commit message subjects is now escaped
*
* - 0.3-alpha
* - JSDoc comments were updated
*
* - 0.2-alpha
* - function htmlToElement has been dropped
*
* - 0.1-alpha
* - Initial release.
*/
'use strict';
const LOG_PREFIX = '[Git: copy commit reference]:';
const CONTAINER_ID = "CCR_container";
const CHECKMARK_ID = "CCR_checkmark";
function error(...toLog) {
console.error(LOG_PREFIX, ...toLog);
}
function warn(...toLog) {
console.warn(LOG_PREFIX, ...toLog);
}
function info(...toLog) {
console.info(LOG_PREFIX, ...toLog);
}
function debug(...toLog) {
console.debug(LOG_PREFIX, ...toLog);
}
/**
* Abstract class corresponding to a Git hosting provider.
*
* When subclassing each method that throws an {@link Error} must be implemented.
* The minimal implementation requires only four methods to be overridden.
* Some of the methods are allowed to be asynchronous, if the implementation
* needs to do {@link fetch} requests, e.g. to a REST API of the hosting.
*/
class GitHosting {
constructor() {
if (this.constructor == GitHosting) {
throw new Error("Abstract class cannot be instantiated.");
}
}
/**
* CSS selector to use to find the element, to which the button will be added.
* Placement of the button which is static with regard to the length of the
* commit message and metadata is preferred.
*
* @returns {string}
*/
getTargetSelector() {
throw new Error("Not implemented in " + this.constructor.name);
}
/**
* Extracts full SHA-1 object name (40-digit hexadecimal string) of the commit.
* Implementing classes can use both the URL (document.location) and the HTML
* to determine the hash.
*
* @returns {string} full SHA-1 hash of the commit of the current page
*/
getFullHash() {
throw new Error("Not implemented in " + this.constructor.name);
}
/*
* Returns author date of the commit in ISO 8601 format,
* i.e. YYYY-MM-DD, e.g. 2039-12-31
*/
async getDateIso(hash) {
throw new Error("Not implemented in " + this.constructor.name);
}
/*
* Returns full commit message of the commit displayed on current webpage.
* Parameter `hash` is provided as a convenience for subclasses
* that need the full hash to avoid calling `getFullHash` twice.
*/
async getCommitMessage(hash) {
throw new Error("Not implemented in " + this.constructor.name);
}
/**
* CSS selector to use to wait until the webpage is considered loaded.
* Needs to be overridden only if more than one implementations of
* GitHosting need to be used.
*
* @returns {string} a CSS selector
*/
getLoadedSelector() {
return 'body';
}
/**
* Returns `true` if this `GitHosting` recognizes the webpage.
* This method is only called when the page is loaded according
* to `getLoadedSelector()`.
*
* Needs to be overridden only if more than one implementations of
* GitHosting need to be used.
*
* @returns {boolean} `true` if this `GitHosting` recognizes the webpage.
*/
isRecognized() {
return true;
}
/**
* Add additional HTML to wrap around the button container.
* This method can also be used to add CSS to the given `innerContainer`.
*
* By default just returns the given `innerContainer`, without wrapping.
*
* @param {HTMLElement} innerContainer see usage of {@link wrapButtonContainer}
* in {@link doAddButton}.
*/
wrapButtonContainer(innerContainer) {
return innerContainer;
}
/**
* @returns {string} the text of the button of the userscript.
*/
getButtonText() {
return "Copy commit reference";
}
/*
* Add additional HTML to wrap around the button itself.
* This method can also be used to add CSS to or alter HTML of
* the given `button`.
*
* By default just returns the given `button`, without wrapping.
*
* @returns {HTMLElement}
*/
wrapButton(button) {
return button;
}
/*
* Converts given plain text version of subject line to HTML.
* Useful for Git hosting providers that have integrations with
* issue trackers and code review tools.
*
* By default just escapes characters, special to HTML.
* Classes, which override this method should take care of escaping
* themselves.
*
* @returns {string} HTML code for the subject of the commit message
*/
async convertPlainSubjectToHtml(plainTextSubject) {
// https://stackoverflow.com/a/6234804/1083697
const escapedHtml = plainTextSubject
.replaceAll('&', '&')
.replaceAll('<', '<')
.replaceAll('>', '>')
.replaceAll('"', '"')
.replaceAll("'", ''');
return escapedHtml;
}
/**
* Adds a button to copy a commit reference to a target element.
* Target element is determined according to {@link getTargetSelector}.
*/
doAddButton() {
waitForElement(this.getTargetSelector()).then(target => {
debug('target', target);
const innerContainer = document.createElement('span');
const buttonContainer = this.wrapButtonContainer(innerContainer);
buttonContainer.id = CONTAINER_ID;
buttonContainer.style.position = 'relative';
this.addButtonContainerToTarget(target, buttonContainer);
const button = this.createCopyButton();
innerContainer.appendChild(button);
innerContainer.append(this.createCheckmark());
});
}
/**
* Adds the `buttonContainer` (see {@link CONTAINER_ID}) element to the `target`
* (see method {@link getTargetSelector}) element.
*
* Override this method, if your need customize where the copy button gets
* put in the interface.
*
* By default just appends the `buttonContainer` to the end of `target`.
*
* @param {HTMLElement} target element in the native UI of this hosting
* website, where the userscript puts the "Copy commit reference" button.
* @param {HTMLElement} buttonContainer the wrapper element around the
* "Copy commit reference" {@link createCopyButton button} and the
* checkmark (see method {@link createCheckmark})
*/
addButtonContainerToTarget(target, buttonContainer) {
target.append(buttonContainer);
}
/**
* @returns {string} name of the HTML tag to be used for the button
*/
getButtonTagName() {
return 'a';
}
/*
* Creates the button element to copy a commit reference to the clipboard.
*
* @returns {HTMLElement} the button
*/
createCopyButton() {
const buttonText = this.getButtonText();
let button = document.createElement(this.getButtonTagName());
if (this.getButtonTagName() === 'a') {
button.href = '#'; // for underline decoration
}
button.appendChild(document.createTextNode(buttonText));
button.setAttribute('role', 'button');
button = this.wrapButton(button);
const onclick = (event) => {
this.#copyClickAction(event);
}
button.onclick = onclick;
return button;
}
/**
* The more fancy Git hostings have on-the-fly page reloads,
* which aren't proper page reloads. Clicking on a commit
* link on these sites doesn't trigger re-running of the
* userscript (sometimes, at least). This means that the
* button that we've added (see {@link addButtonContainerToTarget})
* will disappear from the page. To cover such cases, we
* need to automatically detect that the commit in the
* URL has changed and _re-add_ the button again.
*
* Method {@link setUpReadder} is called once during userscript's
* lifecycle on a webpage.
*
* Subclasses can override this method with their own
* implementation of an "re-adder". Re-adders must clear
* any caches specific to a particular commit. Re-adders
* must call the given callback only on webpages that are
* definitely pages for a singular commit.
*/
setUpReadder(ensureButtonFn) {
}
/**
* Extracts the first line of the commit message.
* If the first line is too small, extracts more lines.
*
* @param {string} commitMessage the full commit message (subject and body)
* taken from the webpage. See {@link getCommitMessage} and its
* implementations in subclasses.
* @returns {string} subject, extracted from the commit message,
* Usually, it is the first line of the commit message.
*/
#commitMessageToSubject(commitMessage) {
const lines = commitMessage.split('\n');
if (lines[0].length > 16) {
/*
* Most common use-case: a normal commit message with
* a normal-ish subject line.
*/
return lines[0].trim();
}
/*
* The `if`s below handles weird commit messages I have
* encountered in the wild.
*/
if (lines.length < 2) {
return lines[0].trim();
}
if (lines[1].length == 0) {
return lines[0].trim();
}
// sometimes subject is weirdly split across two lines
return lines[0].trim() + " " + lines[1].trim();
}
/**
* @param {string} commitHash a hash of a commit, usually SHA1 hash
* of 40 hexadecimal digits
* @returns abbreviated hash
*/
#abbreviateCommitHash(commitHash) {
return commitHash.slice(0, 7);
}
/**
* Formats given commit metadata as a commit reference according
* to `git log --format=reference`. See format descriptions at
* https://git-scm.com/docs/git-log#_pretty_formats
*
* @param {string} commitHash {@link getFullHash hash} of the commit
* @param {string} subject subject line of the commit message
* @param {string} dateIso author date of commit in ISO 8601 format
* @returns {string} a commit reference
*/
#plainTextCommitReference(commitHash, subject, dateIso) {
const abbrev = this.#abbreviateCommitHash(commitHash);
return `${abbrev} (${subject}, ${dateIso})`;
}
/**
* Renders given commit that has the provided subject line and date
* in reference format as HTML content. Returned HTML includes
* a clickable link to the commit, and may include links to issue
* trackers, code review tools, etc.
*
* Documentation of formats: https://git-scm.com/docs/git-log#_pretty_formats
*
* @param {string} commitHash {@link getFullHash hash} of the commit
* @param {string} subjectHtml HTML of pre-rendered subject line of
* the commit message. See {@link convertPlainSubjectToHtml}.
* @param {string} dateIso author date of commit in ISO 8601 format
* @returns {string} HTML code of the commit reference
*/
#htmlSyntaxCommitReference(commitHash, subjectHtml, dateIso) {
const url = document.location.href;
const abbrev = this.#abbreviateCommitHash(commitHash);
const html = `<a href="${url}">${abbrev}</a> (${subjectHtml}, ${dateIso})`;
return html;
}
#addLinkToClipboard(event, plainText, html) {
event.stopPropagation();
event.preventDefault();
let clipboardData = event.clipboardData || window.clipboardData;
clipboardData.setData('text/plain', plainText);
clipboardData.setData('text/html', html);
this.#showCheckmark();
setTimeout(() => this.#hideCheckmark(), 2000);
}
#showCheckmark() {
const checkmark = document.getElementById(CHECKMARK_ID);
checkmark.style.display = 'inline-block';
}
#hideCheckmark() {
const checkmark = document.getElementById(CHECKMARK_ID);
checkmark.style.display = 'none';
}
/**
* @returns {HTMLElement}
*/
createCheckmark() {
const checkmark = document.createElement('span');
checkmark.id = CHECKMARK_ID;
checkmark.style.display = 'none';
checkmark.style.position = 'absolute';
checkmark.style.left = 'calc(100% + 0.5rem)';
checkmark.style.whiteSpace = 'nowrap';
checkmark.append(" ✅ Copied to clipboard");
return checkmark;
}
/*
* Generates the content and passes it to the clipboard.
*
* Async, because we need to access REST APIs.
*/
async #copyClickAction(event) {
event.preventDefault();
try {
/*
* Extract metadata about the commit from the UI using methods from subclass.
*/
const commitHash = this.getFullHash();
const dateIso = await this.getDateIso(commitHash);
const commitMessage = await this.getCommitMessage(commitHash);
const subject = this.#commitMessageToSubject(commitMessage);
const plainText = this.#plainTextCommitReference(commitHash, subject, dateIso);
const htmlSubject = await this.convertPlainSubjectToHtml(subject, commitHash);
const html = this.#htmlSyntaxCommitReference(commitHash, htmlSubject, dateIso);
info("plain text:", plainText);
info("HTML:", html);
const handleCopyEvent = e => {
this.#addLinkToClipboard(e, plainText, html);
};
document.addEventListener('copy', handleCopyEvent);
document.execCommand('copy');
document.removeEventListener('copy', handleCopyEvent);
} catch (e) {
error('Could not do the copying', e);
}
}
}
class CopyCommitReference {
/**
* @param {...GitHosting} hostings
*/
constructor(...hostings) {
info(`Got ${hostings.length} hostings`);
this.#gitHostings = hostings;
}
static #removeExistingContainer() {
const container = document.getElementById(CONTAINER_ID);
if (!container) {
return;
}
container.parentNode.removeChild(container);
}
/**
* @type {GitHosting}
*/
#recognizedGitHosting = null;
/**
* @returns {GitHosting}
*/
#getRecognizedGitHosting() {
if (this.#recognizedGitHosting != null) {
return this.#recognizedGitHosting;
}
for (const hosting of this.#gitHostings) {
if (hosting.isRecognized()) {
info("Recognized", hosting.constructor.name);
this.#recognizedGitHosting = hosting;
waitForElement(`#${CONTAINER_ID}`).then(added => {
info('Button has been added. Can setup re-adder now.');
hosting.setUpReadder(() => this.#ensureButton());
});
return this.#recognizedGitHosting;
}
}
warn("Cannot recognize any hosting");
return null;
}
/**
* An optimization: for sites, which do page reloads on the fly,
* we don't need to use selectors from all hostings. Just using
* the selector for the recognized hosting should do the trick.
*
* @returns {string} a selector for waiting for loading
*/
#getLoadedSelector() {
if (this.#recognizedGitHosting != null) {
return this.#recognizedGitHosting.getLoadedSelector();
}
return this.#gitHostings
.map(h => h.getLoadedSelector())
.filter(selector => selector.length != 0)
.join(", ");
}
#doEnsureButton() {
CopyCommitReference.#removeExistingContainer();
const loadedSelector = this.#getLoadedSelector();
info("loadedSelector =", `'${loadedSelector}'`);
waitForElement(loadedSelector).then(loadedElement => {
info("Loaded from selector", loadedSelector);
const hosting = this.#getRecognizedGitHosting();
if (hosting != null) {
hosting.doAddButton();
}
});
}
/**
* On pages that are not for a singular commit, method
* {@link #ensureButton} must be called exactly once, at the
* bottom of {@link runForGitHostings}.
*
* Re-adders must take care to avoid several `observer`s
* added by a call to {@code waitForElement} to be in flight.
*/
#ensureButton() {
try {
this.#doEnsureButton();
} catch (e) {
error('Could not create the button', e);
}
}
/**
* An instance of each subclass of `GitHosting` is created,
* but only one of them gets "recognized".
*
* @type {GitHosting[]}
*/
#gitHostings;
/**
* Entry point for userscripts which use this library.
* Call this method once with instances of class {@link GitHosting}.
*
* @param {...GitHosting} hostings
*/
static runForGitHostings(...hostings) {
const ccr = new CopyCommitReference(...hostings);
ccr.#ensureButton();
}
}
You can’t perform that action at this time.