import './highest-rated-comment.css';
import React from 'dom-chef';
import select from 'select-dom';
import CheckIcon from 'octicon/check.svg';
import ArrowDownIcon from 'octicon/arrow-down.svg';
import * as pageDetect from 'github-url-detection';
import features from '.';
import looseParseInt from '../helpers/loose-parse-int';
// `.js-timeline-item` gets the nearest comment excluding the very first comment (OP post)
const commentSelector = '.js-timeline-item';
const positiveReactionsSelector = `
${commentSelector} [aria-label*="reacted with thumbs up"],
${commentSelector} [aria-label*="reacted with hooray"],
${commentSelector} [aria-label*="reacted with heart"]
`;
const negativeReactionsSelector = `
${commentSelector} [aria-label*="reacted with thumbs down"]
`;
function getBestComment(): HTMLElement | null {
let highest;
for (const comment of getCommentsWithReactions()) {
const positiveReactions = getCount(getPositiveReactions(comment));
// It needs to be upvoted enough times to be considered an useful comment
if (positiveReactions < 10) {
continue;
}
// Controversial comment, ignore
const negativeReactions = getCount(getNegativeReactions(comment));
if (negativeReactions >= positiveReactions / 2) {
continue;
}
if (!highest || positiveReactions > highest.count) {
highest = {comment, count: positiveReactions};
}
}
if (!highest) {
return null;
}
return highest.comment;
}
function highlightBestComment(bestComment: Element): void {
const avatar = select('.TimelineItem-avatar', bestComment)!;
avatar.classList.add('flex-column', 'flex-items-center', 'd-md-flex');
avatar.append(
);
select('.unminimized-comment', bestComment)!.classList.add('timeline-chosen-answer');
select('.unminimized-comment .timeline-comment-header-text', bestComment)!.before(
);
}
function linkBestComment(bestComment: HTMLElement): void {
// Find position of comment in thread
const position = select.all(commentSelector).indexOf(bestComment);
// Only link to it if it doesn't already appear at the top of the conversation
if (position >= 3) {
const text = select('.comment-body', bestComment)!.textContent!.slice(0, 100);
const {hash} = select('.js-timestamp', bestComment)!;
// Copy avatar but link it to the comment
const avatar = select('.TimelineItem-avatar', bestComment)!.cloneNode(true);
const link = select('[data-hovercard-type="user"]', avatar)!;
link.removeAttribute('data-hovercard-type');
link.removeAttribute('data-hovercard-url');
link.href = hash;
// Remove the check icon from the preview #3338
select('.octicon-check.text-green', avatar)!.remove();
// We don't copy the exact timeline item structure, so we need to align the avatar with the other avatars in the timeline.
// TODO: update DOM to match other comments, instead of applying this CSS
avatar.style.left = '-55px';
bestComment.parentElement!.firstElementChild!.after((
));
}
}
function getCommentsWithReactions(): Set {
const comments = getPositiveReactions().map(reaction => reaction.closest(commentSelector)!);
return new Set(comments);
}
function getNegativeReactions(reactionBox?: HTMLElement): HTMLElement[] {
return select.all(negativeReactionsSelector, reactionBox ?? document);
}
function getPositiveReactions(reactionBox?: HTMLElement): HTMLElement[] {
return select.all(positiveReactionsSelector, reactionBox ?? document);
}
function getCount(reactions: HTMLElement[]): number {
let count = 0;
for (const reaction of reactions) {
count += looseParseInt(reaction.textContent!);
}
return count;
}
function init(): false | void {
const bestComment = getBestComment();
if (!bestComment) {
return false;
}
highlightBestComment(bestComment);
linkBestComment(bestComment);
}
void features.add({
id: __filebasename,
description: 'Highlights the most useful comment in conversations.',
screenshot: 'https://user-images.githubusercontent.com/1402241/58757449-5b238880-853f-11e9-9526-e86c41a32f00.png'
}, {
include: [
pageDetect.isIssue
],
init
});