chore(release): 1.6.0 [skip ci]

# [1.6.0](https://github.com/revanced/revanced-cli/compare/v1.5.1...v1.6.0) (2022-06-21)

### Features

* rename `debugging` option to `experimental` ([98bd6f3](98bd6f3f4b))
* use `install` mode by default ([1a3db77](1a3db77c21))

CHANGELOG.md

@@ -1,3 +1,25 @@
+# [1.6.0](https://github.com/revanced/revanced-cli/compare/v1.5.1...v1.6.0) (2022-06-21)
+
+
+### Features
+
+* rename `debugging` option to `experimental` ([98bd6f3](https://github.com/revanced/revanced-cli/commit/98bd6f3f4b3eb34c445cbd5e3a3196f399f8bb3b))
+* use `install` mode by default ([1a3db77](https://github.com/revanced/revanced-cli/commit/1a3db77c21b5795220fbac1ec36827fc521fface))
+
+## [1.5.1](https://github.com/revanced/revanced-cli/compare/v1.5.0...v1.5.1) (2022-06-21)
+
+
+### Bug Fixes
+
+* update patcher version ([09b9027](https://github.com/revanced/revanced-cli/commit/09b9027e5e28f0483e74b711cf65a7876267a339)), closes [#45](https://github.com/revanced/revanced-cli/issues/45)
+
+# [1.5.0](https://github.com/revanced/revanced-cli/compare/v1.4.5...v1.5.0) (2022-06-20)
+
+
+### Features
+
+* allow listing patches without other parameters ([#42](https://github.com/revanced/revanced-cli/issues/42)) ([b977d70](https://github.com/revanced/revanced-cli/commit/b977d7039f877be242823a4eef0fb8df6550dd05))
+
 ## [1.4.5](https://github.com/revanced/revanced-cli/compare/v1.4.4...v1.4.5) (2022-06-20)
 
 

build.gradle.kts

@@ -31,7 +31,7 @@ repositories {
 dependencies {
     implementation(kotlin("stdlib"))
     implementation(kotlin("reflect"))
-    implementation("app.revanced:revanced-patcher:1.2.9")
+    implementation("app.revanced:revanced-patcher:1.3.1")
     implementation("info.picocli:picocli:4.6.3")
     implementation("com.android.tools.build:apksig:7.2.1")
     implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 1.4.5
+version = 1.6.0

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

@@ -6,8 +6,7 @@ import app.revanced.patcher.PatcherOptions
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 import app.revanced.utils.adb.Adb
-import picocli.CommandLine.Command
-import picocli.CommandLine.Option
+import picocli.CommandLine.*
 import java.io.File
 import java.nio.file.Files
 
@@ -15,93 +14,113 @@ import java.nio.file.Files
     name = "ReVanced-CLI", version = ["1.0.0"], mixinStandardHelpOptions = true,
 )
 internal object MainCommand : Runnable {
-    @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
-    lateinit var inputFile: File
 
-    @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
-    lateinit var outputPath: String
+    @ArgGroup(exclusive = false, multiplicity = "1")
+    lateinit var args: Args
 
-    @Option(
-        names = ["-i", "--include"],
-        description = ["Which patches to include. If none is specified, all compatible default patches will be included"]
-    )
-    var includedPatches = arrayOf<String>()
+    class Args {
+        @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"], required = true)
+        var patchBundles = arrayOf<String>()
 
-    @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
-    var disableResourcePatching: Boolean = false
+        @ArgGroup(exclusive = false)
+        var lArgs: ListingArgs? = null
 
-    @Option(names = ["--debugging"], description = ["Disable patch version compatibility"])
-    var debugging: Boolean = false
+        @ArgGroup(exclusive = false)
+        var pArgs: PatchingArgs? = null
+    }
 
-    @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"])
-    var mergeFiles = listOf<File>()
+    class ListingArgs {
+        @Option(names = ["-l", "--list"], description = ["List patches only"], required = true)
+        var listOnly: Boolean = false
+    }
 
-    @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"])
-    var patchBundles = arrayOf<String>()
+    class PatchingArgs {
+        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
+        lateinit var inputFile: File
 
-    @Option(names = ["-l", "--list"], description = ["List patches only"])
-    var listOnly: Boolean = false
+        @Option(names = ["-o", "--out"], description = ["Output file path"], required = true)
+        lateinit var outputPath: String
 
-    @Option(names = ["--install"], description = ["If specified, instead of mounting, install"])
-    var install: Boolean = false
+        @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"])
+        var excludedPatches = arrayOf<String>()
 
-    @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
-    var cn = "ReVanced"
+        @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
+        var disableResourcePatching: Boolean = false
 
-    @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
-    var password = "ReVanced"
+        @Option(names = ["-e", "--experimental"], description = ["Disable patch version compatibility patch"])
+        var experimental: Boolean = false
 
-    @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
-    var deploy: String? = null
+        @Option(names = ["-m", "--merge"], description = ["One or more dex file containers to merge"])
+        var mergeFiles = listOf<File>()
 
-    @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
-    var cacheDirectory = "revanced-cache"
+        @Option(names = ["--mount"], description = ["If specified, instead of installing, mount"])
+        var mount: Boolean = false
 
-    @Option(
-        names = ["-c", "--clean"],
-        description = ["Clean the temporal resource cache directory. This will be done anyways when running the patcher"]
-    )
-    var clean: Boolean = false
+        @Option(names = ["--cn"], description = ["Overwrite the default CN for the signed file"])
+        var cn = "ReVanced"
+
+        @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
+        var password = "ReVanced"
+
+        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
+        var deploy: String? = null
+
+        @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
+        var cacheDirectory = "revanced-cache"
+
+        @Option(
+            names = ["-c", "--clean"],
+            description = ["Clean the temporal resource cache directory. This will be done anyways when running the patcher"]
+        )
+        var clean: Boolean = false
+    }
 
     override fun run() {
-        if (listOnly) {
-            for (patchBundlePath in patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
+        if (args.lArgs?.listOnly == true) {
+            for (patchBundlePath in args.patchBundles) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
                 println("[available] ${patch.patchName}")
             }
             return
         }
 
-        val patcher = app.revanced.patcher.Patcher(PatcherOptions(inputFile, cacheDirectory, !disableResourcePatching))
+        val args = args.pArgs ?: return
 
-        val outputFile = File(outputPath)
+        val patcher = app.revanced.patcher.Patcher(
+            PatcherOptions(
+                args.inputFile, args.cacheDirectory, !args.disableResourcePatching
+            )
+        )
 
-        val adb: Adb? = deploy?.let {
-            Adb(outputFile, patcher.data.packageMetadata.packageName, deploy!!, install)
+        val outputFile = File(args.outputPath)
+
+        val adb: Adb? = args.deploy?.let {
+            Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !args.mount)
         }
 
-        val patchedFile = if (install) File(cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk") else outputFile
+        val patchedFile =
+            if (args.mount) outputFile else File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
 
         Patcher.start(patcher, patchedFile)
 
         println("[aligning & signing]")
 
-        if (install) {
+        if (args.mount) {
             Signing.start(
                 patchedFile,
                 outputFile,
-                cn,
-                password,
+                args.cn,
+                args.password,
             )
         }
 
-        if (clean) File(cacheDirectory).deleteRecursively()
+        if (args.clean) File(args.cacheDirectory).deleteRecursively()
 
         adb?.let {
             println("[deploying]")
             it.deploy()
         }
 
-        if (clean && deploy != null) Files.delete(outputFile.toPath())
+        if (args.clean && args.deploy != null) Files.delete(outputFile.toPath())
 
         println("[done]")
     }

src/main/kotlin/app/revanced/cli/patcher/Patcher.kt

@@ -1,9 +1,6 @@
 package app.revanced.cli.patcher
 
-import app.revanced.cli.command.MainCommand.cacheDirectory
-import app.revanced.cli.command.MainCommand.disableResourcePatching
-import app.revanced.cli.command.MainCommand
-import app.revanced.cli.command.MainCommand.includedPatches
+import app.revanced.cli.command.MainCommand.args
 import app.revanced.utils.filesystem.ZipFileSystemUtils
 import app.revanced.utils.patcher.addPatchesFiltered
 import app.revanced.utils.patcher.applyPatchesVerbose
@@ -13,16 +10,18 @@ import java.nio.file.Files
 
 internal object Patcher {
     internal fun start(patcher: app.revanced.patcher.Patcher, output: File) {
+		val args = args.pArgs!!
+
         // merge files like necessary integrations
         patcher.mergeFiles()
         // add patches, but filter incompatible or excluded patches
-        patcher.addPatchesFiltered(includeFilter = includedPatches.isNotEmpty())
+        patcher.addPatchesFiltered(excludePatches = args.excludedPatches.isNotEmpty())
         // apply patches
         patcher.applyPatchesVerbose()
 
         // write output file
         if (output.exists()) Files.delete(output.toPath())
-        MainCommand.inputFile.copyTo(output)
+        args.inputFile.copyTo(output)
 
         ZipFileSystemUtils(output).use { fileSystem ->
             // replace all dex files
@@ -32,8 +31,8 @@ internal object Patcher {
             }
 
             // write resources
-            if (!disableResourcePatching) {
-                fileSystem.writePathRecursively(File(cacheDirectory).resolve("build").toPath())
+            if (!args.disableResourcePatching) {
+                fileSystem.writePathRecursively(File(args.cacheDirectory).resolve("build").toPath())
                 fileSystem.uncompress(*result.doNotCompress!!.toTypedArray())
             }
         }

src/main/kotlin/app/revanced/cli/signing/Signing.kt

@@ -1,13 +1,13 @@
 package app.revanced.cli.signing
 
-import app.revanced.cli.command.MainCommand.cacheDirectory
+import app.revanced.cli.command.MainCommand.args
 import app.revanced.utils.signing.Signer
 import app.revanced.utils.signing.align.ZipAligner
 import java.io.File
 
 object Signing {
     fun start(inputFile: File, outputFile: File, cn: String, password: String) {
-        val cacheDirectory = File(cacheDirectory)
+        val cacheDirectory = File(args.pArgs!!.cacheDirectory)
         val alignedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
         val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
 

src/main/kotlin/app/revanced/utils/patcher/Patcher.kt

@@ -1,8 +1,7 @@
 package app.revanced.utils.patcher
 
 import app.revanced.cli.command.MainCommand
-import app.revanced.cli.command.MainCommand.debugging
-import app.revanced.cli.command.MainCommand.patchBundles
+import app.revanced.cli.command.MainCommand.args
 import app.revanced.patcher.Patcher
 import app.revanced.patcher.data.base.Data
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
@@ -12,12 +11,12 @@ import app.revanced.patcher.patch.base.Patch
 import app.revanced.patcher.util.patch.implementation.JarPatchBundle
 
 fun Patcher.addPatchesFiltered(
-    includeFilter: Boolean = false
+    excludePatches: Boolean = false
 ) {
     val packageName = this.data.packageMetadata.packageName
     val packageVersion = this.data.packageMetadata.packageVersion
 
-    patchBundles.forEach { bundle ->
+    args.patchBundles.forEach { bundle ->
         val includedPatches = mutableListOf<Class<out Patch<Data>>>()
         JarPatchBundle(bundle).loadPatches().forEach patch@{ patch ->
             val compatiblePackages = patch.compatiblePackages
@@ -25,8 +24,10 @@ fun Patcher.addPatchesFiltered(
 
             val prefix = "[skipped] $patchName"
 
-            if (includeFilter) {
-                if (!MainCommand.includedPatches.contains(patchName)) {
+			val args = MainCommand.args.pArgs!!
+
+            if (excludePatches) {
+                if (args.excludedPatches.contains(patchName)) {
                     println("$prefix: Explicitly excluded.")
                     return@patch
                 }
@@ -42,7 +43,7 @@ fun Patcher.addPatchesFiltered(
                     return@patch
                 }
 
-                if (!(debugging || compatiblePackages.any { it.versions.isEmpty() || it.versions.any { version -> version == packageVersion }})) {
+                if (!(args.experimental || compatiblePackages.any { it.versions.isEmpty() || it.versions.any { version -> version == packageVersion }})) {
                     println("$prefix: The package version is $packageVersion and is incompatible.")
                     return@patch
                 }
@@ -67,5 +68,5 @@ fun Patcher.applyPatchesVerbose() {
 }
 
 fun Patcher.mergeFiles() {
-    this.addFiles(MainCommand.mergeFiles)
-}
+    this.addFiles(args.pArgs!!.mergeFiles)
+}