chore(release): 2.21.0-dev.1 [skip ci]

# [2.21.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.2-dev.1...v2.21.0-dev.1) (2023-05-04)

### Bug Fixes

* **tests:** set order of tests ([816f9d6](816f9d668c))
* use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([33c6565](33c65655a4))

### Features

* add appreciation message for new contributors ([a78d646](a78d646afc))

.github/config.yml

@@ -0,0 +1,2 @@
+firstPRMergeComment: >
+  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role.

.github/workflows/update-documentation.yml

@@ -9,6 +9,7 @@ jobs:
   trigger:
     runs-on: ubuntu-latest
     name: Dispatch event to documentation repository
+    if: github.ref == 'refs/heads/main'
     steps:
       - uses: peter-evans/repository-dispatch@v2
         with:

.gitignore

@@ -74,6 +74,7 @@ cmake-build-*/
 
 # IntelliJ
 out/
+.idea
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/

.idea/.gitignore

@@ -1,11 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
-/kotlinc.xml
-/vcs.xml
-/codeStyles

.idea/discord.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="PROJECT_FILES" />
-    <option name="description" value="" />
-  </component>
-</project>

.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

.idea/misc.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="FrameworkDetectionExcludesConfiguration">
-    <file type="web" url="file://$PROJECT_DIR$" />
-  </component>
-  <component name="PWA">
-    <option name="enabled" value="true" />
-    <option name="wasEnabledAtLeastOnce" value="true" />
-  </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="azul-17" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

.idea/vcs.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CommitMessageInspectionProfile">
-    <profile version="1.0">
-      <inspection_tool class="CommitFormat" enabled="true" level="WARNING" enabled_by_default="true" />
-      <inspection_tool class="CommitNamingConvention" enabled="true" level="WARNING" enabled_by_default="true" />
-    </profile>
-  </component>
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

CHANGELOG.md

