Merge pull request #4 from DevelopersBreach/shreyas/implement-ktlint

Configure Ktlint - integration for code formatting and linting automation

Author: yesshreyes

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*.{kt,kts}]
+
+ktlint_code_style = ktlint_official
+insert_final_newline = false
+ij_kotlin_packages_to_use_import_on_demand = false
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
+max_line_length = off
+ktlint_function_naming_ignore_when_annotated_with = Composable
+ktlint_standard_import-ordering = disabled
+ktlint_standard_no-empty-first-line-in-class-body = disabled
+ktlint_standard_annotation = disabled
+ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_string-template-indent = disabled

composeApp/build.gradle.kts

@@ -3,13 +3,25 @@ import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackConfig
+import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
 
 plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.androidApplication)
     alias(libs.plugins.composeMultiplatform)
     alias(libs.plugins.composeCompiler)
     alias(libs.plugins.serialization)
+    alias(libs.plugins.ktlint)
+}
+
+ktlint {
+    android = true
+    ignoreFailures = false
+    reporters {
+        reporter(ReporterType.PLAIN)
+        reporter(ReporterType.CHECKSTYLE)
+        reporter(ReporterType.SARIF)
+    }
 }
 
 kotlin {
@@ -19,20 +31,20 @@ kotlin {
             jvmTarget.set(JvmTarget.JVM_11)
         }
     }
-    
+
     listOf(
         iosX64(),
         iosArm64(),
-        iosSimulatorArm64()
+        iosSimulatorArm64(),
     ).forEach { iosTarget ->
         iosTarget.binaries.framework {
             baseName = "ComposeApp"
             isStatic = true
         }
     }
-    
+
     jvm("desktop")
-    
+
     @OptIn(ExperimentalWasmDsl::class)
     wasmJs {
         moduleName = "composeApp"
@@ -52,10 +64,10 @@ kotlin {
         }
         binaries.executable()
     }
-    
+
     sourceSets {
         val desktopMain by getting
-        
+
         androidMain.dependencies {
             implementation(compose.preview)
             implementation(libs.androidx.activity.compose)
@@ -135,4 +147,4 @@ compose.desktop {
             packageVersion = "1.0.0"
         }
     }
-}
+}

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/App.kt

@@ -1,7 +1,7 @@
 package com.developersbreach.kotlindictionarymultiplatform
 
 import androidx.compose.material.MaterialTheme
-import androidx.compose.runtime.*
+import androidx.compose.runtime.Composable
 import com.developersbreach.kotlindictionarymultiplatform.ui.navigation.AppNavigation
 
 @Composable

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/ApiKey.kt

@@ -1,3 +1,3 @@
 package com.developersbreach.kotlindictionarymultiplatform.core
 
-const val API_KEY =""
+const val API_KEY = ""

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/KtorHttpClient.kt

@@ -20,7 +20,6 @@ import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.decodeFromJsonElement
 import kotlinx.serialization.json.jsonObject
 
-
 object KtorHttpClient {
     private val json = Json { ignoreUnknownKeys = true }
 
@@ -76,33 +75,36 @@ object KtorHttpClient {
           },
           "required": ["topicId","topicName","intro","syntax","sections"]
         }
-        """.trimIndent()
+        """.trimIndent(),
     )
 
     private val functionDef = FunctionDefinition(
         name = "generate_kotlin_topic_details",
         description = "Return a fully-featured Kotlin documentation object for a given topic",
-        parameters = functionSchema
+        parameters = functionSchema,
     )
 
     /**
      * Calls the OpenAI ChatCompletion with function-calling to get topic details.
      * @param topicId the topic identifier, e.g. "variables".
      * @param apiKey your OpenAI API key.
      */
