From ea777eb976f6e69ddad7db61f32da84816fb2700 Mon Sep 17 00:00:00 2001
From: HerringtonDarkholme
 <2883231+HerringtonDarkholme@users.noreply.github.com>
Date: Sun, 2 Feb 2025 00:33:20 -0500
Subject: [PATCH] catalog: add kotlin example

fix #663
---
 website/catalog/index.md                      |  2 +
 .../kotlin/ensure-clean-architecture.md       | 45 +++++++++++++++++++
 website/catalog/kotlin/index.md               |  5 +++
 3 files changed, 52 insertions(+)
 create mode 100644 website/catalog/kotlin/ensure-clean-architecture.md
 create mode 100644 website/catalog/kotlin/index.md

diff --git a/website/catalog/index.md b/website/catalog/index.md
index 5cd5ca8a..536103cc 100644
--- a/website/catalog/index.md
+++ b/website/catalog/index.md
@@ -20,6 +20,8 @@ Feel free to join our [Discord](https://discord.gg/4YZjf6htSQ) channel and ask @
   * [Extract i18n Keys](/catalog/html/#extract-i18n-keys)
 * [Java](/catalog/java/)
   * [No Unused Vars](/catalog/java/#no-unused-vars)
+* [Kotlin](/catalog/kotlin/)
+  * [Ensure Clean Architecture](/catalog/kotlin/#ensure-clean-architecture)
 * [Python](/catalog/python/)
   * [Migrate OpenAi SDK](/catalog/python/#migrate-openai-sdk)
   * [Use Walrus Operator in `if` statement](/catalog/python/#use-walrus-operator-in-if-statement)
diff --git a/website/catalog/kotlin/ensure-clean-architecture.md b/website/catalog/kotlin/ensure-clean-architecture.md
new file mode 100644
index 00000000..967046a7
--- /dev/null
+++ b/website/catalog/kotlin/ensure-clean-architecture.md
@@ -0,0 +1,45 @@
+<!-- Remove Badge if it does not have fix-->
+## Ensure Clean Architecture
+
+* [Playground Link](/playground.html#eyJtb2RlIjoiQ29uZmlnIiwibGFuZyI6ImtvdGxpbiIsInF1ZXJ5IjoiIiwicmV3cml0ZSI6IiIsInN0cmljdG5lc3MiOiJyZWxheGVkIiwic2VsZWN0b3IiOiIiLCJjb25maWciOiJpZDogaW1wb3J0LWRlcGVuZGVuY3ktdmlvbGF0aW9uXG5tZXNzYWdlOiBJbXBvcnQgRGVwZW5kZW5jeSBWaW9sYXRpb24gXG5ub3RlczogRW5zdXJlcyB0aGF0IGltcG9ydHMgY29tcGx5IHdpdGggYXJjaGl0ZWN0dXJhbCBydWxlcy4gXG5zZXZlcml0eTogZXJyb3JcbnJ1bGU6XG4gIHBhdHRlcm46IGltcG9ydCAkUEFUSFxuY29uc3RyYWludHM6XG4gIFBBVEg6XG4gICAgYW55OlxuICAgIC0gcmVnZXg6IGNvbVxcLmV4YW1wbGUoXFwuXFx3KykqXFwuZGF0YVxuICAgIC0gcmVnZXg6IGNvbVxcLmV4YW1wbGUoXFwuXFx3KykqXFwucHJlc2VudGF0aW9uXG5maWxlczpcbi0gY29tL2V4YW1wbGUvZG9tYWluLyoqLyoua3QiLCJzb3VyY2UiOiJpbXBvcnQgYW5kcm9pZHgubGlmZWN5Y2xlLlZpZXdNb2RlbFxuaW1wb3J0IGFuZHJvaWR4LmxpZmVjeWNsZS5WaWV3TW9kZWxTY29wZVxuaW1wb3J0IGNvbS5leGFtcGxlLmN1c3RvbWxpbnRleGFtcGxlLmRhdGEubW9kZWxzLlVzZXJEdG9cbmltcG9ydCBjb20uZXhhbXBsZS5jdXN0b21saW50ZXhhbXBsZS5kb21haW4udXNlY2FzZXMuR2V0VXNlclVzZUNhc2VcbmltcG9ydCBjb20uZXhhbXBsZS5jdXN0b21saW50ZXhhbXBsZS5wcmVzZW50YXRpb24uc3RhdGVzLk1haW5TdGF0ZVxuaW1wb3J0IGRhZ2dlci5oaWx0LmFuZHJvaWQubGlmZWN5Y2xlLkhpbHRWaWV3TW9kZWwifQ==)
+
+### Description
+
+This ast-grep rule ensures that the **domain** package in a [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) project does not import classes from the **data** or **presentation** packages. It enforces the separation of concerns by preventing the domain layer from depending on other layers, maintaining the integrity of the architecture.
+
+For example, the rule will trigger an error if an import statement like `import com.example.data.SomeClass` or `import com.example.presentation.AnotherClass` is found within the domain package.
+
+The rule uses the [`files`](/reference/yaml.html#files) field to apply only to the domain package.
+
+### YAML
+
+```yaml
+id: import-dependency-violation
+message: Import Dependency Violation
+notes: Ensures that imports comply with architectural rules.
+severity: error
+rule:
+  pattern: import $PATH  # capture the import statement
+constraints:
+  PATH: # find specific package imports
+    any:
+    - regex: com\.example(\.\w+)*\.data
+    - regex: com\.example(\.\w+)*\.presentation
+files:  # apply only to domain package
+- com/example/domain/**/*.kt
+```
+
+### Example
+
+<!-- highlight matched code in curly-brace {lineNum} -->
+```kotlin {3,5}
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.ViewModelScope
+import com.example.customlintexample.data.models.UserDto
+import com.example.customlintexample.domain.usecases.GetUserUseCase
+import com.example.customlintexample.presentation.states.MainState
+import dagger.hilt.android.lifecycle.HiltViewModel
+```
+
+### Contributed by
+Inspired by the post [Custom Lint Task Configuration in Gradle with Kotlin DSL](https://www.sngular.com/insights/320/custom-lint-task-configuration-in-gradle-with-kotlin-dsl)
diff --git a/website/catalog/kotlin/index.md b/website/catalog/kotlin/index.md
new file mode 100644
index 00000000..6a21da3a
--- /dev/null
+++ b/website/catalog/kotlin/index.md
@@ -0,0 +1,5 @@
+# Kotlin
+
+This page curates a list of example ast-grep rules to check and to rewrite Kotlin code.
+
+<!--@include: ./ensure-clean-architecture.md-->