drawers / abecedary Goto Github PK

In large Gradle projects, the include calls in the settings.gradle.kts often get messy. Maybe there is some way to allow the lint check to work here?

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update gradle/gradle-build-action digest to ac2d340
• Update gradle/wrapper-validation-action digest to f9c9c57
• Update agp to v8.5.1 (com.android.library, com.android.application)
• Update dependency org.jetbrains.kotlin.jvm to v1.9.25
• Update lint to v31.5.1 (com.android.tools.lint:lint-tests, com.android.tools.lint:lint, com.android.tools.lint:lint-checks, com.android.tools.lint:lint-api)
• Update plugin lint to v8.5.1
• Update dependency gradle to v8.9
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency org.jetbrains.kotlin.jvm to v2

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Abecedary currently publishes an annotation artifact and a lint artifact. In a way, the annotation artifact is wasteful.

It's possible to use options in lint rules (https://googlesamples.github.io/android-custom-lint-rules/api-guide.html#options/readingoptions).

So we could allow the user to forgo using the annotation artifact and use an annotation declared in their own codebase

Abecedary currently does a deep search through supertypes looking for the @Alphabetical annotation.

We should allow opt-out of this behavior to control performance in large projects, making the lint check only kick in when there is an explicit @Alphabetical annotation.

It can be done via a lint option:

https://googlesamples.github.io/android-custom-lint-rules/api-guide.html#options/readingoptions

Current release management and CI/CD infrastructure is very basic or non-existent. Would be good to set up infrastructure to make releases via GitHub.

The message for the lint rule should explain about the annotation, otherwise it's not clear to a reader. It should also highlight the supertype containing the annotation if it's not explicitly decorating the class location of the message.

Another common site for merge conflicts and disorder are blocks like the dependencies { block in a build.gradle.kts file.

We could make @Alphabetical apply to a block:

@Alphabetical run {
    println("apple")
    println("banana")
}

in which case, it would scan the lines of the block and enforce dictionary order. This could be a "nuclear option" where none of the other annotation targets make sense.

Although there is a general preference to use UElementHandler, for annotation usages it's okay to use the Detector APIs. We should try that to see if it supports all our use cases