chore: Lint code

[oSumAtrIX]

This commit also changes the API, but these changes are considered fixes.

[oSumAtrIX]

@LisoUseInAIKyrios If there are other rules you want to add to .editorconfig you can do so now

[LisoUseInAIKyrios]

Can the trailing commas for kotlin be turned off? I think it looks a little messy when there's trailing commas for a variable argument function with a single parameter.

I cannot get Android Studio to add trailing commas to any code when using the code reformat function.
And Android Studio does not show any lint errors when using inspect or analyze code.

Should a lint task be added to the gradle config? So at least there's a unified way to run lint?

[oSumAtrIX]

Ktlint is used for linting. An Android Studio plugin for it iirc exists. On save, the lint rules will be applied.
I agree; the trailing commas are indeed messy and should be disabled.

Ktlint also has a Gradle plugin that we can add. It will check for lining errors on build.

[LisoUseInAIKyrios]

I found the KTLint plugin from the Android Studio plugin marketplace works corectly and can automatically fix lint errors as well.

Is there any reason the patches uses java language level 11 and not 17?

The project SDK is already java 17 and Integrations already uses language level 17 (Integrations uses language level 11)

It's a minor issue, but with Android Studio it always changes the misc.xml file to match the SDK and you have to manually change the project every time a new branch is opened.

[oSumAtrIX]

I am not entirely sure, but the version was set to 11 because of the assumption that 17 would compile incompatible bytecode for Android. Before Android 11, I believe, Java 11 was used as the target bytecode level.

[LisoUseInAIKyrios]

Ok I see that Integration is using java 11 compatibility.

Looking closer, this setting is actually the language level. Not the bytecode output compatibility level.

The bytecode output level is set to 11 in another location:

I think this language level setting can be changed to the SDK default.

[LisoUseInAIKyrios]

@oSumAtrIX Try running organize imports on HideShortsComponentsPatch, and verify it does not reorganize the imports.

If it makes changes to the imports, then the lint rules need adjusting otherwise imports will keep changing between Intellij and Android Studio usage.

[oSumAtrIX]

This is the output when I format the code:

Index: src/main/kotlin/app/revanced/patches/youtube/layout/hide/shorts/HideShortsComponentsPatch.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/src/main/kotlin/app/revanced/patches/youtube/layout/hide/shorts/HideShortsComponentsPatch.kt b/src/main/kotlin/app/revanced/patches/youtube/layout/hide/shorts/HideShortsComponentsPatch.kt
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/hide/shorts/HideShortsComponentsPatch.kt	(revision ab0af3ec572251b3d8f2b4c699460ed29794ac57)
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/hide/shorts/HideShortsComponentsPatch.kt	(date 1709572468593)
@@ -31,7 +31,7 @@
         IntegrationsPatch::class,
         LithoFilterPatch::class,
         HideShortsComponentsResourcePatch::class,
-        ResourceMappingPatch::class
+        ResourceMappingPatch::class,
     ],
     compatiblePackages = [
         CompatiblePackage(
@@ -49,10 +49,10 @@
                 "19.02.39",
                 "19.03.35",
                 "19.03.36",
-                "19.04.37"
-            ]
-        )
-    ]
+                "19.04.37",
+            ],
+        ),
+    ],
 )
 @Suppress("unused")
 object HideShortsComponentsPatch : BytecodePatch(
@@ -61,8 +61,8 @@
         ReelConstructorFingerprint,
         BottomNavigationBarFingerprint,
         RenderBottomNavigationBarParentFingerprint,
-        SetPivotBarVisibilityParentFingerprint
-    )
+        SetPivotBarVisibilityParentFingerprint,
+    ),
 ) {
     private const val FILTER_CLASS_DESCRIPTOR = "Lapp/revanced/integrations/youtube/patches/components/ShortsFilter;"
 
@@ -80,7 +80,7 @@
                     insertIndex,
                     viewRegister,
                     FILTER_CLASS_DESCRIPTOR,
-                    "hideShortsShelf"
+                    "hideShortsShelf",
                 )
             }
         } // Do not throw an exception if not resolved.
