Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swvl/linta
A set of useful lint checks to keep the Android app follow a solid design system
https://github.com/swvl/linta
android design-system lint
Last synced: 2 months ago
JSON representation
A set of useful lint checks to keep the Android app follow a solid design system
- Host: GitHub
- URL: https://github.com/swvl/linta
- Owner: swvl
- License: apache-2.0
- Created: 2022-10-18T06:59:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T12:02:03.000Z (almost 2 years ago)
- Last Synced: 2024-07-11T17:11:10.909Z (7 months ago)
- Topics: android, design-system, lint
- Language: Kotlin
- Homepage:
- Size: 158 KB
- Stars: 47
- Watchers: 5
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-list - swvl/linta - A set of useful lint checks to keep the Android app follow a solid design system (Kotlin)
README
# Linta
[](https://mvnrepository.com/artifact/com.swvl.lint/linta-android)
[](https://app.bitrise.io/app/88ca7b673ed9bb00)
[](https://codecov.io/github/swvl/linta)
[](https://opensource.org/licenses/Apache-2.0)
A set of useful lint checks developed with Android Lint API to keep the app follow a solid design system
## Motivation
Large-scale mobile apps often involve large teams of developers. Without proper lint checks in a large project's codebase, one might fall into the pitfall of inconsistent UI designs with different colors being used in layouts and other resources, making the app theme hard to maintain.
For more details, check [Lint Checks for a Solid Design System](https://docs.google.com/presentation/d/1aDEtm2UE2OoRO59Pt8fb4S43iM79BFncj0pR57WVEvw) session presented at Droidcon Egypt 2022.
## Usage
To use Linta in your project, add the following line to `build.gradle` file.
[](https://mvnrepository.com/artifact/com.swvl.lint/linta-android)
```groovy
lintChecks "com.swvl.lint:linta-android:x.y.z"
```
## Documentation
The following are the lint checks currently implemented by Linta [please add the documentation to any recent addition and/or any missing ones]:
| Lint Issue ID | Severity | Description |
|:-----------------------:|:-------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `DuplicateColors` | warning | When a duplicate color is defined in a resource file |
| `DuplicateResourceFiles`| warning | When there are two or more duplicate resource files containing the same exact attributes, regardless of differences in whitespaces, attributes order, comments, or used tools namespace if any |
| `HardcodedColorSrcCode` | error | When a hardcoded color is used in a source code file (Java or Kotlin) |
| `HardcodedColorXml` | error | When a hardcoded color is used in a resource file (drawables, layouts, etc.) |
| `RedundantStyles` | warning | When a style is created without adding any new attributes |
To see how these checks work in action, check the [generated lint report](https://github.com/swvl/linta/tree/main/sample/build/reports/lint-results-release.html) in our [sample app](https://github.com/swvl/linta/tree/main/sample).
## License
```
Copyright 2022 Swvl
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.
```