Restructure the project

MiSikora · May 15, 2024 · b4889be · b4889be
1 parent 4053b2e
commit b4889be
Show file tree

Hide file tree

Showing 477 changed files with 5,135 additions and 6,175 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,21 @@
+# https://editorconfig.org
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+# Handled by Detekt, which supports @Suppress annotation
+max_line_length = off
+
+[*.{kt,kts}]
+# Different rules in Detekt
+ktlint_standard_property-naming = disabled
+# I don't like it
+ktlint_standard_multiline-expression-wrapping = disabled
+
+# Don't allow any wildcard imports
+ij_kotlin_packages_to_use_import_on_demand = unset
+
+# Prevent wildcard imports
+ij_kotlin_name_count_to_use_star_import = 99
+ij_kotlin_name_count_to_use_star_import_for_members = 99
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,10 +2,8 @@
 <!-- Why did you change something? Is there an issue to link here? Or an external link? -->
 
 ## :pencil: Checklist
-<!-- Please make sure to go through the checklist and select checkboxes appropriate for your changes. -->
-- [ ] I updated the [changelog](https://github.com/MiSikora/laboratory/blob/trunk/library/docs/changelog.md).
-- [ ] I updated the [documentation](https://github.com/MiSikora/laboratory/tree/trunk/library/docs).
-- [ ] I updated the [sample](https://github.com/MiSikora/laboratory/tree/trunk/sample).
-
-## :crystal_ball: Next steps
-<!-- Is there something to plan or to do after the merge? Does this PR close any issue? If yes, please add a magic keyword - https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/closing-issues-using-keywords. -->
+<!-- Please make sure to go through the checklist and select check-boxes appropriate for your changes. -->
+- [ ] I updated the [changelog](https://github.com/MiSikora/laboratory/blob/trunk/docs/changelog.md).
+- [ ] I updated the [documentation](https://github.com/MiSikora/laboratory/tree/trunk/docs).
+- [ ] I updated the [samples](https://github.com/MiSikora/laboratory/tree/trunk/samples).
+- 
diff --git a/.github/workflows/gradle-wrapper-validation.yml b/.github/workflows/gradle-wrapper-validation.yml
@@ -12,13 +12,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout latest code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation[email protected]
+        uses: gradle/actions/wrapper-validation@v3.3.2
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -12,41 +12,41 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Deploy Release
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
           ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SONATYPE_NEXUS_SIGNING_KEY }}
-        run: ./gradlew -p library publishAllPublicationsToMavenCentral --no-configuration-cache --stacktrace
+        run: ./gradlew publish --no-configuration-cache --stacktrace
 
       - name: Stop Gradle
         run: ./gradlew --stop
 
       - name: Extract Release Notes
         id: release-notes
-        uses: ffurrer2/extract-release-notes@v1.16.0
+        uses: ffurrer2/extract-release-notes@v2.2.0
         with:
-          changelog_file: ./library/docs/changelog.md
+          changelog_file: ./docs/changelog.md
 
       - name: Create GitHub Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2.0.5
         with:
           body: ${{ steps.release-notes.outputs.release_notes }}
           files: |

diff --git a/.github/workflows/publish-snapshot.yml b/.github/workflows/publish-snapshot.yml
@@ -12,41 +12,41 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.11.0
+        uses: styfle/cancel-workflow-action@0.12.1
 
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Deploy Snapshot
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
-        run: ./gradlew -p library publish --no-daemon --no-parallel --stacktrace
+        run: ./gradlew publish --stacktrace
 
       - name: Build HTML Docs
-        run: ./gradlew -p library dokkaHtml --stacktrace
+        run: ./gradlew dokkaHtmlMultiModule --stacktrace
 
       - name: Stop Gradle
         run: ./gradlew --stop
 
       - name: Publish Website
-        uses: mhausenblas/mkdocs-deploy-gh-pages@1.25
+        uses: mhausenblas/mkdocs-deploy-gh-pages@1.26
         env:
           CONFIG_FILE: ./library/mkdocs.yml
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REQUIREMENTS: ./library/docs/requirements.txt
+          REQUIREMENTS: ./docs/requirements.txt
diff --git a/.github/workflows/quality-check.yml b/.github/workflows/quality-check.yml
@@ -20,29 +20,29 @@ jobs:
     runs-on: macos-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Run Tests
-        uses: reactivecircus/android-emulator-runner@v2.27.0
+        uses: reactivecircus/android-emulator-runner@v2.30.1
         with:
           api-level: 29
           emulator-build: 6110076
-          script: ./gradlew -p library connectedCheck --stacktrace
+          script: ./gradlew connectedCheck --stacktrace
         env:
           API_LEVEL: 29
 
@@ -55,83 +55,91 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Run Tests
-        run: ./gradlew -p library test --stacktrace
+        run: ./gradlew test --stacktrace
 
       - name: Stop Gradle
         run: ./gradlew --stop
 
-  build-sample:
+  detekt:
     if: ${{ github.repository == 'MiSikora/laboratory' }}
-    name: Build sample
+    name: Detekt
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
-      - name: Assemble project
-        run: ./gradlew :samples:ci-check:assemble --stacktrace
+      - name: Run Detekt
+        run: ./gradlew detekt --stacktrace
+
+      - name: Run Samples Detekt
+        working-directory: ./samples
+        run: ./gradlew detekt
 
       - name: Stop Gradle
         run: ./gradlew --stop
 
-  detekt:
+  spotless:
     if: ${{ github.repository == 'MiSikora/laboratory' }}
-    name: Detekt
+    name: Spotless
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
-      - name: Run Detekt
-        run: ./gradlew -p library detekt --stacktrace
+      - name: Run Spotless
+        run: ./gradlew spotlessCheck --stacktrace
+
+      - name: Run Samples Spotless
+        working-directory: ./samples
+        run: ./gradlew spotlessCheck
 
       - name: Stop Gradle
         run: ./gradlew --stop
@@ -142,25 +150,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Run Lint
-        run: ./gradlew -p library lint --stacktrace
+        run: ./gradlew lint --stacktrace
 
       - name: Stop Gradle
         run: ./gradlew --stop
@@ -171,25 +179,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.4
 
       - name: Configure JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4.2.1
         with:
           distribution: zulu
-          java-version: 19
+          java-version: 21
 
       - name: Cache Gradle Dirs
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v4.0.2
         with:
           path: |
             ~/.gradle/caches/
             ~/.gradle/wrapper/
-          key: cache-gradle-${{ hashFiles('**/*.gradle', '**/gradle-wrapper.properties') }}
+          key: cache-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle-wrapper.properties') }}
           restore-keys: cache-gradle-
 
       - name: Check ABI
-        run: ./gradlew -p library apiCheck --stacktrace
+        run: ./gradlew apiCheck --stacktrace
 
       - name: Stop Gradle
         run: ./gradlew --stop
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,6 @@
 # IDEA
 *.iml
-/.idea/
-!/.idea/codeStyles/
-!/.idea/codeStyles/*
+.idea/
 
 # Gradle
 .gradle/
@@ -17,4 +15,4 @@ build/
 .DS_Store
 
 # MkDocs
-/library/docs/api
+/docs/api