Merge pull request #247 from Pdzly/feature/anti-starboard

Feature: Anti Starboard

Author: bristermitten

src/Config.prod.ts

@@ -18,6 +18,14 @@ export const config: Config = {
 		emojiId: "⭐",
 		channel: "975786395211816980",
 		threshold: 2,
+		color: "Blue",
+		blacklistChannelIds: [],
+	},
+	antiStarboard: {
+		emojiId: "💀",
+		channel: "1486328029293838458",
+		threshold: 2,
+		color: "DarkRed",
 		blacklistChannelIds: [],
 	},
 	commands: {

src/Config.ts

@@ -18,6 +18,14 @@ const devConfig: Config = {
 		emojiId: "⭐",
 		channel: "1407366658552631296",
 		threshold: 1,
+		color: "Blue",
+		blacklistChannelIds: ["904478147351806015"],
+	},
+	antiStarboard: {
+		emojiId: "💀",
+		channel: "1478460342550921237",
+		threshold: 1,
+		color: "DarkRed",
 		blacklistChannelIds: ["904478147351806015"],
 	},
 	commands: {

src/config.type.ts

@@ -1,8 +1,10 @@
-import type { Snowflake } from "discord.js";
+import type { ColorResolvable, Snowflake } from "discord.js";
 import type { InformationMessage } from "./modules/information/information.js";
 import type { BrandingConfig } from "./util/branding.js";
 
 export interface AchievementsConfig {
+	/** Where achievement notifications are sent by default */
+	notificationMode?: "trigger" | "channel" | "dm";
 	/** Dedicated channel for notifications (required if mode is "channel") */
 	notificationChannel?: string;
 	/** Fallback channel if trigger location unavailable (for "trigger" mode) */
@@ -100,6 +102,14 @@ export interface Config {
 		emojiId: string;
 		channel: string;
 		threshold: number;
+		color: ColorResolvable;
+		blacklistChannelIds?: Snowflake[];
+	};
+	antiStarboard?: {
+		emojiId: string;
+		channel: string;
+		threshold: number;
+		color: ColorResolvable;
 		blacklistChannelIds?: Snowflake[];
 	};
 	suggest: {

src/modules/starboard/starboard.content.ts

@@ -0,0 +1,46 @@
+import type { ColorResolvable, Message } from "discord.js";
+import { config } from "../../Config.js";
+import { getReactionCountForEmoji } from "./starboard.reaction-utils.js";
+
+export interface StarboardContentRenderOptions {
+	emojiId: string;
+	threshold: number;
+	color: ColorResolvable;
+}
+
+const getAntiStarHintForMessage = (
+	message: Pick<Message, "reactions">,
+	renderOptions: StarboardContentRenderOptions,
+): string | null => {
+	if (
+		!config.antiStarboard ||
+		renderOptions.emojiId !== config.starboard.emojiId
+	) {
+		return null;
+	}
+
+	const antiStarCount = getReactionCountForEmoji(
+		message,
+		config.antiStarboard.emojiId,
+	);
+	if (antiStarCount < 1) {
+		return null;
+	}
+
+	return `(- ${config.antiStarboard.emojiId}: ${antiStarCount})`;
+};
+
+export const buildStarboardMessageContent = (
+	message: Pick<Message, "url" | "reactions">,
+	stars: number,
+	renderOptions: StarboardContentRenderOptions,
+): string => {
+	const contentParts = [`${renderOptions.emojiId}: ${stars}`];
+	const antiStarHint = getAntiStarHintForMessage(message, renderOptions);
+	if (antiStarHint) {
+		contentParts.push(antiStarHint);
+	}
+	contentParts.push("|", message.url);
+
+	return contentParts.join(" ");
+};

src/modules/starboard/starboard.listener.test.ts

@@ -0,0 +1,71 @@
+import { describe, expect, test } from "bun:test";
+import {
+	getReactionCountForEmoji,
+	getThresholdReactionCount,
+	matchesConfiguredEmoji,
+} from "./starboard.reaction-utils.js";
+import { createMessageWithReactions } from "./starboard.test-utils.js";
+
+describe("matchesConfiguredEmoji", () => {
+	test("matches unicode emoji with and without variation selector", () => {
+		expect(matchesConfiguredEmoji("⭐", null, "⭐️")).toBe(true);
+	});
+
+	test("matches custom emoji by id when config uses Discord emoji syntax", () => {
+		expect(
+			matchesConfiguredEmoji("star", "1234567890", "<:star:1234567890>"),
+		).toBe(true);
+	});
+});
+
+describe("getReactionCountForEmoji", () => {
+	test("matches unicode emoji with and without variation selector", () => {
+		const message = createMessageWithReactions([
+			{
+				emoji: {
+					name: "⭐",
+					id: null,
+				},
+				count: 3,
+			},
+		]);
+
+		expect(getReactionCountForEmoji(message, "⭐️")).toBe(3);
+	});
+
+	test("matches custom emoji when configured as <:name:id>", () => {
+		const message = createMessageWithReactions([
+			{
+				emoji: {
+					name: "star",
+					id: "1234567890",
+				},
+				count: 4,
+			},
+		]);
+
+		expect(getReactionCountForEmoji(message, "<:star:1234567890>")).toBe(4);
+	});
+});
+
+describe("getThresholdReactionCount", () => {
+	test("uses message reaction count when event count is missing", () => {
+		const message = createMessageWithReactions([
+			{
+				emoji: {
+					name: "⭐",
+					id: null,
+				},
+				count: 2,
+			},
+		]);
+
+		expect(getThresholdReactionCount(message, "⭐", null)).toBe(2);
+	});
+
+	test("falls back to event reaction count when message cache has no match", () => {
+		const message = createMessageWithReactions([]);
+
+		expect(getThresholdReactionCount(message, "⭐", 2)).toBe(2);
+	});
+});