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
|
import './highest-rated-comment.css';
import mem from 'mem';
import React from 'dom-chef';
import {$, $$} from 'select-dom';
import * as pageDetect from 'github-url-detection';
import {ArrowDownIcon, CheckCircleFillIcon} from '@primer/octicons-react';
import features from '../feature-manager.js';
import looseParseInt from '../helpers/loose-parse-int.js';
import isLowQualityComment from '../helpers/is-low-quality-comment.js';
import {singleParagraphCommentSelector} from './hide-low-quality-comments.js';
// `.js-timeline-item` gets the nearest comment excluding the very first comment (OP post)
const commentSelector = '.js-timeline-item';
const positiveReactionsSelector = `
${commentSelector} [aria-label="react with thumbs up"],
${commentSelector} [aria-label="react with hooray"],
${commentSelector} [aria-label="react with heart"]
`;
const negativeReactionsSelector = `
${commentSelector} [aria-label="react with thumbs down"]
`;
const getPositiveReactions = mem((comment: HTMLElement): number | void => {
const count = selectSum(positiveReactionsSelector, comment);
if (
// It needs to be upvoted enough times
count >= 10
// It can't be a controversial comment
&& selectSum(negativeReactionsSelector, comment) < count / 2
) {
return count;
}
});
function getBestComment(): HTMLElement | undefined {
let highest;
for (const reaction of $$(positiveReactionsSelector)) {
const comment = reaction.closest(commentSelector)!;
const positiveReactions = getPositiveReactions(comment);
if (positiveReactions && (!highest || positiveReactions > highest.count)) {
highest = {comment, count: positiveReactions};
}
}
return highest?.comment;
}
function highlightBestComment(bestComment: Element): void {
$('.unminimized-comment', bestComment)!.classList.add('rgh-highest-rated-comment');
$('.unminimized-comment .timeline-comment-header > h3', bestComment)!.before(
<span
className="color-fg-success tooltipped tooltipped-s"
aria-label="This comment has the most positive reactions on this issue."
>
<CheckCircleFillIcon/>
</span>,
);
}
function linkBestComment(bestComment: HTMLElement): void {
// Find position of comment in thread
const position = $$(commentSelector).indexOf(bestComment);
// Only link to it if it doesn't already appear at the top of the conversation
if (position < 3) {
return;
}
const text = $('.comment-body', bestComment)!.textContent.slice(0, 100);
const {hash} = $('a.js-timestamp', bestComment)!;
const avatar = $('img.avatar', bestComment)!.cloneNode();
bestComment.parentElement!.firstElementChild!.after(
<a href={hash} className="no-underline rounded-1 rgh-highest-rated-comment timeline-comment color-bg-subtle px-2 d-flex flex-items-center">
{avatar}
<h3 className="timeline-comment-header-text f5 color-fg-muted text-normal text-italic css-truncate css-truncate-overflow mr-2">
<span className="Label mr-2">Highest-rated</span>{text}
</h3>
<div className="color-fg-muted f6 no-wrap">
<ArrowDownIcon className="mr-1"/>Jump to comment
</div>
</a>,
);
}
function selectSum(selector: string, container: HTMLElement): number {
return $$(selector, container).reduce((sum, element) => sum + looseParseInt(element), 0);
}
function init(): false | void {
const bestComment = getBestComment();
if (!bestComment) {
return false;
}
const commentText = $(singleParagraphCommentSelector, bestComment)?.textContent;
if (commentText && isLowQualityComment(commentText)) { // #5567
return false;
}
linkBestComment(bestComment);
highlightBestComment(bestComment);
}
void features.add(import.meta.url, {
include: [
pageDetect.isIssue,
],
deduplicate: 'has-rgh-inner',
awaitDomReady: true, // Must wait for all to pick the best one
init,
});
/*
Test URLs:
- 8th comment, has link: https://github.com/refined-github/refined-github/issues/4166
- 2nd comment, no link: https://github.com/refined-github/refined-github/issues/825
*/
|
