vokal/Android-Lint-Checks

Custom Lint checks for Android development.

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.vokal:Android-Lint-Checks:'
	}

	dependencies {
		implementation("com.github.vokal:Android-Lint-Checks:")
	}

	<dependency>
	    <groupId>com.github.vokal</groupId>
	    <artifactId>Android-Lint-Checks</artifactId>
	    <version></version>
	</dependency>


                            
    libraryDependencies += "com.github.vokal" % "Android-Lint-Checks" % ""


                            
    :dependencies [[com.github.vokal/Android-Lint-Checks ""]]

Readme

Android Lint Checks

Custom Lint checks for Android development.

Checks

RxLifecycle - Ensures you are binding your Observable subscriptions to the lifecycle of an Activity, Fragment or View

  compile 'io.vokal.lint:rxlifecycle:1.0.3'

Todo - Warns you of //TODO comments in your code

  compile 'io.vokal.lint:todo:1.0.3'

Compiling

Check out the repository to your local machine via:

git clone git@github.com:vokal/Android-Lint-Checks.git

Then, from a terminal, run the following command:

./gradlew clean build test install

Now the custom Lint checks have been built, packaged, and installed to your ~/.android/lint folder.

This can be done individually as well, for example:

./gradlew clean rxlifecycle:install

Verify

To check that the custom Lint checks are now available, run the following commands:

lint --show <issue-id>

For example:

lint --show RxLifecycle

lint --show Todo

And to actually run the Lint checks, try the following command from a project of your choice:

./gradlew lint

Alternatively, you can just use Android Studio's Analyze->Inspect Code... menu option.

Credits

This project is a modified version of Linette. Linette compiles all its Lint checks into one library whereas this project is modified to separte each lint check into it's own library so they can be used individually as needed.

License

Copyright 2016 Vokal

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.