chore: merge branch dev to main (#236)

ReVanced · Aug 26, 2023 · 2a3dbaf · 2a3dbaf
2 parents fa85482 + 9e39a6f
commit 2a3dbaf
Show file tree

Hide file tree

Showing 40 changed files with 1,147 additions and 766 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -33,9 +33,10 @@ jobs:
             build
             node_modules
           key: ${{ runner.os }}-gradle-npm-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties', 'package-lock.json') }}
-      - name: Build with Gradle
+      - name: Build
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # Cleaning is necessary to avoid uploading two identical artifacts with different versions
         run: ./gradlew clean --no-daemon
       - name: Setup semantic-release
         run: npm install

diff --git a/.releaserc b/.releaserc
@@ -10,7 +10,7 @@
     [
       "@semantic-release/commit-analyzer", {
         "releaseRules": [
-          { "type": "build", "scope": "revanced-patcher", "release": "patch" }
+          { "type": "build", "scope": "Needs bump", "release": "patch" }
         ]
       }
     ],

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,118 @@
+# [3.0.0-dev.10](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.9...v3.0.0-dev.10) (2023-08-25)
+
+
+### Bug Fixes
+
+* filtration of patches malfunctioning ([2d5a7fd](https://github.com/ReVanced/revanced-cli/commit/2d5a7fdf1eb2e13f5013a790b03f09851b167fe0))
+
+# [3.0.0-dev.9](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.8...v3.0.0-dev.9) (2023-08-25)
+
+
+### Features
+
+* Check for missing integrations ([c93186f](https://github.com/ReVanced/revanced-cli/commit/c93186fb9700907e65f33442e88073783cc163de))
+
+# [3.0.0-dev.8](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.7...v3.0.0-dev.8) (2023-08-24)
+
+
+### Bug Fixes
+
+* do not delete output file ([0f3e090](https://github.com/ReVanced/revanced-cli/commit/0f3e090418771e951dfd15e5c193421f72cbe459))
+
+# [3.0.0-dev.7](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.6...v3.0.0-dev.7) (2023-08-24)
+
+
+### Bug Fixes
+
+* print stack trace when a patch failed ([924c1f8](https://github.com/ReVanced/revanced-cli/commit/924c1f80ec0d17a3bdc07a0fb2015e44c49162e4))
+
+# [3.0.0-dev.6](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.5...v3.0.0-dev.6) (2023-08-24)
+
+# [3.0.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.4...v3.0.0-dev.5) (2023-08-24)
+
+
+### Bug Fixes
+
+* also delete temporary files when uninstalling ([52c3be2](https://github.com/ReVanced/revanced-cli/commit/52c3be23f2915dccaee7f9941413c8f81e14acc8))
+* delete temporary files after root installation ([a3d8705](https://github.com/ReVanced/revanced-cli/commit/a3d8705e89732a0dd4f51de28c405b6af13c8633))
+* fix running commands not running ([2c7fcaf](https://github.com/ReVanced/revanced-cli/commit/2c7fcaf4add65a12052afc5bef779dbc73debd69))
+* only check once for patch options ([11c3a6c](https://github.com/ReVanced/revanced-cli/commit/11c3a6cfd4fe59ba5d703358634a1853e1cc22a5))
+
+
+### Features
+
+* add install command ([0350b7f](https://github.com/ReVanced/revanced-cli/commit/0350b7f1a276d9dc795b22442ba4f202855ea090))
+* use friendly descriptions ([3dd875d](https://github.com/ReVanced/revanced-cli/commit/3dd875d14cca488ade6d21bbd4cce0d481692134))
+
+# [3.0.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.3...v3.0.0-dev.4) (2023-08-24)
+
+
+### Features
+
+* properly make use of logging facade ([41898d7](https://github.com/ReVanced/revanced-cli/commit/41898d7547690e3130372414515c5645e5dc2634))
+
+# [3.0.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.2...v3.0.0-dev.3) (2023-08-23)
+
+# [3.0.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v3.0.0-dev.1...v3.0.0-dev.2) (2023-08-23)
+
+
+### Bug Fixes
+
+* specify correct class containing entry-point ([1fcc591](https://github.com/ReVanced/revanced-cli/commit/1fcc591222ab67112f2b78174a8b94106846838c))
+
+# [3.0.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.5...v3.0.0-dev.1) (2023-08-23)
+
+
+### Bug Fixes
+
+* do not use absolute path from custom AAPT2 binary option ([a9c2a5f](https://github.com/ReVanced/revanced-cli/commit/a9c2a5f096627dbbf8ab1b8da26fb14529ce6bc3))
+* use correct option name ([f8972ea](https://github.com/ReVanced/revanced-cli/commit/f8972eac3e5ee0a4a186c12cbe711925656d657b))
+
+
+* refactor!: restructure code ([07da528](https://github.com/ReVanced/revanced-cli/commit/07da528ce2223582f84bf64d2fec69714c647ddc))
+
+
+### Features
+
+* add options command ([9edbbf3](https://github.com/ReVanced/revanced-cli/commit/9edbbf31635603f89fc7bc5dcc6c023d4cdbb5a6))
+* use better logging text ([b0e748d](https://github.com/ReVanced/revanced-cli/commit/b0e748daff527ee7f417b3069882e074896fc131))
+* use separate command to list patches ([b74213f](https://github.com/ReVanced/revanced-cli/commit/b74213f66e0d04d3a0ae6197d069631388e06580))
+* use separate command to patch ([32da961](https://github.com/ReVanced/revanced-cli/commit/32da961d57537e99b39fd92b625a1c73f8314bc6))
+* use separate command to uninstall ([c0cc909](https://github.com/ReVanced/revanced-cli/commit/c0cc90962646cfffd5e2730ae556423271a7990b))
+* use simpler log ([ba758f0](https://github.com/ReVanced/revanced-cli/commit/ba758f00f4ce18791439b7e72fe1ad2e7f11f8af))
+
+
+### BREAKING CHANGES
+
+* This introduces major changes to how ReVanced CLI is used from the command line.
+
+# [2.23.0-dev.5](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.4...v2.23.0-dev.5) (2023-08-14)
+
+# [2.23.0-dev.4](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.3...v2.23.0-dev.4) (2023-08-13)
+
+
+### Features
+
+* show full package name when listing patches ([#240](https://github.com/ReVanced/revanced-cli/issues/240)) ([7174364](https://github.com/ReVanced/revanced-cli/commit/7174364ef8ef5d6ce8351a8340f9c1a5b58eac3c))
+
+# [2.23.0-dev.3](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.2...v2.23.0-dev.3) (2023-08-03)
+
+# [2.23.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v2.23.0-dev.1...v2.23.0-dev.2) (2023-08-03)
+
+# [2.23.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.22.1-dev.1...v2.23.0-dev.1) (2023-07-30)
+
+
+### Features
+
+* Improve command line argument descriptions ([f9cf7d2](https://github.com/ReVanced/revanced-cli/commit/f9cf7d21b7f1c2f11234d604a1047b9d2b165f83))
+
+## [2.22.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v2.22.0...v2.22.1-dev.1) (2023-07-24)
+
+
+### Bug Fixes
+
+* print original instead of kebab cased names ([5eaad33](https://github.com/ReVanced/revanced-cli/commit/5eaad33dc1fbd24c36e1498f04e21d068e85f53e))
+
 # [2.22.0](https://github.com/revanced/revanced-cli/compare/v2.21.5...v2.22.0) (2023-07-11)
 
 

diff --git a/README.md b/README.md
@@ -1,3 +1,3 @@
 # 💻 ReVanced CLI
 
-Command line application as an alternative to the ReVanced Manager.
+Command line application to use ReVanced.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,42 +1,23 @@
 plugins {
     kotlin("jvm") version "1.8.20"
-    id("com.github.johnrengelman.shadow") version "7.1.2"
+    alias(libs.plugins.shadow)
 }
 
 group = "app.revanced"
 
-val githubUsername: String = project.findProperty("gpr.user") as? String ?: System.getenv("GITHUB_ACTOR")
-val githubPassword: String = project.findProperty("gpr.key") as? String ?: System.getenv("GITHUB_TOKEN")
-
-repositories {
-    mavenCentral()
-    mavenLocal()
-    maven {
-        url = uri("https://maven.pkg.github.com/revanced/revanced-patcher")
-        credentials {
-            username = githubUsername
-            password = githubPassword
-        }
-    }
-    maven { url = uri("https://jitpack.io") }
-    google()
-}
-
 dependencies {
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20-RC")
-
-    implementation("app.revanced:revanced-patcher:11.0.3")
-    implementation("info.picocli:picocli:4.7.1")
-    implementation("com.github.revanced:jadb:2531a28109") // updated fork
-    implementation("com.android.tools.build:apksig:8.1.0-alpha09")
-    implementation("org.bouncycastle:bcpkix-jdk15on:1.70")
-    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.14.+")
-    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
+    implementation(libs.revanced.patcher)
+    implementation(libs.kotlin.reflect)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.picocli)
+    implementation(libs.jadb) // Updated fork
+    implementation(libs.apksig)
+    implementation(libs.bcpkix.jdk15on)
+    implementation(libs.jackson.module.kotlin)
+    testImplementation(libs.kotlin.test)
 }
 
-kotlin {
-    jvmToolchain(11)
-}
+kotlin { jvmToolchain(11) }
 
 tasks {
     test {
@@ -45,19 +26,26 @@ tasks {
             events("PASSED", "SKIPPED", "FAILED")
         }
     }
-    build {
-        dependsOn(shadowJar)
+
+    processResources {
+        expand("projectVersion" to project.version)
     }
+
     shadowJar {
         manifest {
-            attributes("Main-Class" to "app.revanced.cli.main.MainKt")
+            attributes("Main-Class" to "app.revanced.cli.command.MainCommandKt")
         }
         minimize {
             exclude(dependency("org.jetbrains.kotlin:.*"))
             exclude(dependency("org.bouncycastle:.*"))
             exclude(dependency("app.revanced:.*"))
         }
     }
+
+    build {
+        dependsOn(shadowJar)
+    }
+
     // Dummy task to fix the Gradle semantic-release plugin.
     // Remove this if you forked it to support building only.
     // Tracking issue: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435

diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md
@@ -1,15 +1,17 @@
 # 💼 Prerequisites
 
-To use ReVanced CLI, you will need to fulfill certain requirements.
+To use ReVanced CLI, you will need to fulfil specific requirements.
 
 ## 🤝 Requirements
 
-- Java SDK 11 (Azul JDK or OpenJDK)
-- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to deploy the patched APK file on your device
+- Java SDK 11 (Azul Zulu JDK or OpenJDK)
+- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device
 - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7)
+- ReVanced Patches
+- ReVanced Integrations, if the patches require it
 
 ## ⏭️ Whats next
 
-The next section will show, how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
+The following section will show you how to use ReVanced CLI.
 
 Continue: [🛠️ Using ReVanced CLI](1_usage.md)
diff --git a/docs/1_usage.md b/docs/1_usage.md
@@ -10,13 +10,14 @@ Learn how to ReVanced CLI.
    adb shell exit
    ```
 
-   If you want to deploy the patched APK file on your device by mounting it on top of the original APK file, you will need root access. This is optional.
+   Optionally, you can install the patched APK file on your device by mounting it on top of the original APK file. 
+   You will need root permissions for this. Check if you have root permissions by running the following command:
 
    ```bash
    adb shell su -c exit
    ```
 
-2. Get the name of your device
+2. Get your device's serial
 
    ```bash
    adb devices
@@ -30,47 +31,81 @@ Learn how to ReVanced CLI.
   java -jar revanced-cli.jar -h
   ```
 
-- ### 📃 List all available patches from supplied patch bundles
+- ### 📃 List patches from supplied patch bundles
 
   ```bash
-  java -jar revanced-cli.jar
-   -b revanced-patches.jar \
-   -l # Names of all patches will be in kebab-case
+  java -jar revanced-cli.jar list-patches \
+   --with-packages \
+   --with-versions \
+   --with-options \
+   revanced-patches.jar [<patch-bundle> ...]
   ```
 
-- ### 💉 Use ReVanced CLI to patch an APK file but deploy without root permissions
+- ### ⚙️ Generate options from patches using ReVanced CLI
 
-  This will deploy the patched APK file on your device by installing it.
+  This will generate an `options.json` file for the patches from a list of supplied patch bundles.
+  The file can be supplied to ReVanced CLI later on.
+
+- ```bash
+  java -jar revanced-cli.jar options \
+   --path options.json \
+   --overwrite \
+   revanced-patches.jar [<patch-bundle> ...]
+  ```
+
+  > **Note**: A default `options.json` file will be automatically generated, if it does not exist 
+  without any need for intervention when using the `patch` command.
+
+- ### 💉 Use ReVanced CLI to patch an APK file but install without root permissions
+
+  This will install the patched APK file regularly on your device.
 
   ```bash
-  java -jar revanced-cli.jar \
-   -a input.apk \
-   -o patched-output.apk \
-   -b revanced-patches.jar \
-   -d device-name
+  java -jar revanced-cli.jar patch \
+   --patch-bundle revanced-patches.jar \
+   --out output.apk \
+   --device-serial <device-serial> \
+   input.apk
   ```
 
-- ### 👾 Use ReVanced CLI to patch an APK file but deploy with root permissions
+- ### 👾 Use ReVanced CLI to patch an APK file but install with root permissions
 
-  This will deploy the patched APK file on your device by mounting it on top of the original APK file.
+  This will install the patched APK file on your device by mounting it on top of the original APK file.
 
   ```bash
   adb install input.apk
-  java -jar revanced-cli.jar \
-   -a input.apk \
-   -o patched-output.apk \
-   -b revanced-patches.jar \
-   -e vanced-microg-support \
-   -d device-name \
-   --mount
+  java -jar revanced-cli.jar patch \
+   --patch-bundle revanced-patches.jar \
+   --include some-other-patch \
+   --exclude some-patch \
+   --out patched-output.apk \
+   --device-serial <device-serial> \
+   --mount \
+   input.apk
   ```
 
-  > **Note**: Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also require [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`. ReVanced Patcher will merge ReVanced Integrations automatically, depending on if the supplied patches require them.
+  > **Note**: Some patches may require integrations
+  such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations). 
+  Supply them with the option `--merge`. If any patches accepted by ReVanced Patcher require ReVanced Integrations, 
+  they will be merged into the APK file automatically.
 
-- ### ⚙️ Supply options to patches using ReVanced CLI
+- ### 🗑️ Uninstall a patched APK file
+  ```bash
+  java -jar revanced-cli.jar utility uninstall \
+   --package-name <package-name> \
+   <device-serial>
+  ```
+
+  > **Note**: You can unmount an APK file
+  with the option `--unmount`.
+
+- ### ️ ⚙️ Manually install an APK file
 
-  Some patches provide options. Currently, ReVanced CLI will generate and consume an `options.json` file at the location that is specified in `-o`. If the option is not specified, the options file will be generated in the current working directory.
-
-  The options file contains all options from supplied patch bundles.
+  ```bash
+  java -jar revanced-cli.jar utility install \
+   -a input.apk \
+   <device-serial>
+  ```
 
-  > **Note**: The `options.json` file will be generated at the first time you use ReVanced CLI to patch an APK file for now. This will be changed in the future.
+  > **Note**: You can mount an APK file 
+  by supplying the package name of the app to mount the supplied APK file to over the option `--mount`.
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 2.22.0
+version = 3.0.0-dev.10