-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathAssertjImport.md.html
141 lines (116 loc) · 4.02 KB
/
AssertjImport.md.html
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<meta charset="utf-8">
(#) Flags Java 6 incompatible imports
!!! WARNING: Flags Java 6 incompatible imports
This is a warning.
Id
: `AssertjImport`
Summary
: Flags Java 6 incompatible imports
Severity
: Warning
Category
: Correctness
Platform
: Any
Vendor
: vanniktech/lint-rules/
Feedback
: https://github.com/vanniktech/lint-rules/issues
Min
: Lint 8.0 and 8.1
Compiled
: Lint 8.0 and 8.1
Artifact
: [com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html)
Affects
: Kotlin and Java files and test sources
Editing
: This check runs on the fly in the IDE editor
Implementation
: [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/main/kotlin/com/vanniktech/lintrules/android/AssertjDetector.kt)
Tests
: [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/AssertjDetectorTest.kt)
Importing org.assertj.core.api.Assertions is not ideal. Since it can
require Java 8. It's simple as instead
org.assertj.core.api.Java6Assertions can be imported and provides
guarantee to run on Java 6 as well.
!!! Tip
This lint check has an associated quickfix available in the IDE.
(##) Including
!!!
This is not a built-in check. To include it, add the below dependency
to your project. This lint check is included in the lint documentation,
but the Android team may or may not agree with its recommendations.
```
// build.gradle.kts
lintChecks("com.vanniktech:lint-rules-android:0.25.0")
// build.gradle
lintChecks 'com.vanniktech:lint-rules-android:0.25.0'
// build.gradle.kts with version catalogs:
lintChecks(libs.lint.rules.android)
# libs.versions.toml
[versions]
lint-rules-android = "0.25.0"
[libraries]
lint-rules-android = {
module = "com.vanniktech:lint-rules-android",
version.ref = "lint-rules-android"
}
```
0.25.0 is the version this documentation was generated from;
there may be newer versions available.
[Additional details about com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html).
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Using a suppression annotation like this on the enclosing
element:
```kt
// Kotlin
@Suppress("AssertjImport")
fun method() {
problematicStatement()
}
```
or
```java
// Java
@SuppressWarnings("AssertjImport")
void method() {
problematicStatement();
}
```
* Using a suppression comment like this on the line above:
```kt
//noinspection AssertjImport
problematicStatement()
```
* Using a special `lint.xml` file in the source tree which turns off
the check in that folder and any sub folder. A simple file might look
like this:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="AssertjImport" severity="ignore" />
</lint>
```
Instead of `ignore` you can also change the severity here, for
example from `error` to `warning`. You can find additional
documentation on how to filter issues by path, regular expression and
so on
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
* In Gradle projects, using the DSL syntax to configure lint. For
example, you can use something like
```gradle
lintOptions {
disable 'AssertjImport'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore AssertjImport ...`
```
* Last, but not least, using baselines, as discussed
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>