@@ -117,7 +117,7 @@
                     addInstruction(
                         insertIndex,
                         "sput-object v$viewRegister, $FILTER_CLASS_DESCRIPTOR->pivotBar:" +
-                            "Lcom/google/android/libraries/youtube/rendering/ui/pivotbar/PivotBar;"
+                            "Lcom/google/android/libraries/youtube/rendering/ui/pivotbar/PivotBar;",
                     )
                 }
             }
@@ -144,7 +144,7 @@
                 addInstruction(
                     insertIndex,
                     "invoke-static { v$viewRegister }, $FILTER_CLASS_DESCRIPTOR->" +
-                        "hideNavigationBar(Landroid/view/View;)Landroid/view/View;"
+                        "hideNavigationBar(Landroid/view/View;)Landroid/view/View;",
                 )
             }
         } ?: throw BottomNavigationBarFingerprint.exception
@@ -155,7 +155,7 @@
     private enum class ShortsButtons(private val resourceName: String, private val methodName: String) {
         COMMENTS("reel_dyn_comment", "hideShortsCommentsButton"),
         REMIX("reel_dyn_remix", "hideShortsRemixButton"),
-        SHARE("reel_dyn_share", "hideShortsShareButton")
+        SHARE("reel_dyn_share", "hideShortsShareButton"),
         ;
 
         fun injectHideCall(method: MutableMethod) {

I am not sure if the ktlint plugin is actually respecting the editorconfig file.

[LisoUseInAIKyrios]

The ktlint plugin for Android Studio is working for me.

If I remove or change the trailing line settings in editorconfig and then do ktlint format, it will add or remove the trailing commas as specified by the config.

Because not everyone will have ktlint installed, the Gradle build task could run ktlint format on all code.

[LisoUseInAIKyrios]

Maybe ktlint_code_style should be changed from intellij to android_studio (formerly named just android).

It will make intellij use formatting that is closer to Android Studio, and I think that automatic turns off trailing commas (which are not recommended for kotlin android).

[oSumAtrIX]

Oh my bad, I am using IntelliJ IDEA exclusively, even for Integrations. Possibly we should have both, intellij idea as well as android studio linting rules for integrations

[LisoUseInAIKyrios]

As far as I know, Android studio does not have any lint code format warnings or checks. It only has code formatter settings.

If editorconfig is changed to use ktlint_code_style=android_studio, that will make Intellij and ktlint use Android Studio style code formatting, and remove the need for two different lint format files (since both intellij and Android studio will then use the same formatting rules).

[LisoUseInAIKyrios]

For me Android Studio is formatting code correctly, and ktlint is correctly removing trailing commas.

@oSumAtrIX Try on your end with intellij and see if it formats and does not use trailing commas.

[LisoUseInAIKyrios]

I tried IntelliJ, for me it is no longer adding trailing commas when reformatting code.

@oSumAtrIX If it's still adding trailing commas for you, then maybe it's a installation specific setting.

[oSumAtrIX]

I have been using the dev branch instead of this one, so I'll verify again in a bit

[LisoUseInAIKyrios]

For me, running Ktlint reformatusing the KTLint plugin in Android Studio correctly removes the trailing commas if they exist.

[oSumAtrIX]

Perhaps we are using different plugins?

My plugin still insists on adding trailing commas.
Additionally, my IDE is reporting this warning, but I am not sure why:

More info I found about this: https://youtrack.jetbrains.com/issue/IDEA-336571

[LisoUseInAIKyrios]

I'm using the same plugin (works with both Intellij and Android Studio).

I think it's figured out now.
Adding the Intellij specific settings fixed it in IntelliJ for me:

ij_kotlin_allow_trailing_comma_on_call_site = false
ij_kotlin_allow_trailing_comma = false

All the plugins now work correctly for me. IntelliJ ktlint format, Android Studio ktlint format, and gradle ktlintformat, all produce the same formatted output. Running a reformat in any of them will not create clashing changes.

If it's still behaving differently for you, check if you have local project specific format settings turned on, as that might be changing the behavior.

[LisoUseInAIKyrios]

ktlintformat could be added as a dependent task to gradle compile, as it automatically fixes nearly all issues.

[LisoUseInAIKyrios]

Organize import now gives the same results between both editors.

@oSumAtrIX Try using ktlint format and IntelliJ organize imports, and no changes should be made.