summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/tooling/detekt/README.md
blob: 64c68f4679f0fb37b0b138147ad82a9877f28c57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# [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/