build(Needs bump): Bump dependencies

As of 14. Nov 2023 GitHub has decided to disable nested highlighted blockquotes: https://github.com/orgs/community/discussions/16925.

.editorconfig

@@ -0,0 +1,3 @@
+[*.{kt,kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_no-wildcard-imports = disabled

.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: gradle
+    labels: []
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: monthly

.github/workflows/release.yml

@@ -24,23 +24,21 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
 
-      - name: Cache Node modules
-        uses: actions/cache@v3
-        with:
-          path: |
-            node_modules
-          key: npm-${{ hashFiles('package-lock.json') }}
-
       - name: Cache Gradle
         uses: burrunan/gradle-cache-action@v1
 
       - 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
+        run: ./gradlew build clean
 
-      - name: Setup semantic-release
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: 'npm'
+
+      - name: Install dependencies
         run: npm install
 
       - name: Release

.gitignore

@@ -119,4 +119,7 @@ node_modules/
 
 # ReVanced CLI
 revanced-cache/
-options.toml
+options.toml
+
+# Generated by an Android project (such as ReVanced Integrations)
+local.properties

CHANGELOG.md

@@ -1,3 +1,43 @@
+# [4.4.0](https://github.com/ReVanced/revanced-cli/compare/v4.3.0...v4.4.0) (2023-12-28)
+
+
+### Bug Fixes
+
+* Add missing punctuation in command description ([8210351](https://github.com/ReVanced/revanced-cli/commit/821035107d7264580275f395e9e3fcef91394afd))
+
+
+### Features
+
+* Log saved patched APK file path ([16109bd](https://github.com/ReVanced/revanced-cli/commit/16109bd8bc6236debf71cbc8db78fe452b2ed00d))
+
+# [4.4.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.0-dev.1...v4.4.0-dev.2) (2023-12-18)
+
+
+### Bug Fixes
+
+* Add missing punctuation in command description ([8210351](https://github.com/ReVanced/revanced-cli/commit/821035107d7264580275f395e9e3fcef91394afd))
+
+# [4.4.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.3.0...v4.4.0-dev.1) (2023-12-01)
+
+
+### Features
+
+* Log saved patched APK file path ([16109bd](https://github.com/ReVanced/revanced-cli/commit/16109bd8bc6236debf71cbc8db78fe452b2ed00d))
+
+# [4.3.0](https://github.com/ReVanced/revanced-cli/compare/v4.2.0...v4.3.0) (2023-12-01)
+
+
+### Features
+
+* Add `list-versions` command ([a974b8e](https://github.com/ReVanced/revanced-cli/commit/a974b8ea80acd85f8dc472a3f93b8fd7bea08007))
+
+# [4.3.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.2.0...v4.3.0-dev.1) (2023-11-27)
+
+
+### Features
+
+* Add `list-versions` command ([a974b8e](https://github.com/ReVanced/revanced-cli/commit/a974b8ea80acd85f8dc472a3f93b8fd7bea08007))
+
 # [4.2.0](https://github.com/ReVanced/revanced-cli/compare/v4.1.0...v4.2.0) (2023-11-26)
 
 

docs/0_prerequisites.md

@@ -4,8 +4,8 @@ To use ReVanced CLI, you will need to fulfill specific requirements.
 
 ## 🤝 Requirements
 
-- 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
+- Java Runtime Environment 11 ([Azul Zulu JRE](https://www.azul.com/downloads/?version=java-11-lts&package=jdk#zulu) or [OpenJDK](https://jdk.java.net/archive/))
+- [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)
 
 ## ⏭️ Whats next

docs/1_usage.md

@@ -1,6 +1,6 @@
 # 🛠️ Using ReVanced CLI
 
-Learn how to ReVanced CLI.
+Learn how to use ReVanced CLI.
 
 ## 🔨 Usage
 
@@ -34,28 +34,22 @@ ReVanced CLI is divided into the following fundamental commands:
    revanced-patches.jar [<patch-bundle> ...]
   ```
 
-  > [!NOTE]  
-  > A default `options.json` file will be automatically created, if it does not exist 
+  > **ℹ️ Note**  
+  > A default `options.json` file will be automatically created if it does not exist 
   without any need for intervention when using the `patch` command.
 
 - ### 💉 Patch an app
 
   You can patch apps by supplying patch bundles and the app to patch.
   After patching, ReVanced CLI can install the patched app on your device using two methods:
-
-  > [!NOTE]  
+  
+  > **💡 Tip**  
   > For ReVanced CLI to be able to install the patched app on your device, make sure ADB is working:
   >
   > ```bash
   > adb shell exit
   > ```
   >
-  > To get your device's serial, run the following command:
-  >
-  > ```bash
-  > adb devices
-  > ```
-  >
   > If you want to mount the patched app on top of the un-patched app, make sure you have root permissions:
   >
   > ```bash
@@ -63,7 +57,7 @@ ReVanced CLI is divided into the following fundamental commands:
   > ```
   >
 
-  > [!WARNING]  
+  > **⚠️ Warning**  
   > Some patches may require integrations
   > such as [ReVanced Integrations](https://github.com/revanced/revanced-integrations).
   > Supply them with the option `--merge`. ReVanced Patcher will automatically determine if they are necessary.
@@ -73,43 +67,43 @@ ReVanced CLI is divided into the following fundamental commands:
     ```bash
     java -jar revanced-cli.jar patch \
      --patch-bundle revanced-patches.jar \
-     --device-serial <device-serial> \
+     -d \
      input.apk
     ```
 
   - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions
   
-    > [!IMPORTANT]  
-    > Ensure sure the same app you are patching and mounting over is installed on your device:
+    > **❗ Caution**  
+    > Ensure that the same app you are patching and mounting over is installed on your device:
     > 
     > ```bash
     > adb install app.apk
     > ```
 
-    > [!NOTE]  
-    > You can use the option `--ii` to include or `--ie` to exclude
-    > patches by their index in relation to supplied patch bundles,
-    > similarly to the option `--include` and `--exclude`.
-    > 
-    > This is useful in case two patches have the same name, and you need to include or exclude one of them.  
-    > The index of a patch is calculated by the position of the patch in the list of patches
-    > from patch bundles supplied using the option `--patch-bundle`.
-    > 
-    > You can list all patches with their indices using the command `list-patches`.
-    > 
-    > Keep in mind, that the indices can change based on the order of the patch bundles supplied,
-    > as well if the patch bundles are updated, because patches can be added or removed.
-
     ```bash
     java -jar revanced-cli.jar patch \
      --patch-bundle revanced-patches.jar \
      --include "Some patch" \
      --ii 123 \
      --exclude "Some other patch" \
-     --device-serial <device-serial> \
+     -d \
      --mount \
      app.apk
     ```
+    
+    > **💡 Tip**  
+    > You can use the option `--ii` to include or `--ie` to exclude
+    > patches by their index in relation to supplied patch bundles,
+    > similarly to the option `--include` and `--exclude`.
+    > 
+    > This is useful in case two patches have the same name, and you must include or exclude one.  
+    > The patch index is calculated by the position of the patch in the list of patches
+    > from patch bundles supplied using the option `--patch-bundle`.
+    > 
+    > You can list all patches with their indices using the command `list-patches`.
+    > 
+    > Keep in mind that the indices can change based on the order of the patch bundles supplied,
+    > as well if the patch bundles are updated because patches can be added or removed.
 
 - ### 🗑️ Uninstall an app
 
@@ -119,7 +113,7 @@ ReVanced CLI is divided into the following fundamental commands:
    [<device-serial>]
   ```
 
-  > [!NOTE]  
+  > **💡 Tip**  
   > You can unmount an APK file
   by adding the option `--unmount`.
 
@@ -131,6 +125,6 @@ ReVanced CLI is divided into the following fundamental commands:
    [<device-serial>]
   ```
 
-  > [!NOTE]  
+  > **💡 Tip**  
   > 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`.
+  > by supplying the app's package name to mount the supplied APK file over the option `-mount`.

docs/2_building.md

@@ -0,0 +1,26 @@
+# 🔨️ Building
+
+Build ReVanced CLI from source.
+
+## 📝 Requirements
+
+- Java Development Kit 11 (Azul Zulu JRE or OpenJDK)
+
+## 🏗️ Building
+
+To build ReVanced CLI, follow these steps:
+
+1. Clone the repository:
+
+   ```bash
+   git clone git@github.com:ReVanced/revanced-cli.git
+   cd revanced-cli
+   ```
+
+2. Build the project:
+
+   ```bash
+    ./gradlew build
+    ```
+
+After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli-<version>-all.jar`.

docs/README.md

@@ -1,8 +1,9 @@
 # 💻 Documentation and guides of ReVanced CLI
 
-This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli).
+This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli).
 
 ## 📖 Table of contents
 
 1. [💼 Prerequisites](0_prerequisites.md)
 2. [🛠️ Using ReVanced CLI](1_usage.md)
+3. [🔨 Building ReVanced CLI](2_building.md)

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 4.2.0
+version = 4.4.0

gradle/libs.versions.toml

@@ -1,13 +1,13 @@
 [versions]
 shadow = "8.1.1"
-kotlin-test = "1.9.20"
+kotlin = "1.9.22"
 kotlinx-coroutines-core = "1.7.3"
 picocli = "4.7.3"
-revanced-patcher = "19.0.0"
-revanced-library = "1.3.0"
+revanced-patcher = "19.3.0"
+revanced-library = "2.0.0"
 
 [libraries]
-kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin-test" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" }
 picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
 revanced-patcher = { module = "app.revanced:revanced-patcher", version.ref = "revanced-patcher" }

package.json

@@ -1,9 +1,9 @@
 {
   "devDependencies": {
-    "@saithodev/semantic-release-backmerge": "^3.2.1",
+    "@saithodev/semantic-release-backmerge": "^4.0.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.8.0",
-    "semantic-release": "^22.0.8"
+    "gradle-semantic-release-plugin": "^1.9.1",
+    "semantic-release": "^23.0.0"
   }
 }

settings.gradle.kts

@@ -2,6 +2,6 @@ rootProject.name = "revanced-cli"
 
 buildCache {
     local {
-        isEnabled = !System.getenv().containsKey("CI")
+        isEnabled = "CI" !in System.getenv()
     }
 }

src/main/kotlin/app/revanced/cli/command/ListCompatibleVersions.kt

@@ -0,0 +1,67 @@
+package app.revanced.cli.command
+
+import app.revanced.library.PackageName
+import app.revanced.library.PatchUtils
+import app.revanced.library.VersionMap
+import app.revanced.patcher.PatchBundleLoader
+import picocli.CommandLine
+import java.io.File
+import java.util.logging.Logger
+
+@CommandLine.Command(
+    name = "list-versions",
+    description = [
+        "List the most common compatible versions of apps that are compatible " +
+            "with the patches in the supplied patch bundles.",
+    ],
+)
+internal class ListCompatibleVersions : Runnable {
+    private val logger = Logger.getLogger(ListCompatibleVersions::class.java.name)
+
+    @CommandLine.Parameters(
+        description = ["Paths to patch bundles."],
+        arity = "1..*",
+    )
+    private lateinit var patchBundles: Array<File>
+
+    @CommandLine.Option(
+        names = ["-f", "--filter-package-names"],
+        description = ["Filter patches by package name."],
+    )
+    private var packageNames: Set<String>? = null
+
+    @CommandLine.Option(
+        names = ["-u", "--count-unused-patches"],
+        description = ["Count patches that are not used by default."],
+        showDefaultValue = CommandLine.Help.Visibility.ALWAYS,
+    )
+    private var countUnusedPatches: Boolean = false
+
+    override fun run() {
+        val patches = PatchBundleLoader.Jar(*patchBundles)
+
+        fun VersionMap.buildVersionsString(): String {
+            if (isEmpty()) return "Any"
+
+            fun buildPatchesCountString(count: Int) = if (count == 1) "1 patch" else "$count patches"
+
+            return entries.joinToString("\n") { (version, count) ->
+                "$version (${buildPatchesCountString(count)})"
+            }
+        }
+
+        fun buildString(entry: Map.Entry<PackageName, VersionMap>) =
+            buildString {
+                val (name, versions) = entry
+                appendLine("Package name: $name")
+                appendLine("Most common compatible versions:")
+                appendLine(versions.buildVersionsString().prependIndent("\t"))
+            }
+
+        PatchUtils.getMostCommonCompatibleVersions(
+            patches,
+            packageNames,
+            countUnusedPatches,
+        ).entries.joinToString("\n", transform = ::buildString).let(logger::info)
+    }
+}

src/main/kotlin/app/revanced/cli/command/MainCommand.kt

@@ -33,9 +33,10 @@ private object CLIVersionProvider : IVersionProvider {
     mixinStandardHelpOptions = true,
     versionProvider = CLIVersionProvider::class,
     subcommands = [
-        ListPatchesCommand::class,
         PatchCommand::class,
         OptionsCommand::class,
+        ListPatchesCommand::class,
+        ListCompatibleVersions::class,
         UtilityCommand::class,
     ],
 )

src/main/kotlin/app/revanced/cli/command/PatchCommand.kt

@@ -1,13 +1,15 @@
 package app.revanced.cli.command
 
 import app.revanced.library.ApkUtils
+import app.revanced.library.ApkUtils.applyTo
+import app.revanced.library.ApkUtils.sign
 import app.revanced.library.Options
 import app.revanced.library.Options.setOptions
 import app.revanced.library.adb.AdbManager
 import app.revanced.patcher.PatchBundleLoader
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.Patcher
-import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.PatcherConfig
 import kotlinx.coroutines.runBlocking
 import picocli.CommandLine
 import picocli.CommandLine.Help.Visibility.ALWAYS
@@ -30,9 +32,9 @@ internal object PatchCommand : Runnable {
 
     private lateinit var apk: File
 
-    private var integrations = listOf<File>()
+    private var integrations = setOf<File>()
 
-    private var patchBundles = emptyList<File>()
+    private var patchBundles = emptySet<File>()
 
     @CommandLine.Option(
         names = ["-i", "--include"],
@@ -91,7 +93,8 @@ internal object PatchCommand : Runnable {
     @CommandLine.Option(
         names = ["-d", "--device-serial"],
         description = ["ADB device serial to install to. If not supplied, the first connected device will be used."],
-        fallbackValue = "", // Empty string to indicate that the first connected device should be used.
+        // Empty string to indicate that the first connected device should be used.
+        fallbackValue = "",
         arity = "0..1",
     )
     private var deviceSerial: String? = null
@@ -144,6 +147,17 @@ internal object PatchCommand : Runnable {
         description = ["Path to temporary resource cache directory."],
     )
     private var resourceCachePath: File? = null
+        set(value) {
+            logger.warning("The --resource-cache option is deprecated. Use --temporary-files-patch instead.")
+            field = value
+            temporaryFilesPath = value
+        }
+
+    @CommandLine.Option(
+        names = ["-t", "--temporary-files-path"],
+        description = ["Path to temporary files directory."],
+    )
+    private var temporaryFilesPath: File? = null
 
     private var aaptBinaryPath: File? = null
 
@@ -194,11 +208,11 @@ internal object PatchCommand : Runnable {
         required = true,
     )
     @Suppress("unused")
-    private fun setPatchBundles(patchBundles: Array<File>) {
+    private fun setPatchBundles(patchBundles: Set<File>) {
         patchBundles.firstOrNull { !it.exists() }?.let {
             throw CommandLine.ParameterException(spec.commandLine(), "Patch bundle ${it.name} does not exist")
         }
-        this.patchBundles = patchBundles.toList()
+        this.patchBundles = patchBundles
     }
 
     @CommandLine.Option(
@@ -224,9 +238,9 @@ internal object PatchCommand : Runnable {
                 "${apk.nameWithoutExtension}-patched.${apk.extension}",
             )
 
-        val resourceCachePath =
-            resourceCachePath ?: outputFilePath.parentFile.resolve(
-                "${outputFilePath.nameWithoutExtension}-resource-cache",
+        val temporaryFilesPath =
+            temporaryFilesPath ?: outputFilePath.parentFile.resolve(
+                "${outputFilePath.nameWithoutExtension}-temporary-files",
             )
 
         val optionsFile =
@@ -261,11 +275,11 @@ internal object PatchCommand : Runnable {
         // endregion
 
         Patcher(
-            PatcherOptions(
+            PatcherConfig(
                 apk,
-                resourceCachePath,
+                temporaryFilesPath,
                 aaptBinaryPath?.path,
-                resourceCachePath.absolutePath,
+                temporaryFilesPath.absolutePath,
                 true,
             ),
         ).use { patcher ->
@@ -285,7 +299,7 @@ internal object PatchCommand : Runnable {
             val patcherResult =
                 patcher.apply {
                     acceptIntegrations(integrations)
-                    acceptPatches(filteredPatches.toList())
+                    acceptPatches(filteredPatches)
 
                     // Execute patches.
                     runBlocking {
@@ -304,15 +318,12 @@ internal object PatchCommand : Runnable {
 
             // region Save
 
-            val alignedFile =
-                resourceCachePath.resolve(apk.name).apply {
-                    ApkUtils.copyAligned(apk, this, patcherResult)
-                }
+            apk.copyTo(outputFilePath, overwrite = true)
+
+            patcherResult.applyTo(outputFilePath)
 
             if (!mount) {
-                ApkUtils.sign(
-                    alignedFile,
-                    outputFilePath,
+                outputFilePath.sign(
                     ApkUtils.SigningOptions(
                         keystoreFilePath,
                         keyStorePassword,
@@ -321,10 +332,10 @@ internal object PatchCommand : Runnable {
                         signer,
                     ),
                 )
-            } else {
-                alignedFile.renameTo(outputFilePath)
             }
 
+            logger.info("Saved to $outputFilePath")
+
             // endregion
 
             // region Install
@@ -338,7 +349,7 @@ internal object PatchCommand : Runnable {
 
         if (purge) {
             logger.info("Purging temporary files")
-            purge(resourceCachePath)
+            purge(temporaryFilesPath)
         }
     }
 

src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt

@@ -4,7 +4,7 @@ import picocli.CommandLine
 
 @CommandLine.Command(
     name = "utility",
-    description = ["Commands for utility purposes"],
+    description = ["Commands for utility purposes."],
     subcommands = [InstallCommand::class, UninstallCommand::class],
 )
 internal object UtilityCommand