A set of lint rules to check for common mistakes when styling and theming on Android

Last update: Aug 29, 2022

Overview

AndroidStyling-LintRules

A set of lint rules to prevent us from the temptation of using HEX values or direct color resources instead of attributes, when creating our layouts either by xml or programmatically.
To refresh your knowledge about theming colors: Material Guidelines.

Installation

AndroidStyling-LintRules is distributed through Maven Central, Jcenter and Jitpack.

implementation 'com.github.guilhe:styling-lint:${LATEST_VERSION}'

Usage

Well this is easy, your styles and layouts should always use attributes to get the color from the corresponding theme.
Therefore, in situations like:

<TextView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:textColor="@color/black"/>

You'll get a warning advising you to change it:

This rules are not exclusive for layouts:

getColor(R.color.colorPrimary)

You'll also get a warning advising you to change it:

In code situations, getting a color from a theme is not that trivial and it involves a bit of boilerplate code.
For that reason, ResourcesProvider-ktx may come in hand. It's a helper class to provide resources and it has "themes support":

.setBackgroundColor(resourcesProvider.colorRes(R.attr.colorPrimary, R.style.App_Style_A)

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

LICENSE

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.

A simple and easy to use stopwatch and timer library for android

TimeIt Now with Timer support! A simple and easy to use stopwatch and timer library for android Introduction A stopwatch can be a very important widge

35 Dec 10, 2022

Trail is a simple logging system for Java and Android. Create logs using the same API and the library will detect automatically in which platform the code is running.

Trail Trail is a simple logging system for Java and Android. Create logs using the same API and the library will detect automatically in which platfor

13 Aug 29, 2022

Comments

Importing from Maven or Jcenter fails (Jitpack works)
Describe the bug

Failed to resolve: AndroidStyling-LintRules:checks:unspecified Affected Modules: app

To Reproduce

Just add it as a gradle dependency: implementation 'com.github.guilhe:styling-lint:2.0.0'

Expected behavior

No fail to resolve

Details (please complete the following information):

v2.0.0

Additional context

Stackoverflow issue open

Bintray issue open

Gradle Forum issue open

Current work arounds:

Use jitpack import: or

Clone repo, build and import to/from local maven or

Use version 1.0.0, just follow README.md instructions

bug
opened by GuilhE 1

A set of lint rules to check for common mistakes when styling and theming on Android

Related tags

Overview

AndroidStyling-LintRules

Installation

Usage

Bugs and Feedback

LICENSE

You might also like...

A simple and easy to use stopwatch and timer library for android

Trail is a simple logging system for Java and Android. Create logs using the same API and the library will detect automatically in which platform the code is running.

DiskCache - Simple and readable disk cache for kotlin and android applications

A library for fast and safe delivery of parameters for Activities and Fragments.

Command framework built around Kord, built to be robust and scalable, following Kord's convention and design patterns.

a simple cache for android and java

A lightning fast, transactional, file-based FIFO for Android and Java.

UPnP/DLNA library for Java and Android

WebSocket & WAMP in Java for Android and Java 8

Comments

Importing from Maven or Jcenter fails (Jitpack works)

Describe the bug

To Reproduce

Expected behavior

Details (please complete the following information):

Additional context

Current work arounds:

Releases(v2.0.1)

v2.0.1(Dec 15, 2020)

v2.0.0(Sep 14, 2020)

v1.0.0(Jun 20, 2020)

Owner

GuilhE

Matches incoming and/or outgoing text messages against set rules and sends them over to webhook.

A beautiful set of predefined colors and a set of color methods to make your Android development life easier.

General purpose utilities and hash functions for Android and Java (aka java-common)

General purpose utilities and hash functions for Android and Java (aka java-common)

Native solution for common React Native problem of focused views being covered by soft input view.

Access and process various types of personal data in Android with a set of easy, uniform, and privacy-friendly APIs.

A set of helper classes for using dagger 1 with Android components such as Applications, Activities, Fragments, BroadcastReceivers, and Services.

compaKTset is a small library aimed at providing you with the most memory efficient Set implementation for any particular data type of your choosing.

KDoctor - A command-line tool that helps to set up the environment for Kotlin Multiplatform Mobile app development

gRPC and protocol buffers for Android, Kotlin, and Java.