android-components/components/tooling/detekt/README.md

30 lines
736 B
Markdown
Raw Permalink Normal View History

2023-11-28 09:10:03 +01:00
# [Android Components](../../../README.md) > Tooling > Detekt
Custom Detekt rules for the components repository.
These additional detekt rules are run as part of the _Android Components_ build pipeline.
Published for internal usage only.
## Usage
Add into `build.gradle`:
```
dependencies {
// ...
detektPlugins "org.mozilla.components:tooling-detekt:$android_components_version"
}
```
## Rules
Section `mozilla-rules`:
- `AbsentOrWrongFileLicense` - check for correct license header in Kotlin files.
## License
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/