Copyright and general improvements

build-logic/build.gradle.kts

@@ -1,6 +1,3 @@
-import io.gitlab.arturbosch.detekt.DetektPlugin
-import org.jlleitschuh.gradle.ktlint.KtlintPlugin
-
 /*
  * Copyright 2024 Sujan Poudel
  *
@@ -17,6 +14,9 @@ import org.jlleitschuh.gradle.ktlint.KtlintPlugin
  * limitations under the License.
  */
 
+import io.gitlab.arturbosch.detekt.DetektPlugin
+import org.jlleitschuh.gradle.ktlint.KtlintPlugin
+
 plugins {
   `kotlin-dsl`
   alias(libs.plugins.kotlin.jvm)

build.gradle.kts

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import io.gitlab.arturbosch.detekt.Detekt
 import org.jlleitschuh.gradle.ktlint.tasks.KtLintCheckTask
 import org.jlleitschuh.gradle.ktlint.tasks.KtLintFormatTask

context-provider/build.gradle.kts

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 plugins {
   id("module")

context-provider/src/androidUnitTest/kotlin/me/sujanpoudel/utils/contextProvider/ApplicationContextInitializerTest.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.contextProvider
 
 import android.app.Application

multiplatform-paths/build.gradle.kts

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 plugins {
   id("packaging")

multiplatform-paths/src/androidMain/kotlin/me/sujanpoudel/utils/paths/directories.android.kt

@@ -1,8 +1,25 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
+import kotlinx.io.files.Path
 import me.sujanpoudel.utils.contextProvider.applicationContext
 import me.sujanpoudel.utils.paths.utils.toPath
 
-actual fun dataDirectory(appId: String) = applicationContext.applicationInfo.dataDir.toPath()
+actual fun dataDirectory(appId: String): Path = applicationContext.applicationInfo.dataDir.toPath()
 
-actual fun cacheDirectory(appId: String) = applicationContext.cacheDir.absolutePath.toPath()
+actual fun cacheDirectory(appId: String): Path = applicationContext.cacheDir.absolutePath.toPath()

multiplatform-paths/src/commonMain/kotlin/me/sujanpoudel/utils/paths/directories.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
 import kotlinx.io.files.Path

multiplatform-paths/src/commonMain/kotlin/me/sujanpoudel/utils/paths/utils/Path.kt

@@ -1,7 +1,23 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths.utils
 
 import kotlinx.io.files.Path
 
 inline fun String.toPath(): Path = Path(this)
 
-operator fun Path.div(child: String) = Path(this, child)
+operator fun Path.div(child: String): Path = Path(this, child)

multiplatform-paths/src/darwinMain/kotlin/me/sujanpoudel/utils/paths/directories.darwin.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
 import kotlinx.io.files.Path

multiplatform-paths/src/desktopCommonMain/kotlin/me/sujanpoudel/utils/paths/directories.desktopCommon.kt

@@ -1,17 +1,34 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
+import kotlinx.io.files.Path
 import me.sujanpoudel.utils.paths.utils.div
 import me.sujanpoudel.utils.paths.utils.toPath
 import me.sujanpoudel.utils.platformIdentifier.Platform
 
-fun desktopAppHomeDirectory(appId: String, os: Platform.OS, getEnv: (String) -> String) = when (os) {
+fun desktopAppHomeDirectory(appId: String, os: Platform.OS, getEnv: (String) -> String): Path = when (os) {
   is Platform.OS.MacOs -> getEnv("HOME").toPath() / "Library/Application Support" / appId
   is Platform.OS.Windows -> getEnv("APPDATA").toPath() / appId
   is Platform.OS.Linux -> getEnv("HOME").toPath() / ".local" / "share" / appId
   else -> getEnv("HOME").toPath() / ".$appId"
 }
 
-fun desktopCacheDirectory(appId: String, os: Platform.OS, getEnv: (String) -> String) = when (os) {
+fun desktopCacheDirectory(appId: String, os: Platform.OS, getEnv: (String) -> String): Path = when (os) {
   is Platform.OS.MacOs -> getEnv("HOME").toPath() / "Library/Caches" / appId
   is Platform.OS.Windows -> getEnv("APPDATA").toPath() / "Caches" / appId
   is Platform.OS.Linux -> getEnv("HOME").toPath() / ".cache" / appId

multiplatform-paths/src/desktopMain/kotlin/me/sujanpoudel/utils/paths/directories.desktop.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
 import me.sujanpoudel.utils.platformIdentifier.hostOs

multiplatform-paths/src/jsMain/kotlin/me/sujanpoudel/utils/paths/directories.js.kt

@@ -1,11 +1,28 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.paths
 
+import kotlinx.io.files.Path
 import me.sujanpoudel.utils.platformIdentifier.Platform
 import me.sujanpoudel.utils.platformIdentifier.platform
 
 private val platform = platform() as Platform.JS
 
-actual fun dataDirectory(appId: String) = when (platform) {
+actual fun dataDirectory(appId: String): Path = when (platform) {
   is Platform.JS.Node -> desktopAppHomeDirectory(
     appId = appId,
     os = platform.os,
@@ -15,7 +32,7 @@ actual fun dataDirectory(appId: String) = when (platform) {
   else -> error("Non node environment")
 }
 
-actual fun cacheDirectory(appId: String) = when (platform) {
+actual fun cacheDirectory(appId: String): Path = when (platform) {
   is Platform.JS.Node -> desktopCacheDirectory(
     appId = appId,
     os = platform.os,

platform-identifier/build.gradle.kts

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 plugins {
   id("packaging")

platform-identifier/src/androidMain/kotlin/me/sujanpoudel/utils/platformIdentifier/platform.android.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.platformIdentifier
 
 import android.content.pm.PackageManager

platform-identifier/src/androidNativeMain/kotlin/me/sujanpoudel/utils/platformIdentifier/platform.androidNative.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.platformIdentifier
 
 import kotlinx.cinterop.ByteVar
@@ -8,8 +24,8 @@ import kotlinx.cinterop.toKString
 import platform.posix.__system_property_get
 import kotlin.experimental.ExperimentalNativeApi
 
-const val SYSTEM_PROP_BUILD_VERSION = "ro.build.version.sdk"
-const val SYSTEM_PROP_OS_VERSION = "ro.build.version.release"
+private const val SYSTEM_PROP_BUILD_VERSION: String = "ro.build.version.sdk"
+private const val SYSTEM_PROP_OS_VERSION: String = "ro.build.version.release"
 
 @OptIn(ExperimentalNativeApi::class)
 actual fun platform(): Platform {

platform-identifier/src/androidNativeTest/kotlin/me/sujanpoudel/utils/platformIdentifier/PlatformTest.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.platformIdentifier
 
 import kotlin.test.Test

platform-identifier/src/androidUnitTest/kotlin/me/sujanpoudel/utils/platformIdentifier/PlatformTest.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2024 Sujan Poudel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package me.sujanpoudel.utils.platformIdentifier
 
 import android.content.Context