chesire / lintrules

Add extra linting rules to Android projects

LintRules

Extra lint rules to add to your project.

Installation

Add the following line to your modules build.gradle

implementation 'com.github.chesire:lintrules:{version}'

Rules Added

lint-gradle

• [DuplicateDependency] - Highlights when the same dependency has been used multiple times within the same Gradle file.
• [LexicographicDependencies] - Highlights when dependencies within a Gradle file are not ordered lexicographically.
• [MultipleNewline] - Highlights when multiple blank lines are detected in a row.
• [MultipleSpaces] - Highlights when multiple spaces are detected in a row.

lint-xml

• [ColorCasing] - Highlights when a color has been defined, but is not all uppercased.
• [MultipleNewline] - Highlights when multiple blank lines are detected in a row.
• [MultipleSpaces] - Highlights when multiple spaces are detected in a row.
• [UnexpectedAttribute] - Highlights when an attribute has been used in a layout file, but it is not expected on that element.

License

Apache 2.0 - See LICENSE for more information.

lintrules's Issues

Add warning when using 'path:' in project dependencies

When defining project dependencies generally it should just be project(":dependencyName") ensure this gets used instead of project(path: "dependencyName')

Add warning for using ' as opposed to " in gradle files

To make the transition to Kotlin gradle files later on, flag up using ' instead of ". " should be perfectly valid throughout the Gradle files.

Might need some thoughts on how to handle methods though, as this would only really work for android and dependencies blocks.

Remove the Lexicographic Gradle dependency exclusion

There is currently an exclusion on the Kotlin version dependency, this can be removed now as it is no longer required to be set in the Gradle file, so if its still kept around it should be kept lexicographically.

Lexicographic dependencies has issue with nested modules

If modules are nested multiple times, it can flag up warnings where there aren't any

    implementation project(path: ":libraries:kitsu")
    implementation project(path: ":libraries:kitsu:trending")
    implementation project(path: ":libraries:library")
    implementation project(path: ":libraries:server")
    implementation project(path: ":libraries:server:trending")

in this example, implementation project(path: ":libraries:library") is flagged up as being in the wrong order, but it isn't.

Add lint rule for double new line

Gradle files should contain a single new line, a double new line should raise a lint warning.

dependencies {
  implementation...

  implementation...
}

should be valid, while

dependencies {
  implementation...


  implementation...
}

should raise a lint warning

Lexicographic ordering can seem a bit off

When using the Lexicographic ordering lint rule, since it is completely based on lexicographic ordering it takes into account : and . characters, causing an odd order when having multiple libraries from the same person.

ex:

 implementation 'com.chesire.lintrules:lint-gradle:1.1.0'
 implementation 'com.chesire.lintrules:lint-xml:1.1.0'
 implementation 'com.chesire:lifecyklelog:2.1.0'

is valid, whereas

 implementation 'com.chesire:lifecyklelog:2.1.0'
 implementation 'com.chesire.lintrules:lint-gradle:1.1.0'
 implementation 'com.chesire.lintrules:lint-xml:1.1.0'

should be valid instead.

Paths with multiple sections are flagged as duplicated

Adding other projects to the dependencies list flags up the duplicate issue even when they aren't, if they are added using the below syntax.

    implementation project(path: ":libraries:database")
    implementation project(path: ":libraries:server")

The whole line likely isn't being checked for duplicate dependencies.

Flag up usage of Assert

Instead of using Assert.assertFalse etc, the methods should be static imported into the file so they can be read as just assertFalse etc.

Rule could be named something like [AssertUsage].

Show lint warning when using constraint items when not in constraint layout

When using layouts other than a ConstraintLayout its possible to add attributes for ConstraintLayout items such constraints. There should be a warning telling the user to not use these as they are not valid.

Duplicate dependencies can fire across files

If lintOptions.checkDependencies true is set then all of the files are checked in one sweep, this causes it to flag up a duplicate dependency for the files multiple times.
Might be a way to check the file type when running the linting rules to ensure that we only do it in the same file.

Add lint rule for usage of double space

Usage of a double space is incorrect, there should only be a single space between attributes.

Add lint rule for potential dark mode issues

Add lint warnings related to the post https://dev.to/dbottillo/dark-mode-three-lint-checks-to-help-b32, some of the ideas here could be useful to integrate as lint rules.