feat(plugins): allow to provide a ctcp version string

Author: jeromeludmann

client_test.ts

@@ -22,7 +22,7 @@ Deno.test("client options", async () => {
       clientinfo: true,
       ping: true,
       time: true,
-      version: true,
+      version: "deno-irc",
     },
     debug: false,
     resolveInvalidNames: false,

plugins/version.ts

@@ -6,8 +6,12 @@ import { createCtcp } from "./ctcp.ts";
 export interface VersionParams {
   options: {
     ctcpReplies?: {
-      /** Replies to CTCP VERSION. */
-      version?: boolean;
+      /**
+       * Replies to CTCP VERSION with the given string.
+       *
+       * Default to `"deno-irc"`. `false` to disable.
+       */
+      version?: string | false;
     };
   };
   commands: {
@@ -38,7 +42,7 @@ export interface CtcpVersionReply {
 
 function options(client: ExtendedClient<VersionParams>) {
   client.options.ctcpReplies ??= {};
-  client.options.ctcpReplies.version ??= true;
+  client.options.ctcpReplies.version ??= "deno-irc";
 }
 
 function commands(
@@ -81,12 +85,14 @@ function events(
 }
 
 function replies(client: ExtendedClient<VersionParams>) {
-  if (!client.options.ctcpReplies?.version) {
+  const version = client.options.ctcpReplies?.version;
+
+  if (!version) {
     return;
   }
 
   client.on("ctcp_version", (msg) => {
-    client.send("NOTICE", msg.origin.nick, createCtcp("VERSION", "deno-irc"));
+    client.send("NOTICE", msg.origin.nick, createCtcp("VERSION", version));
   });
 }
 

plugins/version_test.ts

@@ -51,7 +51,7 @@ Deno.test("version events", async () => {
 Deno.test("version replies", async () => {
   const { server, client, sanitize } = arrange(
     [ctcp, version],
-    { ctcpReplies: { version: true } },
+    { ctcpReplies: { version: "custom version" } },
   );
 
   server.listen();
@@ -60,7 +60,24 @@ Deno.test("version replies", async () => {
 
   server.send(":nick2!user@host PRIVMSG nick :\u0001VERSION\u0001");
   const raw = await server.once("NOTICE");
-  assertEquals(raw, "NOTICE nick2 :\u0001VERSION deno-irc\u0001");
+  assertEquals(raw, "NOTICE nick2 :\u0001VERSION custom version\u0001");
+
+  await sanitize();
+});
+
+Deno.test("version replies (disabled)", async () => {
+  const { server, client, sanitize } = arrange(
+    [ctcp, version],
+    { ctcpReplies: { version: false } },
+  );
+
+  server.listen();
+  client.connect(server.host, server.port);
+  await server.waitClient();
+
+  server.send(":nick2!user@host PRIVMSG nick :\u0001VERSION\u0001");
+  const raw = await server.wait("NOTICE", 10);
+  assertEquals(raw, null);
 
   await sanitize();
 });