chore(release): 2.9.2 [skip ci]

## [2.9.2](https://github.com/revanced/revanced-cli/compare/v2.9.1...v2.9.2) (2022-08-07)

.github/ISSUE_TEMPLATE/bug-issue.yml

@@ -0,0 +1,61 @@
+name: 🐞 Bug report
+description: Report a very clearly broken issue.
+title: 'bug: <title>'
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced bug report
+
+        Important to note that your issue may have already been reported before. Please check for existing issues [here](https://github.com/revanced/revanced-cli/labels/bug).
+
+  - type: dropdown
+    attributes:
+      label: Type
+      options:
+        - Error while running the CLI
+        - Error at runtime
+        - Cosmetic
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Bug description
+      description: How did you find the bug? Any additional details that might help?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Add the steps to reproduce this bug including your environment.
+      placeholder: Step 1. Download some files. Step 2. ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Screenshots or videos
+      description: Add screenshots or videos that show the bug here.
+      placeholder: Drag and drop the screenshots/videos into this box.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Solution
+      description: If applicable, add a possible solution.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add additional context here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a bug report on the CLI. Do not submit suggestions for patches here.
-title: 'problem: some problem'
-labels: bug
-assignees: ''
-
----
-
-## 🐞 Issue
-
-<!-- Describe your issue in detail here -->
-
-## ⚙ Reproduce
-
-<!-- Include your environment and steps to reproduce the issue as detailed as possible -->
-
-## 🛠 Solution
-
-<!-- If applicable, add a possible solution -->
-
-## ⚠ Additional context
-
-<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📃 Documentation
+    url: https://github.com/revanced/revanced-documentation/
+    about: Don't know how or where to start? Check out our documentation!
+  - name: 🗨 Discussions
+    url: https://github.com/revanced/revanced-suggestions/discussions
+    about: Got something you think should change or be added? Search for or start a new discussion!

.github/ISSUE_TEMPLATE/feature-issue.yml

@@ -0,0 +1,46 @@
+name: ⭐ Feature request
+description: Create a detailed feature request.
+title: 'feat: <title>'
+labels: [feature-request]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # ReVanced feature request
+        
+        Do not submit requests for patches here. Please submit them [here](https://github.com/orgs/revanced/discussions/categories/patches) instead.
+        Important to note that your feature request may have already been made before. Please check for existing feature requests [here](https://github.com/revanced/revanced-cli/labels/feature-request).
+
+  - type: dropdown
+    attributes:
+      label: Type
+      options:
+        - Functionality
+        - Cosmetic
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Issue
+      description: What is the current problem. Why does it require a feature request?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Feature
+      description: Describe your feature in detail. How does it solve the issue?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: Why should your feature should be considered?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add additional context here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,24 +0,0 @@
----
-name: Feature request
-about: Suggest a change to the CLI. Do not submit suggestions for patches here.
-title: 'feat: some feature'
-labels: feature-request
-assignees: ''
-
----
-
-## 🐞 Issue
-
-<!-- Describe your issue in detail here -->
-
-## ⚙ Reproduce
-
-<!-- Include your environment and steps to reproduce the issue as detailed as possible -->
-
-## 🛠 Solution
-
-<!-- If applicable, add a possible solution -->
-
-## ⚠ Additional context
-
-<!-- Add any other context about the problem here -->

CHANGELOG.md

@@ -1,3 +1,44 @@
+## [2.9.2](https://github.com/revanced/revanced-cli/compare/v2.9.1...v2.9.2) (2022-08-07)
+
+## [2.9.1](https://github.com/revanced/revanced-cli/compare/v2.9.0...v2.9.1) (2022-08-04)
+
+
+### Reverts
+
+* feat: remove extra zipalign step ([c3d8fec](https://github.com/revanced/revanced-cli/commit/c3d8fecad0ed9d583b9f1f79bc271e0535d87be2))
+
+# [2.9.0](https://github.com/revanced/revanced-cli/compare/v2.8.3...v2.9.0) (2022-08-03)
+
+
+### Features
+
+* remove extra zipalign step ([#106](https://github.com/revanced/revanced-cli/issues/106)) ([c8e793e](https://github.com/revanced/revanced-cli/commit/c8e793efab8eed39b2cb564bee80ef6e0b2a7d03))
+
+## [2.8.3](https://github.com/revanced/revanced-cli/compare/v2.8.2...v2.8.3) (2022-08-03)
+
+## [2.8.2](https://github.com/revanced/revanced-cli/compare/v2.8.1...v2.8.2) (2022-08-02)
+
+## [2.8.1](https://github.com/revanced/revanced-cli/compare/v2.8.0...v2.8.1) (2022-08-02)
+
+
+### Bug Fixes
+
+* remove requirement for solution [skip ci] ([#108](https://github.com/revanced/revanced-cli/issues/108)) ([0ce680a](https://github.com/revanced/revanced-cli/commit/0ce680a6f1de139434edd80876a168ff695c2d79))
+
+# [2.8.0](https://github.com/revanced/revanced-cli/compare/v2.7.1...v2.8.0) (2022-07-31)
+
+
+### Features
+
+* `frameworkFolderLocation` patcher option ([bc17298](https://github.com/revanced/revanced-cli/commit/bc17298a807ce035b8baa1f7c30e1392ca4ee43b))
+
+## [2.7.1](https://github.com/revanced/revanced-cli/compare/v2.7.0...v2.7.1) (2022-07-21)
+
+
+### Bug Fixes
+
+* align every file ([96ec6a0](https://github.com/revanced/revanced-cli/commit/96ec6a0384e4c710c36b99ccf88bb14c5addc7af))
+
 # [2.7.0](https://github.com/revanced/revanced-cli/compare/v2.6.0...v2.7.0) (2022-07-21)
 
 

build.gradle.kts

@@ -26,7 +26,7 @@ dependencies {
     implementation(kotlin("stdlib"))
     implementation(kotlin("reflect"))
 
-    implementation("app.revanced:revanced-patcher:2.4.0")
+    implementation("app.revanced:revanced-patcher:3.3.2")
     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.7.0
+version = 2.9.2

src/main/kotlin/app/revanced/cli/aligning/Aligning.kt

@@ -0,0 +1,12 @@
+package app.revanced.cli.aligning
+
+import app.revanced.cli.command.MainCommand.logger
+import app.revanced.utils.signing.align.ZipAligner
+import java.io.File
+
+object Aligning {
+    fun align(inputFile: File, outputFile: File) {
+        logger.info("Aligning ${inputFile.name} to ${outputFile.name}")
+        ZipAligner.align(inputFile, outputFile)
+    }
+}

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

@@ -1,5 +1,6 @@
 package app.revanced.cli.command
 
+import app.revanced.cli.aligning.Aligning
 import app.revanced.cli.logging.impl.DefaultCliLogger
 import app.revanced.cli.patcher.Patcher
 import app.revanced.cli.patcher.logging.impl.PatcherLogger
@@ -9,7 +10,7 @@ import app.revanced.patcher.PatcherOptions
 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.util.patch.implementation.JarPatchBundle
+import app.revanced.patcher.util.patch.impl.JarPatchBundle
 import app.revanced.utils.adb.Adb
 import picocli.CommandLine.*
 import java.io.File
@@ -43,18 +44,18 @@ internal object MainCommand : Runnable {
         var deploy: String? = null
 
         @ArgGroup(exclusive = false)
-        var sArgs: StartPatcherArgs? = null
+        var patchArgs: PatchArgs? = null
     }
 
-    class StartPatcherArgs {
+    class PatchArgs {
         @Option(names = ["-b", "--bundles"], description = ["One or more bundles of patches"], required = true)
         var patchBundles = arrayOf<String>()
 
         @ArgGroup(exclusive = false)
-        var lArgs: ListingArgs? = null
+        var listingArgs: ListingArgs? = null
 
         @ArgGroup(exclusive = false)
-        var pArgs: PatchingArgs? = null
+        var patchingArgs: PatchingArgs? = null
     }
 
     class ListingArgs {
@@ -78,7 +79,10 @@ internal object MainCommand : Runnable {
         @Option(names = ["-e", "--exclude"], description = ["Explicitly exclude patches"])
         var excludedPatches = arrayOf<String>()
 
-        @Option(names = ["--exclusive"], description = ["Only installs the patches you include, not including any patch by default"])
+        @Option(
+            names = ["--exclusive"],
+            description = ["Only installs the patches you include, not including any patch by default"]
+        )
         var defaultExclude = false
 
         @Option(names = ["-i", "--include"], description = ["Include patches"])
@@ -105,12 +109,12 @@ internal object MainCommand : Runnable {
         @Option(names = ["-p", "--password"], description = ["Overwrite the default password for the signed file"])
         var password = "ReVanced"
 
-        @Option(names = ["-t", "--temp-dir"], description = ["Temporal resource cache directory"])
+        @Option(names = ["-t", "--temp-dir"], description = ["Temporary 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"]
+            description = ["Clean the temporary resource cache directory. This will be done anyways when running the patcher"]
         )
         var clean: Boolean = false
 
@@ -119,83 +123,115 @@ internal object MainCommand : Runnable {
     }
 
     override fun run() {
-        if (args.sArgs?.lArgs?.listOnly == true) {
+        if (args.patchArgs?.listingArgs?.listOnly == true) {
             printListOfPatches()
             return
         }
 
         if (args.uninstall) {
-            // temporarily get package name using Patcher method
-            // fix: abstract options in patcher
-            val patcher = app.revanced.patcher.Patcher(
-                PatcherOptions(
-                    args.inputFile,
-                    "uninstaller-cache",
-                    false
-                )
-            )
-            File("uninstaller-cache").deleteRecursively()
-
-            val adb: Adb? = args.deploy?.let {
-                Adb(File("placeholder_file"), patcher.data.packageMetadata.packageName, args.deploy!!, false)
-            }
-            adb?.uninstall()
-
+            uninstall()
             return
         }
 
-        val _args = args
-        val args = args.sArgs?.pArgs ?: return
+        val pArgs = this.args.patchArgs?.patchingArgs ?: return
+
+        // the file to write to
+        val outputFile = File(pArgs.outputPath)
 
         val patcher = app.revanced.patcher.Patcher(
             PatcherOptions(
-                _args.inputFile,
-                args.cacheDirectory,
-                !args.disableResourcePatching,
-                args.aaptPath,
-                logger = PatcherLogger
+                args.inputFile,
+                pArgs.cacheDirectory,
+                !pArgs.disableResourcePatching,
+                pArgs.aaptPath,
+                pArgs.cacheDirectory,
+                PatcherLogger
             )
         )
 
-        val outputFile = File(args.outputPath)
-
-        val adb: Adb? = _args.deploy?.let {
-            Adb(outputFile, patcher.data.packageMetadata.packageName, _args.deploy!!, !args.mount)
+        // prepare adb
+        val adb: Adb? = args.deploy?.let {
+            Adb(outputFile, patcher.data.packageMetadata.packageName, args.deploy!!, !pArgs.mount)
         }
-        val patchedFile = if (args.mount) outputFile
-        else File(args.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
 
+        val patchedFile = File(pArgs.cacheDirectory).resolve("${outputFile.nameWithoutExtension}_raw.apk")
+
+        // start the patcher
         Patcher.start(patcher, patchedFile)
 
-        if (!args.mount) {
-            Signing.start(
-                patchedFile,
-                outputFile,
+        val cacheDirectory = File(pArgs.cacheDirectory)
+
+        // align the file
+        val alignedFile = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
+        Aligning.align(patchedFile, alignedFile)
+
+        // sign the file
+        val finalFile = if (!pArgs.mount) {
+            val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
+            Signing.sign(
+                alignedFile,
+                signedOutput,
                 SigningOptions(
-                    args.cn,
-                    args.password,
-                    args.keystorePath ?: outputFile.absoluteFile.parentFile
+                    pArgs.cn,
+                    pArgs.password,
+                    pArgs.keystorePath ?: outputFile.absoluteFile.parentFile
                         .resolve("${outputFile.nameWithoutExtension}.keystore")
                         .canonicalPath
                 )
             )
-        }
 
-        if (args.clean) File(args.cacheDirectory).deleteRecursively()
+            signedOutput
+        } else
+            alignedFile
 
+        // finally copy to the specified output file
+        logger.info("Copying ${finalFile.name} to ${outputFile.name}")
+        finalFile.copyTo(outputFile, overwrite = true)
+
+        // clean up the cache directory if needed
+        if (pArgs.clean)
+            cleanUp(pArgs.cacheDirectory)
+
+        // deploy if specified
         adb?.deploy()
 
-        if (args.clean && _args.deploy != null) Files.delete(outputFile.toPath())
+        if (pArgs.clean && args.deploy != null) Files.delete(outputFile.toPath())
 
         logger.info("Finished")
     }
 
+    private fun cleanUp(cacheDirectory: String) {
+        val result = if (File(cacheDirectory).deleteRecursively())
+            "Cleaned up cache directory"
+        else
+            "Failed to clean up cache directory"
+        logger.info(result)
+    }
+
+    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",
+                false
+            )
+        )
+        File("uninstaller-cache").deleteRecursively()
+
+        val adb: Adb? = args.deploy?.let {
+            Adb(File("placeholder_file"), patcher.data.packageMetadata.packageName, args.deploy!!, false)
+        }
+        adb?.uninstall()
+    }
+
     private fun printListOfPatches() {
-        for (patchBundlePath in args.sArgs?.patchBundles!!) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
+        for (patchBundlePath in args.patchArgs?.patchBundles!!) for (patch in JarPatchBundle(patchBundlePath).loadPatches()) {
             for (compatiblePackage in patch.compatiblePackages!!) {
                 val packageEntryStr = buildString {
                     // Add package if flag is set
-                    if (args.sArgs?.lArgs?.withPackages == true) {
+                    if (args.patchArgs?.listingArgs?.withPackages == true) {
                         val packageName = compatiblePackage.name.substringAfterLast(".").padStart(10)
                         append(packageName)
                         append("\t")
@@ -204,12 +240,12 @@ internal object MainCommand : Runnable {
                     val patchName = patch.patchName.padStart(25)
                     append(patchName)
                     // Add description if flag is set.
-                    if (args.sArgs?.lArgs?.withDescriptions == true) {
+                    if (args.patchArgs?.listingArgs?.withDescriptions == true) {
                         append("\t")
                         append(patch.description)
                     }
                     // Add compatible versions, if flag is set
-                    if (args.sArgs?.lArgs?.withVersions == true) {
+                    if (args.patchArgs?.listingArgs?.withVersions == true) {
                         val compatibleVersions = compatiblePackage.versions.joinToString(separator = ", ")
                         append("\t")
                         append(compatibleVersions)

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

@@ -12,7 +12,7 @@ import java.nio.file.Files
 internal object Patcher {
     internal fun start(patcher: app.revanced.patcher.Patcher, output: File) {
         val inputFile = args.inputFile
-        val args = args.sArgs?.pArgs!!
+        val args = args.patchArgs?.patchingArgs!!
 
         // merge files like necessary integrations
         patcher.mergeFiles()
@@ -30,7 +30,7 @@ internal object Patcher {
             // replace all dex files
             result.dexFiles.forEach {
                 logger.info("Writing dex file ${it.name}")
-                outputFileSystem.write(it.name, it.dexFileInputStream.readAllBytes())
+                outputFileSystem.write(it.name, it.stream.readAllBytes())
             }
 
             if (!args.disableResourcePatching) {

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

@@ -1,28 +1,12 @@
 package app.revanced.cli.signing
 
-import app.revanced.cli.command.MainCommand.args
 import app.revanced.cli.command.MainCommand.logger
 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, signingOptions: SigningOptions) {
-        val cacheDirectory = File(args.sArgs?.pArgs?.cacheDirectory)
-        val alignedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_aligned.apk")
-        val signedOutput = cacheDirectory.resolve("${outputFile.nameWithoutExtension}_signed.apk")
-
-        // align the inputFile and write to alignedOutput
-        logger.info("Aligning ${inputFile.name}")
-        ZipAligner.align(inputFile, alignedOutput)
-        // sign the alignedOutput and write to signedOutput
-        // the reason is, in case the signer fails
-        // it does not damage the output file
-        logger.info("Signing ${alignedOutput.name}")
-        Signer(signingOptions).signApk(alignedOutput, signedOutput)
-
-        // afterwards copy over the file to the output
-        logger.info("Copying ${signedOutput.name} to ${outputFile.name}")
-        signedOutput.copyTo(outputFile, true)
+    fun sign(alignedFile: File, signedOutput: File, signingOptions: SigningOptions) {
+        logger.info("Signing ${alignedFile.name} to ${signedOutput.name}")
+        Signer(signingOptions).signApk(alignedFile, signedOutput)
     }
 }

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

@@ -9,13 +9,13 @@ import app.revanced.patcher.extensions.PatchExtensions.compatiblePackages
 import app.revanced.patcher.extensions.PatchExtensions.include
 import app.revanced.patcher.extensions.PatchExtensions.patchName
 import app.revanced.patcher.patch.Patch
-import app.revanced.patcher.util.patch.implementation.JarPatchBundle
+import app.revanced.patcher.util.patch.impl.JarPatchBundle
 
 fun Patcher.addPatchesFiltered() {
     val packageName = this.data.packageMetadata.packageName
     val packageVersion = this.data.packageMetadata.packageVersion
 
-    args.sArgs?.patchBundles!!.forEach { bundle ->
+    args.patchArgs?.patchBundles!!.forEach { bundle ->
         val includedPatches = mutableListOf<Class<out Patch<Data>>>()
         JarPatchBundle(bundle).loadPatches().forEach patch@{ patch ->
             val compatiblePackages = patch.compatiblePackages
@@ -23,7 +23,7 @@ fun Patcher.addPatchesFiltered() {
 
             val prefix = "Skipping $patchName"
 
-            val args = MainCommand.args.sArgs?.pArgs!!
+            val args = MainCommand.args.patchArgs?.patchingArgs!!
 
             if (args.excludedPatches.contains(patchName)) {
                 logger.info("$prefix: Explicitly excluded")
@@ -72,7 +72,7 @@ fun Patcher.applyPatchesVerbose() {
 }
 
 fun Patcher.mergeFiles() {
-    this.addFiles(args.sArgs?.pArgs!!.mergeFiles) { file ->
+    this.addFiles(args.patchArgs?.patchingArgs!!.mergeFiles) { file ->
         logger.info("Merging $file")
     }
 }

src/main/kotlin/app/revanced/utils/signing/Signer.kt

@@ -56,7 +56,7 @@ internal class Signer(
         // TODO: keystore should be saved securely
         val ks = File(signingOptions.keyStoreFilePath)
         if (!ks.exists()) newKeystore(ks) else {
-            logger.info("Found existing keystore: ${ks.nameWithoutExtension}")
+            logger.info("Found existing keystore: ${ks.name}")
         }
 
         val keyStore = KeyStore.getInstance("BKS", "BC")