Support TLS connections and custom ports (#41)

* Add optional port and tls properties to config schema

* Add discordUsername to default IRC text formatting

* Add TLS and port configuration support to bot

* Remove console.log call on quit event

* Add TLS and port configuration to README example

README.md

@@ -144,6 +144,8 @@ First you need to create a Discord bot user, which you can do by following the i
   {
     "nickname": "test",
     "server": "irc.bottest.org",
+    "port": 6697,
+    "tls": true,
     "discordToken": "botwantsin123",
     "autoSendCommands": [
       // Commands that will be sent on connect

lib/bot.ts

@@ -100,7 +100,7 @@ export default class Bot {
     // displayUsername: nickname with wrapped colors
     // attachmentURL: the URL of the attachment (only applicable in formatURLAttachment)
     this.formatIRCText = config.format?.ircText ||
-      '<{$displayUsername}> {$text}';
+      '<{$displayUsername} [@{$discordUsername}]> {$text}';
     this.formatURLAttachment = config.format?.urlAttachment ||
       '<{$displayUsername}> {$attachmentURL}';
 
@@ -152,7 +152,7 @@ export default class Bot {
     this.channelMapping = await ChannelMapper.CreateAsync(this.config, this, this.discord);
 
     this.attachIrcListeners();
-    await this.ircClient.connect(this.config.server);
+    await this.ircClient.connect(this.config.server, this.config.port, this.config.tls);
     this.channelMapping.ircNameToMapping.forEach((entry) => {
       this.logger.info(`Joining channel ${entry.ircChannel}`);
       this.ircClient.join(entry.ircChannel);

lib/config.ts

@@ -33,6 +33,8 @@ export type IgnoreConfig = {
 
 export type Config = {
   server: string;
+  port?: number;
+  tls?: boolean;
   nickname: string;
   discordToken: string;
   channelMapping: Dictionary<string>;
@@ -94,6 +96,8 @@ export const IgnoreConfigSchema = z.object({
 
 export const ConfigSchema = z.object({
   server: z.string(),
+  port: z.number().optional(),
+  tls: z.boolean().optional(),
   nickname: z.string(),
   discordToken: z.string(),
   channelMapping: z.record(z.string()),

lib/ircListeners.ts

@@ -189,8 +189,6 @@ export function createIrcQuitListener(bot: Bot) {
         `*${nick}* has quit (${reason})`,
       );
     });
-    console.log('quit');
-    console.log(event);
   };
 }