Merge main to develop (#834)

* Upgrade version to 0.13.0

* Update check kttx snippets

* Update check kttx snippets

* Update check kttx snippets

* Update version

* Update scripts

* Update scripts

* Update dev readme

* Release `v0.13.0` (#688)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Igor Wojda <igor.wojda@gmail.com>
Co-authored-by: NataliaPeterwas <111683562+nataliapeterwas@users.noreply.github.com>
Co-authored-by: Jony Sarco <jfe.sarco@gmail.com>

* Revert "Release `v0.13.0`" (#689)

* Update Konsist in starter projects to Konsist `v0.13.0` (#697)

* Update Kotest Snippets (#701)

* Replace REGEX to allow using .. as wildcard again (#720)

* Update README.md (#771)

* Fixed broken link to the getting started guide. (#827)

* Fix wrong detection of Git root project dir (#831)

Detection never worked before because Git creates directory
called '.git', while code was checking 'git'.

* Fix test

* Disable KMP starter projects

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: NataliaPeterwas <111683562+nataliapeterwas@users.noreply.github.com>
Co-authored-by: Jony Sarco <jfe.sarco@gmail.com>
Co-authored-by: Guillermo Guerrero González <3263397+guiguegon@users.noreply.github.com>
Co-authored-by: Atiq Ur Rehman <6600985@gmail.com>
Co-authored-by: Piotr Kubowicz <piotr.kubowicz@gmail.com>

Author: 7 people

.github/workflows/check-starter-projects.yml

@@ -506,79 +506,79 @@ jobs:
       - name: Run Konsist Test
         run: cd samples/starter-projects/konsist-starter-spring-maven-kotest/ && mvn test
 
-  konsist-starter-kmp-gradle-kotlin-junit5:
-    name: Konsist Starter KMP Gradle Kotlin Junit 5
-    needs: get-github-context
-    runs-on: ubuntu-latest
-    if: |
-      startsWith(needs.get-github-context.outputs.current_branch, 'release/') ||
-      startsWith(needs.get-github-context.outputs.current_branch, 'renovate/') ||
-      contains(needs.get-github-context.outputs.current_branch, 'starter-projects') ||
-      needs.get-github-context.outputs.base_ref_branch == 'main' ||
-      contains(needs.get-github-context.outputs.all_changed_files, 'samples/starter-projects/')
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up JDK
-        uses: actions/setup-java@v3
-        with:
-          java-version: 19
-          distribution: 'zulu'
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.11.3'
-
-      - name: Add Maven Local Repository
-        run: python3 scripts/replace_konsist_version/add_maven_local_repository_to_config_file.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/build.gradle.kts
-
-      - name: Replace Konsist Version
-        run: python3 scripts/replace_konsist_version/replace_konsist_version_gradle_groovy.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/build.gradle.kts
-
-      - name: Publish Konsist Artifact To Local Maven Repository
-        run: >
-          ./gradlew publishToMavenLocal
-
-      - name: Run Konsist Test
-        run: cd samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/ && ./gradlew test
-
-
-  konsist-starter-kmp-gradle-kotlin-kotest:
-    name: Konsist Starter KMP Gradle Kotlin KoTest
-    needs: get-github-context
-    runs-on: ubuntu-latest
-    if: |
-      startsWith(needs.get-github-context.outputs.current_branch, 'release/') ||
-      startsWith(needs.get-github-context.outputs.current_branch, 'renovate/') ||
-      contains(needs.get-github-context.outputs.current_branch, 'starter-projects') ||
-      needs.get-github-context.outputs.base_ref_branch == 'main' ||
-      contains(needs.get-github-context.outputs.all_changed_files, 'samples/starter-projects/')
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up JDK
-        uses: actions/setup-java@v3
-        with:
-          java-version: 19
-          distribution: 'zulu'
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.11.3'
-
-      - name: Add Maven Local Repository
-        run: python3 scripts/replace_konsist_version/add_maven_local_repository_to_config_file.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/build.gradle.kts
-
-      - name: Replace Konsist Version
-        run: python3 scripts/replace_konsist_version/replace_konsist_version_gradle_groovy.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/build.gradle.kts
-
-      - name: Publish Konsist Artifact To Local Maven Repository
-        run: >
-          ./gradlew publishToMavenLocal
-
-      - name: Run Konsist Test
-        run: cd samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/ && ./gradlew test
+#  konsist-starter-kmp-gradle-kotlin-junit5:
+#    name: Konsist Starter KMP Gradle Kotlin Junit 5
+#    needs: get-github-context
+#    runs-on: ubuntu-latest
+#    if: |
+#      startsWith(needs.get-github-context.outputs.current_branch, 'release/') ||
+#      startsWith(needs.get-github-context.outputs.current_branch, 'renovate/') ||
+#      contains(needs.get-github-context.outputs.current_branch, 'starter-projects') ||
+#      needs.get-github-context.outputs.base_ref_branch == 'main' ||
+#      contains(needs.get-github-context.outputs.all_changed_files, 'samples/starter-projects/')
+#    steps:
+#      - name: Checkout
+#        uses: actions/checkout@v4
+#
+#      - name: Set up JDK
+#        uses: actions/setup-java@v3
+#        with:
+#          java-version: 19
+#          distribution: 'zulu'
+#
+#      - name: Set up Python
+#        uses: actions/setup-python@v4
+#        with:
+#          python-version: '3.11.3'
+#
+#      - name: Add Maven Local Repository
+#        run: python3 scripts/replace_konsist_version/add_maven_local_repository_to_config_file.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/build.gradle.kts
+#
+#      - name: Replace Konsist Version
+#        run: python3 scripts/replace_konsist_version/replace_konsist_version_gradle_groovy.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/build.gradle.kts
+#
+#      - name: Publish Konsist Artifact To Local Maven Repository
+#        run: >
+#          ./gradlew publishToMavenLocal
+#
+#      - name: Run Konsist Test
+#        run: cd samples/starter-projects/konsist-starter-kmp-gradle-kotlin-junit5/ && ./gradlew test
+
+
+#  konsist-starter-kmp-gradle-kotlin-kotest:
+#    name: Konsist Starter KMP Gradle Kotlin KoTest
+#    needs: get-github-context
+#    runs-on: ubuntu-latest
+#    if: |
+#      startsWith(needs.get-github-context.outputs.current_branch, 'release/') ||
+#      startsWith(needs.get-github-context.outputs.current_branch, 'renovate/') ||
+#      contains(needs.get-github-context.outputs.current_branch, 'starter-projects') ||
+#      needs.get-github-context.outputs.base_ref_branch == 'main' ||
+#      contains(needs.get-github-context.outputs.all_changed_files, 'samples/starter-projects/')
+#    steps:
+#      - name: Checkout
+#        uses: actions/checkout@v4
+#
+#      - name: Set up JDK
+#        uses: actions/setup-java@v3
+#        with:
+#          java-version: 19
+#          distribution: 'zulu'
+#
+#      - name: Set up Python
+#        uses: actions/setup-python@v4
+#        with:
+#          python-version: '3.11.3'
+#
+#      - name: Add Maven Local Repository
+#        run: python3 scripts/replace_konsist_version/add_maven_local_repository_to_config_file.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/build.gradle.kts
+#
+#      - name: Replace Konsist Version
+#        run: python3 scripts/replace_konsist_version/replace_konsist_version_gradle_groovy.py samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/build.gradle.kts
+#
+#      - name: Publish Konsist Artifact To Local Maven Repository
+#        run: >
+#          ./gradlew publishToMavenLocal
+#
+#      - name: Run Konsist Test
+#        run: cd samples/starter-projects/konsist-starter-kmp-gradle-kotlin-kotest/ && ./gradlew test

README.md

@@ -5,10 +5,8 @@
 ![Check Workflow](https://github.com/LemonAppDev/konsist/actions/workflows/check.yml/badge.svg)
 [<img src="https://img.shields.io/maven-central/v/com.lemonappdev/konsist?label=Release"/>](https://central.sonatype.com/artifact/com.lemonappdev/konsist)
 
-Konsist is a library that guards the consistency of [Kotlin](https://kotlinlang.org/) projects by promoting the
-standardization of the Kotlin codebase. It enforces coding conventions and project architecture. Konsist
-tests are written in Kotlin and can be easily integrated with popular testing frameworks such as 
-[JUnit4](https://junit.org/junit4/), [JUnit5](https://junit.org/junit5/).
+Konsist is a linter that guards the consistency of [Kotlin](https://kotlinlang.org/) projects by enforcing a cohesive code structure 
+and unified architecture. Konsist guards are written in the form of unit tests ([JUnit](https://junit.org/) / [Kotest](https://kotest.io/)).
 
 ## Dependencies
 
@@ -29,11 +27,12 @@ testImplementation "com.lemonappdev:konsist:0.13.0"
 ```
 
 Check the [Konsist documentation](https://docs.konsist.lemonappdev.com/) to learn more about Konsist and take a 
-look at [getting started guide](https://docs.konsist.lemonappdev.com/getting-started/gettingstarted).
+look at [getting started guide](https://docs.konsist.lemonappdev.com/getting-started/getting-started).
 
 ## Examples
 
-Konsist API reflects the structure of Kotlin code. Konsist guards are written in form of unit tests.
+Konsist API reflects the structure of Kotlin code. All declarations such as classes, functions, and properties can be
+queried and verified with the Konsist API. Take a look at a few examples below.
 
 ### General Kotlin Check
 
@@ -93,6 +92,8 @@ fun `clean architecture layers have correct dependencies`() {
 }
 ```
 
+Check out our [snippet](https://docs.konsist.lemonappdev.com/inspiration/snippets) page for a feast of examples!
+    
 ## Articles
 
 Read the [Konsist articles](https://docs.konsist.lemonappdev.com/getting-started/getting-started/articles) to gain valuable insights into best practices and strategies for maintaining consistency in your projects.

gradle.properties

@@ -2,5 +2,4 @@
 org.gradle.parallel=true
 org.gradle.daemon=true
 
-
 konsist.version=0.13.0

lib/src/main/kotlin/com/lemonappdev/konsist/core/filesystem/rootprovider/GitProjectRootDirResolver.kt

@@ -13,8 +13,8 @@ class GitProjectRootDirResolver(
     Description of the '.git' directory https://githowto.com/git_internals_git_directory
      */
     override val paths = setOf(
-        "./.git/config".toOsSeparator(),
-        "./.git/HEAD".toOsSeparator(),
-        "./.git/refs".toOsSeparator(),
+        ".git/config".toOsSeparator(),
+        ".git/HEAD".toOsSeparator(),
+        ".git/refs".toOsSeparator(),
     )
 }

lib/src/main/kotlin/com/lemonappdev/konsist/core/util/LocationUtil.kt

@@ -10,10 +10,14 @@ object LocationUtil {
      *    \w  = Matches any word char (alpha & underscore).
      *    +   = Match 1 or more of the preceding token.
      *    |   = OR
+     *  \.{2}?= allow using '..' as wildcard optionally (only one accepted)
+     *    \w  = Matches any word char (alpha & underscore).
+     *    +   = Match 1 or more of the preceding token.
+     *    |   = OR
      *  \.{2} = escaped char '.' (dot) appearing 2 times
      *    $   = Matches end of string
      */
-    internal const val REGEX_PACKAGE_NAME_END_TWO_DOTS = "(?:^\\w+|\\w+\\.\\w+)+\\.{2}\$"
+    internal const val REGEX_PACKAGE_NAME_END_TWO_DOTS = "(?:^\\w+|\\w+\\.\\w+\\.{2}?\\w+|\\w+\\.\\w+)+\\.{2}\$"
 
     /**
      * Use '..' as a wildcard for any number of characters.

lib/src/test/kotlin/com/lemonappdev/konsist/api/architecture/LayerTest.kt

@@ -19,7 +19,18 @@ class LayerTest {
     }
 
     @Test
-    fun `throws an exception when layer is defined by package without three dots at the end`() {
+    fun `throws an exception when layer is defined by package without two dots at the end with dots as wildcard`() {
+        // given
+        val sut = { Layer("Domain", "package..feature") }
+
+        // then
+        sut shouldThrow KoPreconditionFailedException::class withMessage """
+            Layer Domain must be defined by package ending with '..'. Now: package..feature .
+        """.trimIndent()
+    }
+
+    @Test
+    fun `throws an exception when layer is defined by package with three dots at the end`() {
         // given
         val sut = { Layer("Domain", "package...") }
 
@@ -43,11 +54,11 @@ class LayerTest {
     @Test
     fun `throws an exception when layer is defined by package containing dots with more than two dots at the end`() {
         // given
-        val sut = { Layer("Domain", "first.second.third_p.package....") }
+        val sut = { Layer("Domain", "first.second..third_p.package....") }
 
         // then
         sut shouldThrow KoPreconditionFailedException::class withMessage """
-            Layer Domain must be defined by package ending with '..'. Now: first.second.third_p.package.... .
+            Layer Domain must be defined by package ending with '..'. Now: first.second..third_p.package.... .
         """.trimIndent()
     }
 
@@ -61,4 +72,26 @@ class LayerTest {
             Layer Domain must be defined by package ending with '..'. Now: first.second.third_p.package.... .
         """.trimIndent()
     }
+
+    @Test
+    fun `do not throw an exception when the package ends with two dots and there are another two dots used as wildcard`() {
+        // given
+        val sut = { Layer("Domain", "first.second..package..") }
+
+        // then
+        sut shouldNotThrow KoPreconditionFailedException::class withMessage """
+            Layer Domain must be defined by package ending with '..'. Now: first.second.third_p.package.... .
+        """.trimIndent()
+    }
+
+    @Test
+    fun `throws an exception when the package ends with two dots and there more than two dots used as wildcard`() {
+        // given
+        val sut = { Layer("Domain", "first.second..package..feature1..") }
+
+        // then
+        sut shouldThrow KoPreconditionFailedException::class withMessage """
+            Layer Domain must be defined by package ending with '..'. Now: first.second..package..feature1.. .
+        """.trimIndent()
+    }
 }

lib/src/test/kotlin/com/lemonappdev/konsist/core/filesystem/rootprovider/GitProjectRootDirResolverTest.kt

@@ -13,9 +13,9 @@ class GitProjectRootDirResolverTest {
         // given
         val file = mockk<File>()
         val pathVerifier = mockk<PathVerifier>()
-        every { pathVerifier.verifyPathIfExists(file, "./.git/config") } returns true
-        every { pathVerifier.verifyPathIfExists(file, "./.git/HEAD") } returns true
-        every { pathVerifier.verifyPathIfExists(file, "./.git/refs") } returns true
+        every { pathVerifier.verifyPathIfExists(file, ".git/config") } returns true
+        every { pathVerifier.verifyPathIfExists(file, ".git/HEAD") } returns true
+        every { pathVerifier.verifyPathIfExists(file, ".git/refs") } returns true
         val sut = GitProjectRootDirResolver(pathVerifier)
 
         // when

samples/starter-projects/konsist-starter-android-gradle-groovy-junit-4/konsistTest/build.gradle

@@ -36,6 +36,8 @@ dependencies {
     // Add JUnit dependency
     testImplementation 'junit:junit:4.13.2'
 
-    // Add Konsist dependency
     testImplementation 'com.lemonappdev:konsist:0.13.0'
+
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 }

samples/starter-projects/konsist-starter-android-gradle-groovy-junit-5/konsistTest/build.gradle

@@ -40,4 +40,7 @@ dependencies {
 
     // Add Konsist dependency
     testImplementation 'com.lemonappdev:konsist:0.13.0'
+
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 }