-    suspend fun generateTopicDetails(topicId: String, apiKey: String): KotlinTopicDetails {
+    suspend fun generateTopicDetails(
+        topicId: String,
+        apiKey: String,
+    ): KotlinTopicDetails {
         // Prepare messages
         val messages = listOf(
             ChatMessage("system", "You are a Kotlin documentation generator."),
-            ChatMessage("user", "Generate full Kotlin documentation for topic \"$topicId\".")
+            ChatMessage("user", "Generate full Kotlin documentation for topic \"$topicId\"."),
         )
 
         // Build request body
         val request = ChatCompletionRequest(
             model = "gpt-4o-mini",
             messages = messages,
             functions = listOf(functionDef),
-            functionCall = mapOf("name" to functionDef.name)
+            functionCall = mapOf("name" to functionDef.name),
         )
 
         // Execute HTTP request

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/detail/KotlinTopicDetails.kt

@@ -13,65 +13,65 @@ data class KotlinTopicDetails(
     val sections: List<Section>,
     val pitfalls: List<String> = emptyList(),
     val relatedTopics: List<String> = emptyList(),
-    val metadata: Map<String, JsonElement> = emptyMap()
+    val metadata: Map<String, JsonElement> = emptyMap(),
 )
 
 @Serializable
 data class Syntax(
     val signature: String,
-    val notes: String? = null
+    val notes: String? = null,
 )
 
 @Serializable
 data class Section(
     val heading: String? = null,
     val content: String? = null,
-    val codeExamples: List<CodeExample> = emptyList()
+    val codeExamples: List<CodeExample> = emptyList(),
 )
 
 @Serializable
 data class CodeExample(
     val description: String? = null,
     val code: String,
-    val language: String = "kotlin"
+    val language: String = "kotlin",
 )
 
 // --- Request/Response schema for OpenAI Chat Completion ---
 @Serializable
 data class ChatMessage(
     val role: String,
-    val content: String
+    val content: String,
 )
 
 @Serializable
 data class FunctionDefinition(
     val name: String,
     val description: String,
-    val parameters: JsonElement
+    val parameters: JsonElement,
 )
 
 @Serializable
 data class FunctionCall(
     val name: String,
-    val arguments: String
+    val arguments: String,
 )
 
 @Serializable
 data class ChatCompletionChoice(
-    val message: ChatCompletionResponseMessage
+    val message: ChatCompletionResponseMessage,
 )
 
 @Serializable
 data class ChatCompletionResponseMessage(
     val role: String,
     val content: String? = null,
     @SerialName("function_call")
-    val functionCall: FunctionCall? = null
+    val functionCall: FunctionCall? = null,
 )
 
 @Serializable
 data class ChatCompletionResponse(
-    val choices: List<ChatCompletionChoice>?
+    val choices: List<ChatCompletionChoice>?,
 )
 
 @Serializable
@@ -80,5 +80,5 @@ data class ChatCompletionRequest(
     val messages: List<ChatMessage>,
     val functions: List<FunctionDefinition>,
     @SerialName("function_call")
-    val functionCall: Map<String, String>
+    val functionCall: Map<String, String>,
 )

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/topic/model/Topic.kt

@@ -1,5 +1,5 @@
 package com.developersbreach.kotlindictionarymultiplatform.data.topic.model
 
 data class Topic(
-    val name: String
+    val name: String,
 )

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/topic/repository/TopicRepository.kt

@@ -18,6 +18,6 @@ object TopicRepository {
         Topic("Delegation"),
         Topic("Sealed Classes"),
         Topic("Generics"),
-        Topic("Annotations")
+        Topic("Annotations"),
     )
 }

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/navigation/AppNavigation.kt

@@ -16,7 +16,7 @@ fun AppNavigation(
     startDestination: AppDestinations = AppDestinations.TopicList,
 ) {
     val navController = rememberNavController()
-    val actions = remember(navController) { NavigationActions(navController) }
+    val actions = remember(navController) { NavigationAction(navController) }
 
     NavHost(
         navController = navController,
@@ -28,7 +28,7 @@ fun AppNavigation(
                 onTopicClick = { selectedTopicId ->
                     actions.navigateToDetail(selectedTopicId)
                 },
-                viewModel = viewModel
+                viewModel = viewModel,
             )
         }
 

composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/navigation/NavigationAction.kt

@@ -2,7 +2,7 @@ package com.developersbreach.kotlindictionarymultiplatform.ui.navigation
 
 import androidx.navigation.NavHostController
 
-class NavigationActions(private val navController: NavHostController) {
+class NavigationAction(private val navController: NavHostController) {
 
     val navigateToDetail: (String) -> Unit = { topicId ->
         navController.navigate(AppDestinations.Detail(topicId))