From 71250a28fa6be5cf1ac19e593cd5561703732193 Mon Sep 17 00:00:00 2001 From: David Perez Date: Thu, 27 Mar 2025 14:51:24 -0500 Subject: [PATCH] Update the README dependencies section and clean up toml file (#4926) --- README.md | 58 ++++++++++++++++++++------------------- app/build.gradle.kts | 1 - gradle/libs.versions.toml | 11 -------- 3 files changed, 30 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index aa3314a7be..6e7973d752 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,11 @@ The following is a list of all third-party dependencies included as part of the application beyond the standard Android SDK. +- **AndroidX Activity** + - https://developer.android.com/jetpack/androidx/releases/activity + - Purpose: Allows access composable APIs built on top of Activity. + - License: Apache 2.0 + - **AndroidX Appcompat** - https://developer.android.com/jetpack/androidx/releases/appcompat - Purpose: Allows access to new APIs on older API versions. @@ -78,7 +83,7 @@ The following is a list of all third-party dependencies included as part of the - Purpose: Displays webpages with the user's default browser. - License: Apache 2.0 -- **AndroidX CameraX Camera2** +- **AndroidX Camera** - https://developer.android.com/jetpack/androidx/releases/camera - Purpose: Display and capture images for barcode scanning. - License: Apache 2.0 @@ -88,9 +93,9 @@ The following is a list of all third-party dependencies included as part of the - Purpose: A Kotlin-based declarative UI framework. - License: Apache 2.0 -- **AndroidX Core SplashScreen** +- **AndroidX Core** - https://developer.android.com/jetpack/androidx/releases/core - - Purpose: Backwards compatible SplashScreen API implementation. + - Purpose: Backwards compatible platform features and APIs. - License: Apache 2.0 - **AndroidX Credentials** @@ -103,6 +108,11 @@ The following is a list of all third-party dependencies included as part of the - Purpose: Lifecycle aware components and tooling. - License: Apache 2.0 +- **AndroidX Navigation** + - https://developer.android.com/jetpack/androidx/releases/navigation + - Purpose: Provides a consistent API for navigating between Android components. + - License: Apache 2.0 + - **AndroidX Room** - https://developer.android.com/jetpack/androidx/releases/room - Purpose: A convenient SQLite-based persistence layer for Android. @@ -123,21 +133,6 @@ The following is a list of all third-party dependencies included as part of the - Purpose: Dependency injection framework. - License: Apache 2.0 -- **Firebase Cloud Messaging** - - https://github.com/firebase/firebase-android-sdk - - Purpose: Allows for push notification support. (**NOTE:** This dependency is not included in builds distributed via F-Droid.) - - License: Apache 2.0 - -- **Firebase Crashlytics** - - https://github.com/firebase/firebase-android-sdk - - Purpose: SDK for crash and non-fatal error reporting. (**NOTE:** This dependency is not included in builds distributed via F-Droid.) - - License: Apache 2.0 - -- **Google Play Reviews** - - https://developer.android.com/reference/com/google/android/play/core/release-notes - - Purpose: On standard builds provide an interface to add a review for the password manager application in Google Play. - - License: Apache 2.0 - - **Glide** - https://github.com/bumptech/glide - Purpose: Image loading and caching. @@ -158,11 +153,6 @@ The following is a list of all third-party dependencies included as part of the - Purpose: JSON serialization library for Kotlin. - License: Apache 2.0 -- **kotlinx.serialization converter** - - https://github.com/square/retrofit/tree/trunk/retrofit-converters/kotlinx-serialization - - Purpose: Converter for Retrofit 2 and kotlinx.serialization. - - License: Apache 2.0 - - **OkHttp 3** - https://github.com/square/okhttp - Purpose: An HTTP client used by the library to intercept and log traffic. @@ -178,16 +168,28 @@ The following is a list of all third-party dependencies included as part of the - Purpose: Extensible logging library for Android. - License: Apache 2.0 -- **zxcvbn4j** - - https://github.com/nulab/zxcvbn4j - - Purpose: Password strength estimation. - - License: MIT - - **ZXing** - https://github.com/zxing/zxing - Purpose: Barcode scanning and generation. - License: Apache 2.0 +The following is an additional list of third-party dependencies that are only included in the non-F-Droid build variants of the application. + +- **Firebase Cloud Messaging** + - https://github.com/firebase/firebase-android-sdk + - Purpose: Allows for push notification support. + - License: Apache 2.0 + +- **Firebase Crashlytics** + - https://github.com/firebase/firebase-android-sdk + - Purpose: SDK for crash and non-fatal error reporting. + - License: Apache 2.0 + +- **Google Play Reviews** + - https://developer.android.com/reference/com/google/android/play/core/release-notes + - Purpose: On standard builds provide an interface to add a review for the password manager application in Google Play. + - License: Apache 2.0 + ### Development Environment Dependencies The following is a list of additional third-party dependencies used as part of the local development environment. This includes test-related artifacts as well as tools related to code quality and linting. These are not present in the final packaged application. diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 0d72470eeb..19c99fe46c 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -251,7 +251,6 @@ dependencies { implementation(libs.kotlinx.collections.immutable) implementation(libs.kotlinx.coroutines.android) implementation(libs.kotlinx.serialization) - implementation(libs.nulab.zxcvbn4j) implementation(libs.square.okhttp) implementation(libs.square.okhttp.logging) implementation(platform(libs.square.retrofit.bom)) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c3ab8b2ea0..49055173e3 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -24,8 +24,6 @@ androidxNavigation = "2.8.0" androidxRoom = "2.6.1" androidXSecurityCrypto = "1.1.0-alpha06" androidxSplash = "1.1.0-rc01" -androidxTest = "1.6.2" -androidxTestRules = "1.6.1" androidXAppCompat = "1.7.0" androdixAutofill = "1.1.0" androidxWork = "2.10.0" @@ -33,8 +31,6 @@ bitwardenSdk = "1.0.0-20250225.125021-120" crashlytics = "3.0.3" detekt = "1.23.8" firebaseBom = "33.11.0" -espresso = "3.6.1" -fastlaneScreengrab = "2.1.1" glide = "1.0.0-beta01" googleGuava = "33.4.0-jre" googleProtoBufJava = "4.30.1" @@ -59,7 +55,6 @@ sonarqube = "6.0.1.5171" testng = "7.11.0" timber = "5.0.1" turbine = "1.2.0" -zxcvbn4j = "1.9.0" zxing = "3.5.3" [libraries] @@ -96,15 +91,11 @@ androidx-room-ktx = { module = "androidx.room:room-ktx", version.ref = "androidx androidx-room-runtime = { module = "androidx.room:room-runtime", version.ref = "androidxRoom" } androidx-security-crypto = { module = "androidx.security:security-crypto", version.ref = "androidXSecurityCrypto" } androidx-splashscreen = { module = "androidx.core:core-splashscreen", version.ref = "androidxSplash" } -androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidxTest" } -androidx-test-rules = { module = "androidx.test:rules", version.ref = "androidxTestRules" } -androidx-test-espresso = { module = "androidx.test.espresso:espresso-core", version.ref = "espresso" } androidx-work-runtime-ktx = { module = "androidx.work:work-runtime-ktx", version.ref = "androidxWork" } bitwarden-sdk = { module = "com.bitwarden:sdk-android-temp", version.ref = "bitwardenSdk" } bumptech-glide = { module = "com.github.bumptech.glide:compose", version.ref = "glide" } detekt-detekt-formatting = { module = "io.gitlab.arturbosch.detekt:detekt-formatting", version.ref = "detekt" } detekt-detekt-rules = { module = "io.gitlab.arturbosch.detekt:detekt-rules-libraries", version.ref = "detekt" } -fastlane-screengrab = { module = "tools.fastlane:screengrab", version.ref = "fastlaneScreengrab" } google-firebase-bom = { module = "com.google.firebase:firebase-bom", version.ref = "firebaseBom" } google-firebase-cloud-messaging = { module = "com.google.firebase:firebase-messaging-ktx" } google-firebase-crashlytics = { module = "com.google.firebase:firebase-crashlytics-ktx" } @@ -125,9 +116,7 @@ kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutine kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutines" } kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinxCoroutines" } kotlinx-serialization = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinxSerialization" } -mockk-android = { module = "io.mockk:mockk-android", version.ref = "mockk" } mockk-mockk = { module = "io.mockk:mockk", version.ref = "mockk" } -nulab-zxcvbn4j = { module = "com.nulab-inc:zxcvbn", version.ref = "zxcvbn4j" } robolectric-robolectric = { module = "org.robolectric:robolectric", version.ref = "robolectric" } square-okhttp = { module = "com.squareup.okhttp3:okhttp", version.ref = "okhttp" } square-okhttp-logging = { module = "com.squareup.okhttp3:logging-interceptor", version.ref = "okhttp" }