chore(release): 2.12.0 [skip ci]

# [2.12.0](https://github.com/revanced/revanced-cli/compare/v2.11.2...v2.12.0) (2022-09-26)

### Features

* remove unused option `-r` ([467d838](467d8387e6))

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -59,3 +59,15 @@ body:
       description: Add additional context here.
     validations:
       required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -43,4 +43,16 @@ body:
       label: Additional context
       description: Add additional context here.
     validations:
-      required: false
+      required: false
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      description: Your issue will be closed if you haven't done these steps.
+      options:
+        - label: I have searched the existing issues and this is a new and no duplicate or related to another open issue.
+          required: true
+        - label: I have written a short but informative title.
+          required: true
+        - label: I filled out all of the requested information in this issue properly.
+          required: true

.idea/vcs.xml

@@ -8,7 +8,5 @@
   </component>
   <component name="VcsDirectoryMappings">
     <mapping directory="$PROJECT_DIR$" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$/../revanced-patcher" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$/../revanced-patches" vcs="Git" />
   </component>
 </project>

CHANGELOG.md

@@ -1,3 +1,25 @@
+# [2.12.0](https://github.com/revanced/revanced-cli/compare/v2.11.2...v2.12.0) (2022-09-26)
+
+
+### Features
+
+* remove unused option `-r` ([467d838](https://github.com/revanced/revanced-cli/commit/467d8387e646c88d24a30406a5b2e84065ef4d54))
+
+## [2.11.2](https://github.com/revanced/revanced-cli/compare/v2.11.1...v2.11.2) (2022-09-23)
+
+## [2.11.1](https://github.com/revanced/revanced-cli/compare/v2.11.0...v2.11.1) (2022-09-21)
+
+# [2.11.0](https://github.com/revanced/revanced-cli/compare/v2.10.2...v2.11.0) (2022-09-20)
+
+
+### Features
+
+* section `acknowledgements` for issue templates ([0e3ecc3](https://github.com/revanced/revanced-cli/commit/0e3ecc3a51540b71072ae0be0eb94d115a5b1f92))
+
+## [2.10.2](https://github.com/revanced/revanced-cli/compare/v2.10.1...v2.10.2) (2022-09-18)
+
+## [2.10.1](https://github.com/revanced/revanced-cli/compare/v2.10.0...v2.10.1) (2022-09-09)
+
 # [2.10.0](https://github.com/revanced/revanced-cli/compare/v2.9.10...v2.10.0) (2022-09-08)
 
 

build.gradle.kts

@@ -25,7 +25,7 @@ repositories {
 dependencies {
     implementation(kotlin("reflect"))
 
-    implementation("app.revanced:revanced-patcher:4.2.3")
+    implementation("app.revanced:revanced-patcher:5.1.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 = 2.10.0
+version = 2.12.0

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

@@ -92,9 +92,6 @@ internal object MainCommand : Runnable {
         @Option(names = ["-i", "--include"], description = ["Include patches"])
         var includedPatches = arrayOf<String>()
 
-        @Option(names = ["-r", "--resource-patcher"], description = ["Disable patching resources"])
-        var disableResourcePatching: Boolean = false
-
         @Option(names = ["--experimental"], description = ["Disable patch version compatibility patch"])
         var experimental: Boolean = false
 
@@ -143,7 +140,6 @@ internal object MainCommand : Runnable {
             PatcherOptions(
                 args.inputFile,
                 pArgs.cacheDirectory,
-                !pArgs.disableResourcePatching,
                 pArgs.aaptPath,
                 pArgs.cacheDirectory,
                 PatcherLogger
@@ -210,19 +206,13 @@ internal object MainCommand : Runnable {
     }
 
     private fun uninstall() {
-        // temporarily get package name using Patcher method
-        // fix: abstract options in patcher
-        val patcher = app.revanced.patcher.Patcher(
-            PatcherOptions(
-                args.inputFile,
-                "uninstaller-cache",
+        val adb: Adb? = args.deploy?.let {
+            Adb(
+                File("placeholder_file"),
+                app.revanced.patcher.Patcher(PatcherOptions(args.inputFile, "")).data.packageMetadata.packageName,
+                args.deploy!!,
                 false
             )
-        )
-        File("uninstaller-cache").deleteRecursively()
-
-        val adb: Adb? = args.deploy?.let {
-            Adb(File("placeholder_file"), patcher.data.packageMetadata.packageName, args.deploy!!, false)
         }
         adb?.uninstall()
     }

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

@@ -35,10 +35,10 @@ internal object Patcher {
                 outputFileSystem.write(it.name, it.stream.readAllBytes())
             }
 
-            if (!args.disableResourcePatching) {
+            result.resourceFile?.let {
                 logger.info("Writing resources...")
 
-                ZipFileSystemUtils(result.resourceFile!!).use { resourceFileSystem ->
+                ZipFileSystemUtils(it).use { resourceFileSystem ->
                     val resourceFiles = resourceFileSystem.getFile(File.separator)
                     outputFileSystem.writePathRecursively(resourceFiles)
                 }

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

@@ -1,20 +1,19 @@
 package app.revanced.utils
 
 import app.revanced.cli.command.MainCommand.logger
+import app.revanced.patcher.Patcher
 import app.revanced.patcher.data.Data
 import app.revanced.patcher.extensions.PatchExtensions.options
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
-import cc.ekblad.toml.encodeTo
+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<Data>>>
-private typealias OptionsMap = Map<String, Map<String, Any>>
-
-private const val NULL = "null"
+private typealias OptionsMap = MutableMap<String, MutableMap<String, Any>>
 
 object OptionsLoader {
     @JvmStatic
@@ -23,12 +22,9 @@ object OptionsLoader {
     @JvmStatic
     fun init(file: File, patches: PatchList) {
         if (!file.exists()) file.createNewFile()
-        val path = file.toPath()
-        val map = mapper.decodeWithDefaults(
-            generateDefaults(patches),
-            TomlValue.from(path)
-        ).also { mapper.encodeTo(path, it) }
+        val map = mapper.decodeWithDefaults(generateDefaults(patches), TomlValue.from(file.toPath()))
         readAndSet(map, patches)
+        save(map, file)
     }
 
     private fun readAndSet(map: OptionsMap, patches: PatchList) {
@@ -36,27 +32,46 @@ object OptionsLoader {
             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.let {
-                        if (it == NULL) null else it
-                    }
+                    patchOptions[key] = value
                 } catch (e: Exception) {
-                    logger.warn("Error while setting option $key for patch $patchName: ${e.message}")
+                    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 ?: NULL)
+                    put(option.key, option.value ?: continue)
                 }
-            })
+            } as MutableMap)
         }
-    }
+    } as MutableMap
 }