1907129 - Add a Fenix and AC Linter to run ktlintFormat and detekt

Status: RESOLVED FIXED

(Firefox for Android :: Tooling, task)

Description

[Olivia Hall [:olivia]]

(Adding this bug as a stepping stone for bug 1891723.)

This bug is to add a linter that runs ./gradlew ktlintFormat detekt .

Right now to run the core AC/Fenix lints, the developer must CD into .../mobile/android/fenix or .../mobile/android/android-components and run ./gradlew ktlintFormat and ./gradlew detekt.

Consider creating:

./mach lint android-ac
./mach lint android-fenix
./mach lint firefox-android (Runs both AC and Fenix lints -> basing naming idea from preset that runs AC and Fenix) 

Comment 1

[Aaditya Dhingra [:adhingra]]

Attachment: Bug 1907129 - Modify linters to run ktlint on Fenix and AC. r=ohall

Comment 2

[Aaditya Dhingra [:adhingra]]

Attachment: WIP: Bug 1907129 - Modify linters to run ./gradlew ktlint detekt on Fenix and AC.

Comment 3

[Aaditya Dhingra [:adhingra]]

Attachment: Bug 1907129 - Modify linters to run ./gradlew ktlint detekt on Fenix and AC. r=ohall

Comment 4

[Aaditya Dhingra [:adhingra]]

Just a bit of explanation on the edits made here to make reviewing easy

• build.gradle: To generate ktlint json reports. Detekt already used to generate reports and lints.py used to read reports created by spotless (GV lints). I used the same idea here, first to read the existing detekt reports, then realized that ktlint didnt generate reports by default so made changes to this file to generate ktlint json reports and read those too in lints.py.
• mozlint-android.yml: This is so that when ./mach lint is ran, it runs the new linters too
• android-{ac|fenix}.yml: These are the linter configurations. Based on documentation from https://firefox-source-docs.mozilla.org/code-quality/lint/create.html and android-format.yml as reference.
• lints.py: The new methods here fenix_format and ac_format are called from payload field in android-{ac|fenix}.yml. This is the main file which handles running ./gradlew ktlint detekt and reading/reporting the errors in the format that reviewbot reads it.

An example of how reviewbot will report errors is this patch.

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/7bdb0fe9dac8
Modify linters to run ./gradlew ktlint detekt on Fenix and AC. r=android-reviewers,nalexander,gl,pollymce

Comment 6

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/7bdb0fe9dac8

Comment 8

[Aaditya Dhingra [:adhingra]]

Attachment: Bug 1907129 - Report line and column in the link to error when ran locally. r=gl

Comment 9

[BugBot [:suhaib / :marco/ :calixte]]

A patch has been attached on this bug, which was already closed. Filing a separate bug will ensure better tracking. If this was not by mistake and further action is needed, please alert the appropriate party. (Or: if the patch doesn't change behavior -- e.g. landing a test case, or fixing a typo -- then feel free to disregard this message)

Comment 10

[Aaditya Dhingra [:adhingra]]

Attachment: WIP: Bug 1907129: Testing ktlint

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/27bb234b5808
Report line and column in the link to error when ran locally. r=gl,android-reviewers

Comment 12

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/27bb234b5808