ProtonMail
/
protoncore_android
mirror of https://github.com/ProtonMail/protoncore_android
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
protoncore_android/README.md

5.9 KiB
Raw Blame History

Usage

Add the desired library as following

implementation("me.proton.core:<name-of-the-lib>:<version>")

where <name-of-the-lib> reflect the one listed below, on lowercase, with - instead of spaces Util Android Shared Preferences: **0.1** can be resolved as me.proton.core:util-android-share-preferences:0.1

Where there are all or some of domain, data, presentation, they can be imported together with the parent module.

implementation("~:network-domain:~")
implementation("~:network-data:~")

or

implementation("~:network:~")

while the first one is suitable for multi-module projects, the latter is the suggested solution for monolithic clients.

Setup Detekt

In order to use the all-in-one Detekt configuration, you have to:

  1. Setup Plugin in your root gradle file Kotlin Gradle DSL:

    plugins {
    id("me.proton.detekt") version protonDetektVersion
}

    Regular Groovy script:

    buildscript {

    dependencies {
        classpath("me.proton:detekt:$protonDetektVersion")
    }
}

apply(plugin = "me.proton.detekt")

  2. Setup the following stage in your .gitlab-ci

    stages:
  - analyze
  # - others ...

#####################
detekt analysis:
  stage: analyze
  tags:
    - android
  script:
    - ./gradlew multiModuleDetekt
  artifacts:
    reports:
      codequality: config/detekt/reports/mergedReport.json

Last versions

Plugins

Detekt: 0.4 - released on: Sep 13, 2021

Jacoco: 0.1 - released on: Nvo 10, 2021

Kotlin: 0.1 - released on: Oct 09, 2020

Tests: 0.1 - released on: Oct 09, 2020

Common

Utils

Util Android Shared Preferences: 1.15 - released on: Sep 13, 2021

Util Android Work Manager: 1.15 - released on: Sep 13, 2021

Util Kotlin: 1.15.4 - released on: Nov 22, 2021

Test

Test Kotlin: 1.15 - released on: Sep 13, 2021

Test Android: 1.15.1 - released on: Oct 08, 2021

Test Android Instrumented: 1.15.5 - released on: Nov 09, 2021

Shared

Domain: 1.18 - released on: Oct 25, 2021

Presentation: 1.18.3 - released on: Nov 05, 2021

Data: 1.15 - released on: Sep 13, 2021

Data Room: 1.16 - released on: Oct 04, 2021

Support

Network

Network: 1.16 - released on: Nov 22, 2021

Network Domain: 1.16 - released on: Nov 22, 2021

Network Data: 1.16 - released on: Nov 22, 2021

Crypto

Crypto: 1.16 - released on: Oct 28, 2021

Crypto Common: 1.16 - released on: Oct 28, 2021

Crypto Android: 1.16 - released on: Oct 28, 2021

Features

Auth

Auth: 1.18.5 - released on: Nov 22, 2021

Auth Domain: 1.18.5 - released on: Nov 22, 2021

Auth Presentation: 1.18.5 - released on: Nov 22, 2021

Auth Data: 1.18.5 - released on: Nov 22, 2021

Account

Account: 1.15.2 - released on: Sep 23, 2021

Account Domain: 1.15.2 - released on: Sep 23, 2021

Account Presentation: 0 - released on: ND

Account Data: 1.15.2 - released on: Sep 23, 2021

Account Manager

Account Manager: 1.16.2 - released on: Nov 16, 2021

Account Manager Domain: 1.16.2 - released on: Nov 16, 2021

Account Manager Presentation: 1.16.2 - released on: Nov 16, 2021

Account Manager Data: 1.16.2 - released on: Nov 16, 2021

Account Manager Data Db: 1.16.2 - released on: Nov 16, 2021

Account Manager Dagger: 1.16.2 - released on: Nov 16, 2021

Event Manager

Event Manager: 1.19.2 - released on: Nov 22, 2021

Event Manager Domain: 1.19.2 - released on: Nov 22, 2021

Event Manager Data: 1.19.2 - released on: Nov 22, 2021

Key

Key: 1.16.1 - released on: Nov 08, 2021

Key Domain: 1.16.1 - released on: Nov 08, 2021

Key Data: 1.16.1 - released on: Nov 08, 2021

User

User: 1.19.1 - released on: Nov 18, 2021

User Domain: 1.19.1 - released on: Nov 18, 2021

User Data: 1.19.1 - released on: Nov 18, 2021

User Settings

User Settings: 1.19.1 - released on: Nov 18, 2021

User Settings Data: 1.19.1 - released on: Nov 18, 2021

User Settings Domain: 1.19.1 - released on: Nov 18, 2021

User Settings Presentation: 1.19.1 - released on: Nov 18, 2021

Contact

Contact: 1.19.3 - released on: Nov 22, 2021

Contact Domain: 1.19.3 - released on: Nov 22, 2021

Contact Data: 1.19.3 - released on: Nov 22, 2021

Contact Hilt: 1.19.3 - released on: Nov 22, 2021

Mail Message

Mail Message: 1.15.1 - released on: Nov 10, 2021

Mail Message Domain: 1.15.1 - released on: Nov 10, 2021

Mail Message Data: 1.15.1 - released on: Nov 10, 2021

Mail Settings

Mail Settings: 1.19.1 - released on: Nov 18, 2021

Mail Settings Domain: 1.19.1 - released on: Nov 18, 2021

Mail Settings Data: 1.19.1 - released on: Nov 18, 2021

Human Verification

Human Verification: 1.16.4 - released on: Nov 24, 2021

Human Verification Domain: 1.16.4 - released on: Nov 24, 2021

Human Verification Presentation: 1.16.4 - released on: Nov 24, 2021

Human Verification Data: 1.16.4 - released on: Nov 24, 2021

Countries

Country: 1.16.2 - released on: Nov 16, 2021

Country Domain: 1.16.2 - released on: Nov 16, 2021

Country Data: 1.16.2 - released on: Nov 16, 2021

Country Presentation: 1.16.2 - released on: Nov 16, 2021

Payment

Payment: 1.17.5 - released on: Nov 22, 2021

Payment Data: 1.17.5 - released on: Nov 22, 2021

Payment Domain: 1.17.5 - released on: Nov 22, 2021

Payment Presentation: 1.17.5 - released on: Nov 22, 2021

Plan

Plan: 1.18.3 - released on: Nov 23, 2021

Plan Data: 1.18.3 - released on: Nov 23, 2021

Plan Domain: 1.18.3 - released on: Nov 23, 2021

Plan Presentation: 1.18.3 - released on: Nov 23, 2021