KON-74 Add Ignore Build Config

lib/src/main/kotlin/com/lemonappdev/konsist/api/KoScopeCreator.kt

@@ -25,8 +25,9 @@ interface KoScopeCreator {
      *
      * @param moduleName The name of the module. If null, all modules will be included.
      * @param sourceSetName The name of the source set. If null, all source sets will be included.
+     * @param ignoreBuildConfig If true, build config files such as Gradle buildSrc directory will be ignored.
      */
-    fun scopeFromProject(moduleName: String? = null, sourceSetName: String? = null): KoScope
+    fun scopeFromProject(moduleName: String? = null, sourceSetName: String? = null, ignoreBuildConfig: Boolean = true): KoScope
 
     /**
      * Returns a [KoScope] containing all of Kotlin files in the module.

lib/src/main/kotlin/com/lemonappdev/konsist/core/KoScopeCreatorImpl.kt

@@ -33,8 +33,8 @@ internal class KoScopeCreatorImpl : KoScopeCreator {
 
     override val rootProjectDirectory = pathProvider.rootProjectDirectory
 
-    override fun scopeFromProject(moduleName: String?, sourceSetName: String?): KoScope {
-        val koFiles = getFiles(moduleName, sourceSetName)
+    override fun scopeFromProject(moduleName: String?, sourceSetName: String?, ignoreBuildConfig: Boolean): KoScope {
+        val koFiles = getFiles(moduleName, sourceSetName, ignoreBuildConfig)
         return KoScopeImpl(koFiles)
     }
 
@@ -48,9 +48,20 @@ internal class KoScopeCreatorImpl : KoScopeCreator {
         return KoScopeImpl(koFiles)
     }
 
-    private fun getFiles(moduleName: String? = null, sourceSetName: String? = null): Sequence<KoFileDeclaration> {
+    private fun getFiles(
+        moduleName: String? = null,
+        sourceSetName: String? = null,
+        ignoreBuildConfig: Boolean = true,
+    ): Sequence<KoFileDeclaration> {
         val localProjectKotlinFiles = projectKotlinFiles
             .filterNot { isBuildPath(it.filePath) }
+            .let {
+                if (ignoreBuildConfig) {
+                    it.filterNot { file -> file.isBuildConfigFile() }
+                } else {
+                    it
+                }
+            }
 
         if (moduleName == null && sourceSetName == null) {
             return localProjectKotlinFiles
@@ -139,8 +150,8 @@ internal class KoScopeCreatorImpl : KoScopeCreator {
     }
 
     private fun isTestPath(path: String): Boolean {
-        val localPath = path.lowercase()
-        return localPath.contains("/$TEST_NAME_IN_PATH") || localPath.contains("$TEST_NAME_IN_PATH/")
+        val lowercasePath = path.lowercase()
+        return lowercasePath.contains("/$TEST_NAME_IN_PATH") || lowercasePath.contains("$TEST_NAME_IN_PATH/")
     }
 
     private fun isTestSourceSet(name: String): Boolean {
@@ -153,6 +164,12 @@ internal class KoScopeCreatorImpl : KoScopeCreator {
         return isTestPath(path)
     }
 
+    private fun KoFileDeclaration.isBuildConfigFile(): Boolean {
+        val lowercasePath = filePath.lowercase()
+        val gradleBuildConfigDirectoryName = "buildSrc".lowercase()
+        return lowercasePath.matches(Regex(".*/$gradleBuildConfigDirectoryName.*"))
+    }
+
     private fun File.toKoFiles() = walk()
         .filter { it.isKotlinFile }
         .map { it.toKoFile() }

test/konsist-scope-creation/app/src/integrationTest/kotlin/com/lemonappdev/konsist/KonsistTestForScopeFromProject.kt

@@ -6,17 +6,18 @@ import com.lemonappdev.konsist.util.PathProvider.appIntegrationTestSourceSetDire
 import com.lemonappdev.konsist.util.PathProvider.appMainSourceSetDirectory
 import com.lemonappdev.konsist.util.PathProvider.dataMainSourceSetDirectory
 import com.lemonappdev.konsist.util.PathProvider.dataTestSourceSetDirectory
+import com.lemonappdev.konsist.util.PathProvider.projectRootDirectory
 import com.lemonappdev.konsist.util.PathProvider.rootMainSourceSetDirectory
 import com.lemonappdev.konsist.util.PathProvider.rootTestSourceSetDirectory
 import org.amshove.kluent.shouldBeEqualTo
 import org.junit.jupiter.api.Test
 
 class KonsistTestForScopeFromProject {
     @Test
-    fun `scopeFromProject`() {
+    fun `scopeFromProject ignoreBuildConfig true`() {
         // given
         val sut = Konsist
-            .scopeFromProject()
+            .scopeFromProject(ignoreBuildConfig = true)
             .mapToFilePaths()
 
         // then
@@ -51,6 +52,46 @@ class KonsistTestForScopeFromProject {
         )
     }
 
+    @Test
+    fun `scopeFromProject ignoreBuildConfig false`() {
+        // given
+        val sut = Konsist
+            .scopeFromProject(ignoreBuildConfig = false)
+            .mapToFilePaths()
+
+        // then
+        sut.shouldBeEqualTo(
+            listOf(
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForRootProjectPath.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromDirectory.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromFile.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromModule.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromPackage.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromProduction.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromProject.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromSourceSet.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForScopeFromTest.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/KonsistTestForToString.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/ext/KoScopeExt.kt",
+                "$appIntegrationTestSourceSetDirectory/konsist/util/PathProvider.kt",
+                "$appIntegrationTestSourceSetDirectory/sample/AppClassTest.kt",
+                "$appIntegrationTestSourceSetDirectory/sample/data/AppDataClassTest.kt",
+                "$appMainSourceSetDirectory/sample/AppClass.kt",
+                "$appMainSourceSetDirectory/sample/data/AppDataClass.kt",
+                "$projectRootDirectory/buildSrc/RootBuildScrKotlinClass.kt",
+                "$dataMainSourceSetDirectory/sample/LibClass.kt",
+                "$dataMainSourceSetDirectory/sample/data/LibDataClass.kt",
+                "$dataTestSourceSetDirectory/sample/LibClassTest.kt",
+                "$dataTestSourceSetDirectory/sample/data/LibDataClassTest.kt",
+                "$rootMainSourceSetDirectory/sample/RootClass.kt",
+                "$rootMainSourceSetDirectory/sample/data/RootDataClass.kt",
+                "$rootTestSourceSetDirectory/konsist/KonsistTestForRootProjectPath.kt",
+                "$rootTestSourceSetDirectory/sample/RootClassTest.kt",
+                "$rootTestSourceSetDirectory/sample/data/RootDataClassTest.kt",
+            ),
+        )
+    }
+
     @Test
     fun `scopeFromProject for data module`() {
         // given

test/konsist-scope-creation/app/src/integrationTest/kotlin/com/lemonappdev/konsist/util/PathProvider.kt

@@ -3,7 +3,7 @@ package com.lemonappdev.konsist.util
 import java.io.File
 
 object PathProvider {
-    private val projectRootDirectory = File("")
+    val projectRootDirectory = File("")
         .absoluteFile
         .path
         .dropLastWhile { it != '/' }

test/konsist-scope-creation/buildSrc/RootBuildScrKotlinClass.kt

@@ -0,0 +1 @@
+class RootBuildScrKotlinClass