@@ -1,3 +1,51 @@
+# [2.21.0-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.2-dev.1...v2.21.0-dev.1) (2023-05-04)
+
+
+### Bug Fixes
+
+* **tests:** set order of tests ([816f9d6](https://github.com/revanced/revanced-cli/commit/816f9d668cb738e6a27c28249a65f85037309993))
+* use working JADB dependency version ([#222](https://github.com/revanced/revanced-cli/issues/222)) ([33c6565](https://github.com/revanced/revanced-cli/commit/33c65655a4afb8a17ed368166538f4f50ce3af3a))
+
+
+### Features
+
+* add appreciation message for new contributors ([a78d646](https://github.com/revanced/revanced-cli/commit/a78d646afc2cf4e2fa19fbb89416e0a3f6ba559a))
+
+## [2.20.2-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.1...v2.20.2-dev.1) (2023-04-03)
+
+
+### Bug Fixes
+
+* correct spelling mistake ([31fb316](https://github.com/revanced/revanced-cli/commit/31fb3166d922ae1f568f52e44cbe726dd1c891a4))
+
+## [2.20.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1) (2023-03-14)
+
+
+### Bug Fixes
+
+* correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51))
+
+## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-05)
+
+
+### Bug Fixes
+
+* correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51))
+
+## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-03)
+
+
+### Bug Fixes
+
+* correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51))
+
+## [2.20.1-dev.1](https://github.com/revanced/revanced-cli/compare/v2.20.0...v2.20.1-dev.1) (2023-03-02)
+
+
+### Bug Fixes
+
+* correctly word option descriptions ([ac3a8f6](https://github.com/revanced/revanced-cli/commit/ac3a8f66f77a7218974465eebbfc78a536b76d51))
+
 # [2.20.0](https://github.com/revanced/revanced-cli/compare/v2.19.0...v2.20.0) (2023-01-18)
 
 

build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    kotlin("jvm") version "1.7.0"
+    kotlin("jvm") version "1.8.10"
     id("com.github.johnrengelman.shadow") version "7.1.2"
 }
 
@@ -23,17 +23,24 @@ repositories {
 }
 
 dependencies {
-    implementation(kotlin("reflect"))
+    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20-RC")
 
     implementation("app.revanced:revanced-patcher:7.0.0")
-    implementation("info.picocli:picocli:4.7.0")
-    implementation("com.github.revanced:jadb:master-SNAPSHOT") // updated fork
-    implementation("com.android.tools.build:apksig:7.2.2")
+    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("cc.ekblad:4koma:1.1.0")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.14.+")
+    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
 }
 
 tasks {
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("PASSED", "SKIPPED", "FAILED")
+        }
+    }
     build {
         dependsOn(shadowJar)
     }

docs/1_usage.md

@@ -1,6 +1,6 @@
 # 🛠️ Using the ReVanced CLI
 
-Lean how to use the ReVanced CLI.
+Learn how to use the ReVanced CLI.
 
 ## ⚡ Setup (optional)
 
@@ -43,8 +43,7 @@ Lean how to use the ReVanced CLI.
   ```bash
   java -jar revanced-cli.jar \
    -a input.apk \
-   -c \
-   -o unpatched-output.apk \
+   -o patched-output.apk \
    -b revanced-patches.jar
   ```
 
@@ -54,19 +53,18 @@ Lean how to use the ReVanced CLI.
   adb install input.apk # make sure the same version is installed
   java -jar revanced-cli.jar \
       -a input.apk \
-      -c \
       -d device-name \
       -o patched-output.apk \
       -b revanced-patches.jar \
-      -e microg-support \
+      -e vanced-microg-support \
       --mount
   ```
 
 > **Note**:
 >
 > - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you can exclude
-    the `microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
-    option `-e microg-support` when mounting for example.
+    the `vanced-microg-support` patch from [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
+    option `-e vanced-microg-support` when mounting for example.
 >
 > - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require
     [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`.

docs/README.md

@@ -1,6 +1,6 @@
 # 💻 Documentation and guides of ReVanced CLI
 
-This documentation explain, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+This documentation explains how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
 
 ## 📖 Table of contents
 

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 2.20.0
+version = 2.21.0-dev.1

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

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

@@ -7,16 +7,24 @@ import app.revanced.cli.patcher.logging.impl.PatcherLogger
 import app.revanced.cli.signing.Signing
 import app.revanced.cli.signing.SigningOptions
 import app.revanced.patcher.PatcherOptions
+import app.revanced.patcher.data.Context
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
 import app.revanced.patcher.extensions.PatchExtensions.description
 import app.revanced.patcher.extensions.PatchExtensions.patchName
+import app.revanced.patcher.patch.Patch
 import app.revanced.patcher.util.patch.PatchBundle
-import app.revanced.utils.OptionsLoader
+import app.revanced.utils.Options
+import app.revanced.utils.Options.setOptions
 import app.revanced.utils.adb.Adb
 import picocli.CommandLine.*
 import java.io.File
 import java.nio.file.Files
 
+/**
+ * Alias for return type of [PatchBundle.loadPatches].
+ */
+internal typealias PatchList = List<Class<out Patch<Context>>>
+
 private class CLIVersionProvider : IVersionProvider {
     override fun getVersion() = arrayOf(
         MainCommand::class.java.`package`.implementationVersion ?: "unknown"
@@ -35,13 +43,16 @@ internal object MainCommand : Runnable {
     lateinit var args: Args
 
     class Args {
-        @Option(names = ["-a", "--apk"], description = ["Input file to be patched"], required = true)
+        @Option(names = ["-a", "--apk"], description = ["Input APK file to be patched"], required = true)
         lateinit var inputFile: File
 
         @Option(names = ["--uninstall"], description = ["Uninstall the mount variant"])
         var uninstall: Boolean = false
 
-        @Option(names = ["-d", "--deploy-on"], description = ["If specified, deploy to adb device with given name"])
+        @Option(
+            names = ["-d", "--deploy-on"],
+            description = ["If specified, deploy to device over ADB with given name"]
+        )
         var deploy: String? = null
 
         @ArgGroup(exclusive = false)
@@ -52,8 +63,8 @@ internal object MainCommand : Runnable {
         @Option(names = ["-b", "--bundle"], description = ["One or more bundles of patches"], required = true)
         var patchBundles = arrayOf<String>()
 
-        @Option(names = ["--options"], description = ["Configuration file for all patch options"])
-        var options: File = File("options.toml")
+        @Option(names = ["--options"], description = ["Path to patch options JSON file"])
+        var optionsFile: File = File("options.json")
 
         @ArgGroup(exclusive = false)
         var listingArgs: ListingArgs? = null
@@ -131,7 +142,10 @@ internal object MainCommand : Runnable {
             PatchBundle.Jar(bundle).loadPatches()
         }
 
-        OptionsLoader.init(args.patchArgs!!.options, allPatches)
+        args.patchArgs!!.optionsFile.let {
+            if (it.exists()) allPatches.setOptions(it, logger)
+            else Options.serialize(allPatches, prettyPrint = true).let(it::writeText)
+        }
 
         val patcher = app.revanced.patcher.Patcher(
             PatcherOptions(

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

@@ -1,8 +1,7 @@
 package app.revanced.cli.patcher
 
+import app.revanced.cli.command.PatchList
 import app.revanced.patcher.PatcherResult
-import app.revanced.patcher.data.Context
-import app.revanced.patcher.patch.Patch
 import app.revanced.utils.patcher.addPatchesFiltered
 import app.revanced.utils.patcher.applyPatchesVerbose
 import app.revanced.utils.patcher.mergeFiles
@@ -10,7 +9,7 @@ import app.revanced.utils.patcher.mergeFiles
 internal object Patcher {
     internal fun start(
         patcher: app.revanced.patcher.Patcher,
-        allPatches: List<Class<out Patch<Context>>>
+        allPatches: PatchList
     ): PatcherResult {
         // merge files like necessary integrations
         patcher.mergeFiles()

src/main/kotlin/app/revanced/utils/Options.kt

@@ -0,0 +1,103 @@
+package app.revanced.utils
+
+import app.revanced.cli.command.PatchList
+import app.revanced.cli.logging.CliLogger
+import app.revanced.patcher.extensions.PatchExtensions.options
+import app.revanced.patcher.extensions.PatchExtensions.patchName
+import app.revanced.patcher.patch.NoSuchOptionException
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import java.io.File
+
+
+internal object Options {
+    private var mapper = jacksonObjectMapper()
+
+    /**
+     * Serializes the options for the patches in the list.
+     *
+     * @param patches The list of patches to serialize.
+     * @param prettyPrint Whether to pretty print the JSON.
+     * @return The JSON string containing the options.
+     * @see PatchList
+     */
+    fun serialize(patches: PatchList, prettyPrint: Boolean = false): String = patches
+        .filter { it.options?.any() == true }
+        .map { patch ->
+            PatchOption(
+                patch.patchName,
+                patch.options!!.map { option -> PatchOption.Option(option.key, option.value) }
+            )
+        }.let {
+            if (prettyPrint)
+                mapper.writerWithDefaultPrettyPrinter().writeValueAsString(it)
+            else
+                mapper.writeValueAsString(it)
+        }
+
+    /**
+     * Deserializes the options for the patches in the list.
+     *
+     * @param json The JSON string containing the options.
+     * @return The list of [PatchOption]s.
+     * @see PatchOption
+     * @see PatchList
+     */
+    @Suppress("MemberVisibilityCanBePrivate")
+    fun deserialize(json: String): Array<PatchOption> = mapper.readValue(json, Array<PatchOption>::class.java)
+
+    /**
+     * Sets the options for the patches in the list.
+     *
+     * @param json The JSON string containing the options.
+     * @param logger The logger to use for logging.
+     */
+    fun PatchList.setOptions(json: String, logger: CliLogger? = null) {
+        filter { it.options?.any() == true }.let { patches ->
+            if (patches.isEmpty()) return
+
+            val patchOptions = deserialize(json)
+
+            patches.forEach { patch ->
+                patchOptions.find { option -> option.patchName == patch.patchName }?.let {
+                    it.options.forEach { option ->
+                        try {
+                            patch.options?.set(option.key, option.value)
+                                ?: logger?.warn("${patch.patchName} has no options")
+                        } catch (e: NoSuchOptionException) {
+                            logger?.error(e.message ?: "Unknown error")
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Sets the options for the patches in the list.
+     *
+     * @param file The file containing the JSON string containing the options.
+     * @param logger The logger to use for logging.
+     * @see setOptions
+     */
+    fun PatchList.setOptions(file: File, logger: CliLogger? = null) = setOptions(file.readText(), logger)
+
+    /**
+     * Data class for a patch and its [Option]s.
+     *
+     * @property patchName The name of the patch.
+     * @property options The [Option]s for the patch.
+     */
+    internal data class PatchOption(
+        val patchName: String,
+        val options: List<Option>
+    ) {
+
+        /**
+         * Data class for patch option.
+         *
+         * @property key The name of the option.
+         * @property value The value of the option.
+         */
+        internal data class Option(val key: String, val value: Any?)
+    }
+}

src/main/kotlin/app/revanced/utils/OptionsLoader.kt

@@ -1,77 +0,0 @@
-package app.revanced.utils
-
-import app.revanced.cli.command.MainCommand.logger
-import app.revanced.patcher.Patcher
-import app.revanced.patcher.data.Context
-import app.revanced.patcher.extensions.PatchExtensions.options
-import app.revanced.patcher.extensions.PatchExtensions.patchName
-import app.revanced.patcher.patch.Patch
-import cc.ekblad.toml.encodeToString
-import cc.ekblad.toml.model.TomlValue
-import cc.ekblad.toml.serialization.from
-import cc.ekblad.toml.tomlMapper
-import java.io.File
-
-private typealias PatchList = List<Class<out Patch<Context>>>
-private typealias OptionsMap = MutableMap<String, MutableMap<String, Any>>
-
-object OptionsLoader {
-    @JvmStatic
-    private val mapper = tomlMapper {}
-
-    @JvmStatic
-    fun init(file: File, patches: PatchList) {
-        if (!file.exists()) file.createNewFile()
-        val map = mapper.decodeWithDefaults(generateDefaults(patches), TomlValue.from(file.toPath()))
-        readAndSet(map, patches)
-        save(map, file)
-    }
-
-    private fun readAndSet(map: OptionsMap, patches: PatchList) {
-        for ((patchName, options) in map) {
-            val patch = patches.find { it.patchName == patchName } ?: continue
-            val patchOptions = patch.options ?: continue
-            for ((key, value) in options) {
-                if (value == "null") { // backwards compatibility, subject to removal
-                    options.remove(key)
-                    continue
-                }
-                try {
-                    patchOptions[key] = value
-                } catch (e: Exception) {
-                    logger.error("Error while setting option $key for patch $patchName: ${e.message}")
-                    e.printStackTrace()
-                }
-            }
-        }
-    }
-
-    private fun save(map: OptionsMap, file: File) {
-        val toml = mapper.encodeToString(map)
-        file.writeText(
-            """
-                # A list of options for each patch.
-                # This file does not contain all options by default.
-                # Run the CLI with the "--list --with-options" flags to see all available options.
-                # You can also run the CLI with the aforementioned flags and a patch name to see all available options for that patch.
-                # To set an option, add a line with the format "option = value" or set the value if the option already exists.
-                # To reset an option to its default value, delete the line.
-                # To reset all options to their default values, delete this file.
-                # 
-                # This file was generated by ReVanced Patcher version ${Patcher.version}.
-            """.trimIndent() + "\n\n$toml"
-        )
-    }
-
-    private fun generateDefaults(patches: PatchList) = buildMap {
-        for (patch in patches) {
-            val options = patch.options ?: continue
-            if (!options.iterator().hasNext()) continue
-            put(patch.patchName, buildMap {
-                for (option in options) {
-                    put(option.key, option.value ?: continue)
-                }
-            } as MutableMap)
-        }
-    } as MutableMap
-}

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

@@ -3,6 +3,7 @@ package app.revanced.utils.patcher
 import app.revanced.cli.command.MainCommand
 import app.revanced.cli.command.MainCommand.args
 import app.revanced.cli.command.MainCommand.logger
+import app.revanced.cli.command.PatchList
 import app.revanced.patcher.Patcher
 import app.revanced.patcher.data.Context
 import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
@@ -10,7 +11,7 @@ import app.revanced.patcher.extensions.PatchExtensions.include
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
 
-fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Context>>>) {
+fun Patcher.addPatchesFiltered(allPatches: PatchList) {
     val packageName = this.context.packageMetadata.packageName
     val packageVersion = this.context.packageMetadata.packageVersion
 
@@ -37,7 +38,7 @@ fun Patcher.addPatchesFiltered(allPatches: List<Class<out Patch<Context>>>) {
                 val compatibleWith = compatiblePackages.joinToString(";") { _package ->
                     "${_package.name}: ${_package.versions.joinToString(", ")}"
                 }
-                logger.warn("$prefix: Incompatible with version $packageVersion. This patch is only compatible with version $compatibleWith")
+                logger.warn("$prefix: Incompatible with version $packageVersion. This patch is only compatible with $compatibleWith")
                 return@patchLoop
             }
         }

src/test/kotlin/app/revanced/patcher/options/PatchOptionOptionsTest.kt

@@ -0,0 +1,57 @@
+package app.revanced.patcher.options
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.data.Context
+import app.revanced.patcher.patch.*
+import app.revanced.utils.Options
+import app.revanced.utils.Options.setOptions
+import org.junit.jupiter.api.MethodOrderer
+import org.junit.jupiter.api.Order
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestMethodOrder
+
+class PatchOptionsTestPatch : BytecodePatch() {
+    override fun execute(context: BytecodeContext): PatchResult {
+        return PatchResultSuccess()
+    }
+
+    companion object : OptionsContainer() {
+        var key1 by option(
+            PatchOption.StringOption(
+                "key1", null, "title1", "description1"
+            )
+        )
+
+        var key2 by option(
+            PatchOption.BooleanOption(
+                "key2", true, "title2", "description2"
+            )
+        )
+    }
+}
+
+@TestMethodOrder(MethodOrderer.OrderAnnotation::class)
+internal object PatchOptionOptionsTest {
+    private var patches = listOf(PatchOptionsTestPatch::class.java as Class<out Patch<Context>>)
+
+    @Test
+    @Order(1)
+    fun serializeTest() {
+        assert(SERIALIZED_JSON == Options.serialize(patches))
+    }
+
+    @Test
+    @Order(2)
+    fun loadOptionsTest() {
+        patches.setOptions(CHANGED_JSON)
+
+        assert(PatchOptionsTestPatch.key1 == "test")
+        assert(PatchOptionsTestPatch.key2 == false)
+    }
+
+    private const val SERIALIZED_JSON =
+        "[{\"patchName\":\"PatchOptionsTestPatch\",\"options\":[{\"key\":\"key1\",\"value\":null},{\"key\":\"key2\",\"value\":true}]}]"
+
+    private const val CHANGED_JSON =
+        "[{\"patchName\":\"PatchOptionsTestPatch\",\"options\":[{\"key\":\"key1\",\"value\":\"test\"},{\"key\":\"key2\",\"value\":false}]}]"
+}