chore(release): 3.1.1 [skip ci]

## [3.1.1](https://github.com/ReVanced/revanced-cli/compare/v3.1.0...v3.1.1) (2023-09-09)

### Bug Fixes

* Create options if it does not exist when updating them ([ca809f0](ca809f0948))

CHANGELOG.md

@@ -1,3 +1,132 @@
+## [3.1.1](https://github.com/ReVanced/revanced-cli/compare/v3.1.0...v3.1.1) (2023-09-09)
+
+
+### Bug Fixes
+
+* Create options if it does not exist when updating them ([ca809f0](https://github.com/ReVanced/revanced-cli/commit/ca809f0948379e3a825f24d7a49aba8b6b8767d1))
+
+## [3.1.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v3.1.0...v3.1.1-dev.1) (2023-09-03)
+
+
+### Bug Fixes
+
+* Create options if it does not exist when updating them ([ca809f0](https://github.com/ReVanced/revanced-cli/commit/ca809f0948379e3a825f24d7a49aba8b6b8767d1))
+
+# [3.1.0](https://github.com/ReVanced/revanced-cli/compare/v3.0.1...v3.1.0) (2023-08-31)
+
+
+### Bug Fixes
+
+* check for package compatibility at first ([9fe5a0b](https://github.com/ReVanced/revanced-cli/commit/9fe5a0b6d93304f630436ed0e954723d9a27b0f6))
+* do not filter explicitly included patches ([a3d8f00](https://github.com/ReVanced/revanced-cli/commit/a3d8f004ec405f696d99d96c74ca41b573ecf425))
+* format patches input ([bbb1a63](https://github.com/ReVanced/revanced-cli/commit/bbb1a63abd80dcbecdcf362158c0429cf3e6318f))
+
+
+### Features
+
+* Simplify command description ([3b3f7c7](https://github.com/ReVanced/revanced-cli/commit/3b3f7c7a7a7b2795e3d1fad776f6b457f2e68c7b))
+
+# [3.1.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v3.0.2-dev.2...v3.1.0-dev.1) (2023-08-28)
+
+
+### Bug Fixes
+
+* format patches input ([bbb1a63](https://github.com/ReVanced/revanced-cli/commit/bbb1a63abd80dcbecdcf362158c0429cf3e6318f))
+
+
+### Features
+
+* Simplify command description ([3b3f7c7](https://github.com/ReVanced/revanced-cli/commit/3b3f7c7a7a7b2795e3d1fad776f6b457f2e68c7b))
+
+## [3.0.2-dev.2](https://github.com/ReVanced/revanced-cli/compare/v3.0.2-dev.1...v3.0.2-dev.2) (2023-08-28)
+
+
+### Bug Fixes
+
+* check for package compatibility at first ([9fe5a0b](https://github.com/ReVanced/revanced-cli/commit/9fe5a0b6d93304f630436ed0e954723d9a27b0f6))
+
+## [3.0.2-dev.1](https://github.com/ReVanced/revanced-cli/compare/v3.0.1...v3.0.2-dev.1) (2023-08-28)
+
+
+### Bug Fixes
+
+* do not filter explicitly included patches ([a3d8f00](https://github.com/ReVanced/revanced-cli/commit/a3d8f004ec405f696d99d96c74ca41b573ecf425))
+
+## [3.0.1](https://github.com/ReVanced/revanced-cli/compare/v3.0.0...v3.0.1) (2023-08-28)
+
+## [3.0.1-dev.1](https://github.com/ReVanced/revanced-cli/compare/v3.0.0...v3.0.1-dev.1) (2023-08-28)
+
+# [3.0.0](https://github.com/ReVanced/revanced-cli/compare/v2.22.0...v3.0.0) (2023-08-26)
+
+
+### 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))
+* do not delete output file ([0f3e090](https://github.com/ReVanced/revanced-cli/commit/0f3e090418771e951dfd15e5c193421f72cbe459))
+* do not use absolute path from custom AAPT2 binary option ([a9c2a5f](https://github.com/ReVanced/revanced-cli/commit/a9c2a5f096627dbbf8ab1b8da26fb14529ce6bc3))
+* filtration of patches malfunctioning ([2d5a7fd](https://github.com/ReVanced/revanced-cli/commit/2d5a7fdf1eb2e13f5013a790b03f09851b167fe0))
+* 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))
+* print original instead of kebab cased names ([5eaad33](https://github.com/ReVanced/revanced-cli/commit/5eaad33dc1fbd24c36e1498f04e21d068e85f53e))
+* print stack trace when a patch failed ([924c1f8](https://github.com/ReVanced/revanced-cli/commit/924c1f80ec0d17a3bdc07a0fb2015e44c49162e4))
+* specify correct class containing entry-point ([1fcc591](https://github.com/ReVanced/revanced-cli/commit/1fcc591222ab67112f2b78174a8b94106846838c))
+* 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 install command ([0350b7f](https://github.com/ReVanced/revanced-cli/commit/0350b7f1a276d9dc795b22442ba4f202855ea090))
+* add options command ([9edbbf3](https://github.com/ReVanced/revanced-cli/commit/9edbbf31635603f89fc7bc5dcc6c023d4cdbb5a6))
+* Check for missing integrations ([c93186f](https://github.com/ReVanced/revanced-cli/commit/c93186fb9700907e65f33442e88073783cc163de))
+* Improve command line argument descriptions ([f9cf7d2](https://github.com/ReVanced/revanced-cli/commit/f9cf7d21b7f1c2f11234d604a1047b9d2b165f83))
+* properly make use of logging facade ([41898d7](https://github.com/ReVanced/revanced-cli/commit/41898d7547690e3130372414515c5645e5dc2634))
+* 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))
+* use better logging text ([b0e748d](https://github.com/ReVanced/revanced-cli/commit/b0e748daff527ee7f417b3069882e074896fc131))
+* use friendly descriptions ([3dd875d](https://github.com/ReVanced/revanced-cli/commit/3dd875d14cca488ade6d21bbd4cce0d481692134))
+* 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.
+
+# [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)
 
 

build.gradle.kts

@@ -52,5 +52,6 @@ tasks {
     register<DefaultTask>("publish") {
         group = "publish"
         description = "Dummy task"
+        dependsOn(build)
     }
 }

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 3.0.0-dev.5
+version = 3.1.1

gradle/libs.versions.toml

@@ -1,6 +1,6 @@
 [versions]
 shadow = "8.1.1"
-apksig = "8.1.0"
+apksig = "8.1.1"
 bcpkix-jdk15on = "1.70"
 jackson-module-kotlin = "2.14.3"
 jadb = "2531a28109"
@@ -8,7 +8,7 @@ kotlin-reflect = "1.9.0"
 kotlin-test = "1.8.20-RC"
 kotlinx-coroutines-core = "1.7.1"
 picocli = "4.7.3"
-revanced-patcher = "14.1.0"
+revanced-patcher = "14.2.1"
 
 [libraries]
 apksig = { module = "com.android.tools.build:apksig", version.ref = "apksig" }

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

@@ -23,7 +23,7 @@ internal object OptionsCommand : Runnable {
     @CommandLine.Option(
         names = ["-p", "--path"], description = ["Path to patch options JSON file"], showDefaultValue = ALWAYS
     )
-    private var path: File = File("options.json")
+    private var filePath: File = File("options.json")
 
     @CommandLine.Option(
         names = ["-o", "--overwrite"], description = ["Overwrite existing options file"], showDefaultValue = ALWAYS
@@ -37,10 +37,10 @@ internal object OptionsCommand : Runnable {
     )
     private var update: Boolean = false
 
-    override fun run() = if (!path.exists() || overwrite) with(PatchBundleLoader.Jar(*patchBundles)) {
-        if (update) setOptions(path)
+    override fun run() = if (!filePath.exists() || overwrite) with(PatchBundleLoader.Jar(*patchBundles)) {
+        if (update && filePath.exists()) setOptions(filePath)
 
-        Options.serialize(this, prettyPrint = true).let(path::writeText)
+        Options.serialize(this, prettyPrint = true).let(filePath::writeText)
     }
     else logger.severe("Options file already exists, use --override to override it")
 }

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

@@ -19,11 +19,13 @@ import kotlinx.coroutines.runBlocking
 import picocli.CommandLine
 import picocli.CommandLine.Help.Visibility.ALWAYS
 import java.io.File
+import java.io.PrintWriter
+import java.io.StringWriter
 import java.util.logging.Logger
 
 
 @CommandLine.Command(
-    name = "patch", description = ["Patch the supplied APK file with the supplied patches and integrations"]
+    name = "patch", description = ["Patch an APK file"]
 )
 internal object PatchCommand : Runnable {
     private val logger = Logger.getLogger(PatchCommand::class.java.name)
@@ -66,11 +68,11 @@ internal object PatchCommand : Runnable {
     private var exclusive = false
 
     @CommandLine.Option(
-        names = ["--experimental"],
-        description = ["Ignore patches incompatibility to versions"],
+        names = ["-f","--force"],
+        description = ["Force inclusion of patches that are incompatible with the supplied APK file's version"],
         showDefaultValue = ALWAYS
     )
-    private var experimental: Boolean = false
+    private var force: Boolean = false
 
     @CommandLine.Option(
         names = ["-o", "--out"], description = ["Path to save the patched APK file to"], required = true
@@ -128,7 +130,16 @@ internal object PatchCommand : Runnable {
         // region Prepare
 
         if (!apk.exists()) {
-            logger.severe("Input file ${apk.name} does not exist")
+            logger.severe("APK file ${apk.name} does not exist")
+            return
+        }
+
+        integrations.filter { !it.exists() }.let {
+            if (it.isEmpty()) return@let
+
+            it.forEach { integration ->
+                logger.severe("Integration file ${integration.name} does not exist")
+            }
             return
         }
 
@@ -174,7 +185,10 @@ internal object PatchCommand : Runnable {
             runBlocking {
                 apply(false).collect { patchResult ->
                     patchResult.exception?.let {
-                        logger.severe("${patchResult.patchName} failed:\n${patchResult.exception}")
+                        StringWriter().use { writer ->
+                            it.printStackTrace(PrintWriter(writer))
+                            logger.severe("${patchResult.patchName} failed: $writer")
+                        }
                     } ?: logger.info("${patchResult.patchName} succeeded")
                 }
             }
@@ -199,7 +213,6 @@ internal object PatchCommand : Runnable {
 
         if (purge) {
             logger.info("Purging temporary files")
-            outputFilePath.delete()
             purge(resourceCachePath)
         }
 
@@ -212,98 +225,56 @@ internal object PatchCommand : Runnable {
      * - [includedPatches] (explicitly included)
      * - [excludedPatches] (explicitly excluded)
      * - [exclusive] (only include patches that are explicitly included)
-     * - [experimental] (ignore patches incompatibility to versions)
-     * - package name and version of the input APK file (if [experimental] is false)
+     * - [force] (ignore patches incompatibility to versions)
+     * - Package name and version of the input APK file (if [force] is false)
      *
      * @param patches The patches to filter.
      * @return The filtered patches.
      */
     private fun Patcher.filterPatchSelection(patches: PatchList) = buildList {
+        // TODO: Remove this eventually because
+        //  patches named "patch-name" and "patch name" will conflict.
+        fun String.format() = lowercase().replace(" ", "-")
+
+        val formattedExcludedPatches = excludedPatches.map { it.format() }
+        val formattedIncludedPatches = includedPatches.map { it.format() }
+
         val packageName = context.packageMetadata.packageName
         val packageVersion = context.packageMetadata.packageVersion
 
         patches.forEach patch@{ patch ->
-            val formattedPatchName = patch.patchName.lowercase().replace(" ", "-")
+            val formattedPatchName = patch.patchName.format()
 
-            /**
-             * Check if the patch is explicitly excluded.
-             *
-             * Cases:
-             *  1. -e patch.name
-             *  2. -i patch.name -e patch.name
-             */
-
-            /**
-             * Check if the patch is explicitly excluded.
-             *
-             * Cases:
-             *  1. -e patch.name
-             *  2. -i patch.name -e patch.name
-             */
-
-            val excluded = excludedPatches.contains(formattedPatchName)
-            if (excluded) return@patch logger.info("Excluding ${patch.patchName}")
-
-            /**
-             * Check if the patch is constrained to packages.
-             */
-
-            /**
-             * Check if the patch is constrained to packages.
-             */
+            val explicitlyExcluded = formattedExcludedPatches.contains(formattedPatchName)
+            if (explicitlyExcluded) return@patch logger.info("Excluding ${patch.patchName}")
 
+            // Make sure the patch is compatible with the supplied APK files package name and version.
             patch.compatiblePackages?.let { packages ->
                 packages.singleOrNull { it.name == packageName }?.let { `package` ->
-                    /**
-                     * Check if the package version matches.
-                     * If experimental is true, version matching will be skipped.
-                     */
-
-                    /**
-                     * Check if the package version matches.
-                     * If experimental is true, version matching will be skipped.
-                     */
-
-                    val matchesVersion = experimental || `package`.versions.let {
+                    val matchesVersion = force || `package`.versions.let {
                         it.isEmpty() || it.any { version -> version == packageVersion }
                     }
 
-                    if (!matchesVersion) return@patch logger.warning("${patch.patchName} is incompatible with version $packageVersion. " + "This patch is only compatible with version " + packages.joinToString(
-                        ";"
-                    ) { pkg ->
-                        "${pkg.name}: ${pkg.versions.joinToString(", ")}"
-                    })
-
-                }
-                    ?: return@patch logger.fine("${patch.patchName} is incompatible with $packageName. " + "This patch is only compatible with " + packages.joinToString(
-                        ", "
-                    ) { `package` -> `package`.name })
+                    if (!matchesVersion) return@patch logger.warning(
+                        "${patch.patchName} is incompatible with version $packageVersion. "
+                                + "This patch is only compatible with version "
+                                + packages.joinToString(";") { pkg ->
+                            "${pkg.name}: ${pkg.versions.joinToString(", ")}"
+                        }
+                    )
+                } ?: return@patch logger.fine("${patch.patchName} is incompatible with $packageName. "
+                        + "This patch is only compatible with "
+                        + packages.joinToString(", ") { `package` -> `package`.name })
 
                 return@let
             } ?: logger.fine("$formattedPatchName: No constraint on packages.")
 
-            /**
-             * Check if the patch is explicitly included.
-             *
-             * Cases:
-             *  1. --exclusive
-             *  2. --exclusive -i patch.name
-             */
+            // If the patch is implicitly included, it will be only included if [exclusive] is false.
+            val implicitlyIncluded = !exclusive && patch.include
+            // If the patch is explicitly included, it will be included even if [exclusive] is false.
+            val explicitlyIncluded = formattedIncludedPatches.contains(formattedPatchName)
 
-            /**
-             * Check if the patch is explicitly included.
-             *
-             * Cases:
-             *  1. --exclusive
-             *  2. --exclusive -i patch.name
-             */
-
-            val explicitlyIncluded = includedPatches.contains(formattedPatchName)
-
-            val implicitlyIncluded = !exclusive && patch.include // Case 3.
-            val exclusivelyIncluded = exclusive && explicitlyIncluded // Case 2.
-
-            val included = implicitlyIncluded || exclusivelyIncluded
+            val included = implicitlyIncluded || explicitlyIncluded
             if (!included) return@patch logger.info("${patch.patchName} excluded by default") // Case 1.
 
             logger.fine("Adding $formattedPatchName")