New Ktlint rule overrides

.editorconfig

@@ -0,0 +1,7 @@
+[*.{kt,kts}]
+ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4 # don't force multiline constructors unless they're big
+ktlint_standard_class-naming = disabled # don't enforce capitalisation of classes
+ktlint_standard_when-entry-bracing = disabled
+ktlint_standard_blank-line-between-when-conditions = disabled
+ktlint_standard_blank-line-before-declaration = disabled
+ktlint_standard_multiline-expression-wrapping = disabled

build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     kotlin("jvm") version "2.4.0"
     id("org.jlleitschuh.gradle.ktlint") version "12.3.0"
+    id("dev.detekt") version "2.0.0-alpha.6"
 }
 
 group = "com.shr4pnel"
@@ -13,10 +14,10 @@ repositories {
 
 dependencies {
     testImplementation(kotlin("test"))
-    implementation ("io.ktor:ktor-client-core:${ktorVersion}")
+    implementation("io.ktor:ktor-client-core:$ktorVersion")
-    implementation("io.ktor:ktor-client-cio:${ktorVersion}")
+    implementation("io.ktor:ktor-client-cio:$ktorVersion")
-    implementation("io.ktor:ktor-network:${ktorVersion}")
+    implementation("io.ktor:ktor-network:$ktorVersion")
-    implementation("io.ktor:ktor-network-tls:${ktorVersion}")
+    implementation("io.ktor:ktor-network-tls:$ktorVersion")
     implementation("io.github.oshai:kotlin-logging-jvm:8.0.4")
     implementation("ch.qos.logback:logback-classic:1.6.1")
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Tue Aug 04 23:49:39 BST 2026
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/kotlin/com/shr4pnel/ferretirc/IrcClient.kt

@@ -1,9 +1,9 @@
 package com.shr4pnel.ferretirc
 
 import com.shr4pnel.ferretirc.irc.Server
-import com.shr4pnel.ferretirc.irc.util.Helpers
+import com.shr4pnel.ferretirc.util.Helpers
-import com.shr4pnel.ferretirc.net.messages.ClientMessage
 import com.shr4pnel.ferretirc.net.Connection
+import com.shr4pnel.ferretirc.net.messages.ClientMessage
 import com.shr4pnel.ferretirc.net.messages.ServerMessage
 import io.github.oshai.kotlinlogging.KotlinLoggingConfiguration
 import kotlinx.coroutines.CoroutineScope
@@ -64,13 +64,21 @@ class IrcClient(hostname: String, port: Int, enableLogging: Boolean = true) {
     suspend inline fun <reified T : ServerMessage> waitForNext(noinline predicate: (T) -> Boolean = { true }): T =
         connection.reader.waitForNext(T::class, predicate)
 
-    suspend fun register(nick: String, realName: String? = null, password: String? = null) {
+    suspend fun register(
-        val messages = buildList {
+        nick: String,
+        realName: String? = null,
+        password: String? = null,
+    ) {
+        val messages =
+            buildList {
                 if (!password.isNullOrEmpty()) add(ClientMessage.Pass(password))
                 add(ClientMessage.Cap.LS())
                 add(ClientMessage.Nick(nick))
-            if (!realName.isNullOrEmpty()) add(ClientMessage.User(nick, realName))
+                if (!realName.isNullOrEmpty()) {
-            else add(ClientMessage.User(nick, nick))
+                    add(ClientMessage.User(nick, realName))
+                } else {
+                    add(ClientMessage.User(nick, nick))
+                }
                 add(ClientMessage.Cap.END())
             }
         queueMessages(*messages.toTypedArray())

src/main/kotlin/com/shr4pnel/ferretirc/irc/IRCChannel.kt

@@ -1,5 +1,3 @@
 package com.shr4pnel.ferretirc.irc
 
-class IRCChannel(val chanName: String, val clientCount: Int, val topic: String) {
+class IRCChannel(val chanName: String, val clientCount: Int, val topic: String)
-
-}

src/main/kotlin/com/shr4pnel/ferretirc/irc/Server.kt

@@ -9,7 +9,11 @@ import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.onSubscription
 import kotlinx.coroutines.flow.takeWhile
 
-class Server(private val msgBuffer: SharedFlow<ServerMessage>, private val outgoingMessages: Channel<ClientMessage>, private val scope: CoroutineScope) {
+class Server(
+    private val msgBuffer: SharedFlow<ServerMessage>,
+    private val outgoingMessages: Channel<ClientMessage>,
+    private val scope: CoroutineScope,
+) {
     lateinit var features: ISupportFeatures
         private set
 
@@ -31,6 +35,5 @@ class Server(private val msgBuffer: SharedFlow<ServerMessage>, private val outgo
     }
 
     fun fetchFeatures() {
-
     }
 }

src/main/kotlin/com/shr4pnel/ferretirc/net/MessageParser.kt

@@ -1,7 +1,7 @@
 package com.shr4pnel.ferretirc.net
 
-import com.shr4pnel.ferretirc.irc.util.Helpers
 import com.shr4pnel.ferretirc.net.messages.ServerMessage
+import com.shr4pnel.ferretirc.util.Helpers
 import io.github.oshai.kotlinlogging.KotlinLogging
 import io.github.oshai.kotlinlogging.slf4j.logger
 import kotlinx.coroutines.channels.Channel
@@ -18,6 +18,7 @@ class MessageParser(val incoming: Channel<String>) {
 
         abstract class Command(open val command: String, open val parameters: List<String>) {
             abstract fun toServerMessage(): ServerMessage
+
             fun getTrailingParameterIndex() = parameters.indexOfFirst { it.startsWith(":") }
 
             fun getTrailingParameterString() =
@@ -35,40 +36,59 @@ class MessageParser(val incoming: Channel<String>) {
             fun getNonTrailingParameters() = getNonTrailingParameterString().split(" ")
 
             class NamedCommand(override val command: String, override val parameters: List<String>) : Command(command, parameters) {
-                override fun toServerMessage() = when (command.uppercase()) {
+                override fun toServerMessage() =
+                    when (command.uppercase()) {
                         "PONG" -> ServerMessage.Pong(getTrailingParameterString().removePrefix(":"))
-                    "MODE" -> ServerMessage.Mode(
+
+                        // TODO MODE, CHANMODE, LOCALMODE
+                        "MODE" ->
+                            ServerMessage.Mode(
                                 parameters.first(),
-                        parameters.last().removePrefix(":")
+                                parameters.last().removePrefix(":"),
-                    ) // TODO MODE, CHANMODE, LOCALMODE
-
-                    "NOTICE" -> ServerMessage.Notice(
-                        getNonTrailingParameters(),
-                        getTrailingParameterString()
                             )
 
-                    "PRIVMSG" -> ServerMessage.PrivMsg(
+                        "NOTICE" ->
+                            ServerMessage.Notice(
                                 getNonTrailingParameters(),
-                        getTrailingParameterString()
+                                getTrailingParameterString(),
                             )
 
-                    else -> {
+                        "PRIVMSG" ->
-                        ServerMessage.UNIMPLEMENTED("$command ${parameters.joinToString(" ")}")
+                            ServerMessage.PrivMsg(
-                    }
+                                getNonTrailingParameters(),
+                                getTrailingParameterString(),
+                            )
+
+                        else -> ServerMessage.UNIMPLEMENTED("$command ${parameters.joinToString(" ")}")
                     }
             }
 
             class NumericCommand(override val command: String, override val parameters: List<String>) : Command(command, parameters) {
-                override fun toServerMessage() = when (command.toInt()) {
+                private enum class RPL(val underlying: Int) {
-                    5 -> ServerMessage.Numeric.RPL_ISUPPORT(getNonTrailingParameterString())
+                    ISUPPORT(5),
-                    321 -> ServerMessage.Numeric.RPL_LISTSTART()
+                    LISTSTART(321),
-                    322 -> ServerMessage.Numeric.RPL_LIST(
+                    LIST(322),
+                    LISTEND(323),
+                    NONE(0xbeef), ;
+
+                    companion object {
+                        val rplMap = RPL.entries.associateBy { it.underlying }
+                        infix fun from(value: Int) = rplMap[value] ?: NONE
+                        infix fun from(value: String) = from(value.toInt())
+                    }
+                }
+
+                override fun toServerMessage() =
+                    when (RPL from command) {
+                        RPL.ISUPPORT -> ServerMessage.Numeric.RPL_ISUPPORT(getNonTrailingParameterString())
+                        RPL.LISTSTART -> ServerMessage.Numeric.RPL_LISTSTART()
+                        RPL.LIST -> ServerMessage.Numeric.RPL_LIST(
                             parameters[1],
                             parameters[2].toInt(),
-                        getTrailingParameterString()
+                            getTrailingParameterString(),
                         )
-                    323 -> ServerMessage.Numeric.RPL_LISTEND()
+                        RPL.LISTEND -> ServerMessage.Numeric.RPL_LISTEND()
-                    else -> ServerMessage.UNIMPLEMENTED(parameters.toString())
+                        RPL.NONE -> ServerMessage.UNIMPLEMENTED(parameters.toString())
                     }
             }
         }
@@ -99,21 +119,31 @@ class MessageParser(val incoming: Channel<String>) {
             val tokens = commandList.toMutableList()
 
             // remove tags from strlist if present
-            tags = if (tokens.first().startsWith("@")) {
+            tags =
+                if (tokens.first().startsWith("@")) {
                     tokens.removeFirst()
-            } else null
+                } else {
+                    null
+                }
 
             // remove client prefix (nick&opt hostname) if present
-            prefix = if (tokens.first().startsWith(":")) {
+            prefix =
+                if (tokens.first().startsWith(":")) {
                     tokens.removeFirst()
-            } else null
+                } else {
+                    null
+                }
 
             // get command e.g. PING
             val commandStr = tokens.removeFirst()
 
             // Check if command is a numeric (RPL/ERR) or named
-            command = if (commandStr.toIntOrNull() == null) Command.NamedCommand(commandStr, tokens)
+            command =
-            else Command.NumericCommand(commandStr, tokens)
+                if (commandStr.toIntOrNull() == null) {
+                    Command.NamedCommand(commandStr, tokens)
+                } else {
+                    Command.NumericCommand(commandStr, tokens)
+                }
 
             return command.toServerMessage()
         }
@@ -122,7 +152,6 @@ class MessageParser(val incoming: Channel<String>) {
     }
 
     suspend fun start() {
-
         val builder = MessageBuilder()
         for (msg in incoming) {
             logger.trace { "Receiving: $msg" }

src/main/kotlin/com/shr4pnel/ferretirc/net/MessageReader.kt

@@ -1,8 +1,8 @@
 package com.shr4pnel.ferretirc.net
 
-import com.shr4pnel.ferretirc.irc.util.Helpers
 import com.shr4pnel.ferretirc.net.messages.MessageIO
 import com.shr4pnel.ferretirc.net.messages.ServerMessage
+import com.shr4pnel.ferretirc.util.Helpers
 import io.github.oshai.kotlinlogging.KotlinLogging
 import io.github.oshai.kotlinlogging.slf4j.logger
 import io.ktor.network.sockets.Socket
@@ -27,7 +27,6 @@ class MessageReader(socket: Socket, scope: CoroutineScope) : MessageIO(socket, s
     val parser = MessageParser(incomingMessages)
     private val logger = if (Helpers.enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
 
-
     init {
         scope.launch {
             parser.start()
@@ -49,7 +48,10 @@ class MessageReader(socket: Socket, scope: CoroutineScope) : MessageIO(socket, s
         }
     }
 
-    suspend fun <T : ServerMessage> waitForNext(kClass: KClass<T>, predicate: (T) -> Boolean = { true }): T {
+    suspend fun <T : ServerMessage> waitForNext(
+        kClass: KClass<T>,
+        predicate: (T) -> Boolean = { true },
+    ): T {
         return messageBuffer
             .filter {
                 kClass.isInstance(it)

src/main/kotlin/com/shr4pnel/ferretirc/net/MessageWriter.kt

@@ -1,7 +1,7 @@
 package com.shr4pnel.ferretirc.net
 
-import com.shr4pnel.ferretirc.irc.util.Helpers
 import com.shr4pnel.ferretirc.net.messages.MessageIO
+import com.shr4pnel.ferretirc.util.Helpers
 import io.github.oshai.kotlinlogging.KotlinLogging
 import io.github.oshai.kotlinlogging.slf4j.logger
 import io.ktor.network.sockets.Socket
@@ -16,7 +16,8 @@ class MessageWriter(socket: Socket, scope: CoroutineScope) : MessageIO(socket, s
     private lateinit var send: ByteWriteChannel
     private val logger = if (Helpers.enableLogging) KotlinLogging.logger {} else KotlinLogging.logger(NOPLogger.NOP_LOGGER)
 
-    override fun start() = scope.launch {
+    override fun start() =
+        scope.launch {
             send = socket.openWriteChannel()
 
             for (msg in outgoingMessages) {

src/main/kotlin/com/shr4pnel/ferretirc/net/messages/ClientMessage.kt

@@ -55,7 +55,9 @@ sealed class ClientMessage(val strName: String) {
     class Nick(val nickname: String) : ClientMessage("NICK") {
         init {
             require(nickname.length < 10) { "\"$nickname\" exceeds IRCs maximum nickname length of 9" }
-            require(!nickname.startsWith(":") && !nickname.startsWith("#")) { "\"$nickname\" may not begin with : or #" } // TODO THIS SHOULD BLACKLIST ALL PREFIXES NAMED IN CHANTYPES PARAMETER
+            require(!nickname.startsWith(":") && !nickname.startsWith("#")) {
+                "\"$nickname\" may not begin with : or #"
+            } // TODO THIS SHOULD BLACKLIST ALL PREFIXES NAMED IN CHANTYPES PARAMETER
             require(!nickname.contains(" ")) { "$nickname may not contain a space" }
         }
 
@@ -97,7 +99,10 @@ sealed class ClientMessage(val strName: String) {
 
     class PrivMsg(val target: IRCChannel, val message: String) : ClientMessage("PRIVMSG") {
         override val params: kotlin.collections.List<String>
-            get() = listOf(target.chanName) // TODO RPL_ISUPPORT REQUIREMENTS IN FUN EG LINELEN STATUSMSG - ALSO ADD FUCKING STUPID STATUSMSG & SUPPORT FOR MASKS. FUCK ME
+            get() =
+                listOf(
+                    target.chanName,
+                ) // TODO RPL_ISUPPORT REQUIREMENTS IN FUN EG LINELEN STATUSMSG - ALSO ADD FUCKING STUPID STATUSMSG & SUPPORT FOR MASKS. FUCK ME
 
         override val trailing: String
             get() = message

src/main/kotlin/com/shr4pnel/ferretirc/net/messages/MessageIO.kt

@@ -7,5 +7,6 @@ import kotlinx.coroutines.channels.Channel
 abstract class MessageIO(val socket: Socket, val scope: CoroutineScope) {
     val incomingMessages = Channel<String>(Channel.BUFFERED)
     val outgoingMessages = Channel<ClientMessage>(Channel.BUFFERED)
+
     abstract fun start(): Any
 }

src/main/kotlin/com/shr4pnel/ferretirc/net/messages/ServerMessage.kt

@@ -5,16 +5,24 @@ package com.shr4pnel.ferretirc.net.messages
  */
 sealed class ServerMessage {
     data class Cap(val placeholder: String? = null) : ServerMessage()
+
     data class Pong(val token: String? = null) : ServerMessage()
+
     data class Mode(val operatorName: String, val pMask: String) : ServerMessage()
+
     data class PrivMsg(val targets: List<String>, val message: String) : ServerMessage()
+
     data class Notice(val targets: List<String>, val message: String) : ServerMessage()
+
     data class UNIMPLEMENTED(val msg: String) : ServerMessage()
 
     sealed class Numeric(val number: Short) : ServerMessage() {
-        data class RPL_ISUPPORT(val keypairs: String): Numeric(5)
+        data class RPL_ISUPPORT(val keypairs: String) : Numeric(5)
+
         class RPL_LISTSTART : Numeric(321)
+
         data class RPL_LIST(val chanName: String, val clientCount: Int, val topic: String) : Numeric(322)
+
         class RPL_LISTEND : Numeric(323)
     }
 }

src/main/kotlin/com/shr4pnel/ferretirc/util/Helpers.kt

@@ -1,4 +1,4 @@
-package com.shr4pnel.ferretirc.irc.util
+package com.shr4pnel.ferretirc.util
 
 class Helpers {
     companion object LoggingConfig {

src/test/kotlin/com/shr4pnel/ferretirc/IrcClientTest.kt

@@ -5,7 +5,6 @@ import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeoutOrNull
-import com.shr4pnel.ferretirc.net.messages.ClientMessage as Message
 import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.Test
@@ -14,6 +13,7 @@ import java.lang.ProcessBuilder
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
 import kotlin.time.Duration.Companion.seconds
+import com.shr4pnel.ferretirc.net.messages.ClientMessage as Message
 
 class IrcClientTest {
     private val logger = KotlinLogging.logger {}
@@ -25,19 +25,21 @@ class IrcClientTest {
 
         @JvmStatic
         @BeforeAll
-        fun setup() = runBlocking {
+        fun setup() =
+            runBlocking {
                 val logFile = File("src/test/resources/logs/ngircd.log")
                 val ngircdConfigPath = javaClass.classLoader.getResource("ngircd.conf")!!.path
                 logFile.createNewFile()
-            processes = ProcessBuilder.startPipeline(
+                processes =
+                    ProcessBuilder.startPipeline(
                         listOf<ProcessBuilder>(
                             // Run IRC server in [-d] debug log mode, with [-n] no daemon, using config [-f] file at path
                             ProcessBuilder("ngircd", "-dnf", ngircdConfigPath).redirectErrorStream(true),
                             // Remove unhelpful default ngircd info [PID. relative time, GID?]
                             ProcessBuilder("sed", "-ue", "s/\\[[^][]*\\]//g"),
                             // Add relative timestamp
-                    ProcessBuilder("ts", "-s", "%H:%M:%.S").redirectOutput(logFile)
+                            ProcessBuilder("ts", "-s", "%H:%M:%.S").redirectOutput(logFile),
-                )
+                        ),
                     )
                 client.connect()
                 client.register("shr4p", "Tyler D", "password")
@@ -45,7 +47,8 @@ class IrcClientTest {
 
         @JvmStatic
         @AfterAll
-        fun shutdown() = runBlocking {
+        fun shutdown() =
+            runBlocking {
                 logger.info { "Closing server." }
                 client.queueMessage(Message.Die())
                 client.waitForNext<ServerMessage.Notice>()
@@ -56,18 +59,19 @@ class IrcClientTest {
     @Test
     fun sample() {
         client.scope.launch {
-
         }
     }
 
     @Test
-    fun pingGetsPong() = runBlocking {
+    fun pingGetsPong() =
+        runBlocking {
             val token = "ACK"
             logger.info { "Sending PING $token" }
             client.queueMessage(Message.Ping(token))
 
             logger.info { "Waiting to receive PONG" }
-        val pong = withTimeoutOrNull(1.seconds) {
+            val pong =
+                withTimeoutOrNull(1.seconds) {
                     client.waitForNext<ServerMessage.Pong> { it.token.equals(token) }
                 }
             assertNotNull(pong, "Reached timeout while waiting for PONG")
@@ -76,9 +80,11 @@ class IrcClientTest {
         }
 
     @Test
-    fun oper() = runBlocking {
+    fun oper() =
+        runBlocking {
             client.queueMessage(Message.Oper("shr4p", "password"))
-        val mode = withTimeoutOrNull(1.seconds) {
+            val mode =
+                withTimeoutOrNull(1.seconds) {
                     client.waitForNext<ServerMessage.Mode>()
                 }
             assertNotNull(mode, "Timed out waiting for OPER MODE response")
@@ -88,14 +94,16 @@ class IrcClientTest {
         }
 
     @Test
-    fun listChannels() = runBlocking {
+    fun listChannels() =
+        runBlocking {
             val channels = client.server.fetchChannels()
             assert(channels.isNotEmpty())
             client.queueMessage(Message.Join(channels.first()))
         }
 
     @Test
-    fun messageLands() = runBlocking {
+    fun messageLands() =
+        runBlocking {
             val guestUser = IrcClient("localhost", 6667, false)
             guestUser.connect()
             guestUser.register("guest", "guest", "pass")