Skip to content

Commit caca38d

Browse files
tnorbyetnorbye
authored
Merge pull request #92 from googlesamples/updatedocs
Update lint checks documentation snapshot
2 parents 7730fe9 + ae66c5b commit caca38d

File tree

788 files changed

+15214
-8512
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

788 files changed

+15214
-8512
lines changed

‎docs/checks/AaptCrash.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
aapt during a build. Change @+id/titlebar to @id/titlebar and define the
4545
id explicitly using <item type="id" name="titlebar"/> instead.
4646
[AaptCrash]
47-
4847
&lt;item name="android:id"&gt;@+id/titlebar&lt;/item&gt;
4948
--------------------------------------------
5049
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AcceptsUserCertificates.md.html

+4-5
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@
3434
: 2016
3535

3636
Allowing user certificates could allow eavesdroppers to intercept data
37-
sent by your app, 'which could impact the privacy of your users.
38-
Consider nesting your app's `trust-anchors` inside a `<debug-overrides>`
39-
element to make sure they are only available when `android:debuggable`
40-
is set to `"true"`.
37+
sent by your app, which could impact the privacy of your users. Consider
38+
nesting your app's `trust-anchors` inside a `<debug-overrides>` element
39+
to make sure they are only available when `android:debuggable` is set to
40+
`true`.
4141

4242
(##) Example
4343

@@ -46,7 +46,6 @@
4646
res/xml/network_config.xml:6:Warning: The Network Security Configuration
4747
allows the use of user certificates in the release version of your app
4848
[AcceptsUserCertificates]
49-
5049
&lt;certificates src="user"/&gt;
5150
--------------------------
5251
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AccessibilityFocus.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
src/com/my/app/MyView.kt:12:Warning: Do not force accessibility focus,
4040
as this interferes with screen readers and gives an inconsistent user
4141
experience, especially across apps [AccessibilityFocus]
42-
4342
performAccessibilityAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS, null)
4443
----------------------------------------------------------------------------------
4544
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AccessibilityScrollActions.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
and support ACTION_SCROLL_{FORWARD,BACKWARD} should also support
4242
ACTION_SCROLL_{LEFT,RIGHT} and/or ACTION_SCROLL_{UP,DOWN}
4343
[AccessibilityScrollActions]
44-
4544
override fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo) {
4645
^
4746
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AccessibilityWindowStateChangedEvent.md.html

-7
Original file line numberDiff line numberDiff line change
@@ -57,29 +57,22 @@
5757
View.onInitializeAccessibilityNodeInfo, Activity.setTitle,
5858
ViewCompat.setAccessibilityPaneTitle, etc. to inform users of crucial
5959
changes to the UI. [AccessibilityWindowStateChangedEvent]
60-
6160
sendAccessibilityEvent(AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED)
6261
--------------------------------------------------------------------
63-
64-
6562
src/com/my/app/MyView.kt:16:Warning: Manually populating or sending
6663
TYPE_WINDOW_STATE_CHANGED events should be avoided. They may be ignored
6764
on certain versions of Android. Prefer setting UI metadata using
6865
View.onInitializeAccessibilityNodeInfo, Activity.setTitle,
6966
ViewCompat.setAccessibilityPaneTitle, etc. to inform users of crucial
7067
changes to the UI. [AccessibilityWindowStateChangedEvent]
71-
7268
if (event.eventType == AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED) {
7369
-------------------------
74-
75-
7670
src/com/my/app/MyView.kt:23:Warning: Manually populating or sending
7771
TYPE_WINDOW_STATE_CHANGED events should be avoided. They may be ignored
7872
on certain versions of Android. Prefer setting UI metadata using
7973
View.onInitializeAccessibilityNodeInfo, Activity.setTitle,
8074
ViewCompat.setAccessibilityPaneTitle, etc. to inform users of crucial
8175
changes to the UI. [AccessibilityWindowStateChangedEvent]
82-
8376
if (event.eventType == AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED) {
8477
-------------------------
8578
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AccidentalOctal.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
4141
build.gradle:13:Error: The leading 0 turns this number into octal which
4242
is probably not what was intended (interpreted as 8) [AccidentalOctal]
43-
4443
versionCode 010
4544
---
4645
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/ActivityIconColor.md.html

-4
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,11 @@
4242
src/test/pkg/ForegroundOnlyWalkingWorkoutService.kt:9:Warning: The
4343
animated icon for an ongoing activity should be white with a transparent
4444
background [ActivityIconColor]
45-
4645
.setAnimatedIcon(R.drawable.animated_walk)
4746
------------------------
48-
49-
5047
src/test/pkg/ForegroundOnlyWalkingWorkoutService.kt:10:Warning: The
5148
static icon for an ongoing activity should be white with a transparent
5249
background [ActivityIconColor]
53-
5450
.setStaticIcon(R.drawable.ic_walk)
5551
------------------
5652
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AdapterViewChildren.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
4141
res/layout/has_children.xml:1:Warning: A list/grid should have no
4242
children declared in XML [AdapterViewChildren]
43-
4443
&lt;ListView
4544
--------
4645
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AddJavascriptInterface.md.html

-4
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,12 @@
4949
WebView.addJavascriptInterface should not be called with minSdkVersion <
5050
17 for security reasons: JavaScript can use reflection to manipulate
5151
application [AddJavascriptInterface]
52-
5352
webView.addJavascriptInterface(object, string);
5453
----------------------
55-
56-
5754
src/test/pkg/AddJavascriptInterfaceTest.java:23:Warning:
5855
WebView.addJavascriptInterface should not be called with minSdkVersion <
5956
17 for security reasons: JavaScript can use reflection to manipulate
6057
application [AddJavascriptInterface]
61-
6258
webView.addJavascriptInterface(object, string);
6359
----------------------
6460
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AlertDialogUsage.md.html

+37-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<meta charset="utf-8">
2-
(#) Use the support library AlertDialog instead of android.app.AlertDialog.
2+
(#) Use the support library AlertDialog instead of android.app.AlertDialog
33

4-
!!! WARNING: Use the support library AlertDialog instead of android.app.AlertDialog.
4+
!!! WARNING: Use the support library AlertDialog instead of android.app.AlertDialog
55
This is a warning.
66

77
Id
88
: `AlertDialogUsage`
99
Summary
10-
: Use the support library AlertDialog instead of android.app.AlertDialog.
10+
: Use the support library AlertDialog instead of android.app.AlertDialog
1111
Severity
1212
: Warning
1313
Category
@@ -29,11 +29,45 @@
2929
: Kotlin and Java files
3030
Editing
3131
: This check runs on the fly in the IDE editor
32+
Implementation
33+
: [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/main/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetector.kt)
34+
Tests
35+
: [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetectorTest.kt)
3236

3337
Support library AlertDialog is much more powerful and plays better
3438
together with the new theming / styling than the AlertDialog built into
3539
the framework.
3640

41+
(##) Example
42+
43+
Here is an example of lint warnings produced by this check:
44+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
45+
src/Test.java:4:Warning: Should not be using android.app.AlertDialog
46+
[AlertDialogUsage]
47+
public Test(AlertDialog dialog) { }
48+
------------------
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
Here is the source file referenced above:
52+
53+
`src/Test.java`:
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~java linenumbers
55+
import android.app.AlertDialog;
56+
57+
class Test {
58+
public Test(AlertDialog dialog) { }
59+
}
60+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61+
62+
You can also visit the
63+
[source code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetectorTest.kt)
64+
for the unit tests for this check to see additional scenarios.
65+
66+
The above example was automatically extracted from the first unit test
67+
found for this lint check, `AlertDialogUsageDetector.constructorParameterInJava`.
68+
To report a problem with this extracted sample, visit
69+
https://github.com/vanniktech/lint-rules/issues.
70+
3771
(##) Including
3872

3973
!!!

‎docs/checks/AllCaps.md.html

+9-2
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,11 @@
4141
res/layout/constraint.xml:12:Warning: Using textAllCaps with a string
4242
(has_markup) that contains markup; the markup will be dropped by the
4343
caps conversion [AllCaps]
44-
4544
android:textAllCaps="true"
4645
--------------------------
4746
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4847

49-
Here is the source file referenced above:
48+
Here are the relevant source files:
5049

5150
`res/layout/constraint.xml`:
5251
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
@@ -78,6 +77,14 @@
7877
&lt;/merge&gt;
7978
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8079

80+
`res/values/strings.xml`:
81+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
82+
&lt;resources&gt;
83+
&lt;string name="plain"&gt;Home Sample&lt;/string&gt;
84+
&lt;string name="has_markup"&gt;This is &lt;b&gt;bold&lt;/b&gt;&lt;/string&gt;
85+
&lt;/resources&gt;
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
8188
You can also visit the
8289
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/AllCapsDetectorTest.kt)
8390
for the unit tests for this check to see additional scenarios.

‎docs/checks/AllowAllHostnameVerifier.md.html

-4
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,13 @@
4545
returns true, which could cause insecure network traffic due to trusting
4646
TLS/SSL server certificates for wrong hostnames
4747
[AllowAllHostnameVerifier]
48-
4948
connection.setHostnameVerifier(new AllowAllHostnameVerifier());
5049
------------------------------
51-
52-
5350
src/test/pkg/InsecureHostnameVerifier.java:23:Warning: Using the
5451
ALLOW_ALL_HOSTNAME_VERIFIER HostnameVerifier is unsafe because it always
5552
returns true, which could cause insecure network traffic due to trusting
5653
TLS/SSL server certificates for wrong hostnames
5754
[AllowAllHostnameVerifier]
58-
5955
connection.setHostnameVerifier(SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
6056
--------------------------------------------
6157
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AlwaysShowAction.md.html

-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@
5454
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
5555
res/menu-land/actions.xml:6:Warning: Prefer "ifRoom" instead of "always"
5656
[AlwaysShowAction]
57-
5857
android:showAsAction="always|collapseActionView"
5958
------------------------------------------------
6059
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/checks/AndroidGradlePluginVersion.md.html

+43-22
Original file line numberDiff line numberDiff line change
@@ -43,40 +43,61 @@
4343

4444
Here is an example of lint warnings produced by this check:
4545
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
46-
build.gradle:7:Warning: A newer version of
47-
com.android.tools.build:gradle than 3.4.0-alpha3 is available: 3.5.0
46+
../gradle/libs.versions.toml:8:Warning: A newer version of
47+
com.android.application than 8.0.0 is available: 8.0.2
4848
[AndroidGradlePluginVersion]
49-
50-
classpath 'com.android.tools.build:gradle:3.4.0-alpha3'
51-
---------------------------------------------
49+
gradlePlugins-agp = "8.0.0"
50+
-------
51+
../gradle/libs.versions.toml:9:Warning: A newer version of
52+
com.android.application than 8.1.0-alpha01 is available: 8.1.0-rc01
53+
[AndroidGradlePluginVersion]
54+
gradlePlugins-agp-alpha = "8.1.0-alpha01"
55+
---------------
5256
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5357

5458
Here is the source file referenced above:
5559

56-
`build.gradle`:
57-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~groovy linenumbers
58-
buildscript {
59-
repositories {
60-
google()
61-
jcenter()
62-
}
63-
dependencies {
64-
classpath 'com.android.tools.build:gradle:3.4.0-alpha3'
65-
}
66-
}
67-
dependencies {
68-
compile 'org.apache.httpcomponents:httpcomponents-core:4.2'
69-
compile 'com.android.support:recyclerview-v7:25.0.0'
70-
compile 'com.google.firebase:firebase-messaging:10.2.1'
71-
}
60+
`../gradle/libs.versions.toml`:
61+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~toml linenumbers
62+
[versions]
63+
guavaVersion = "11.0.2"
64+
appCompatVersion="13.0.0"
65+
wearableVersion=" 1.2.0 "
66+
# Test comment suppression:
67+
#noinspection GradleDependency
68+
multi-dex="1.0.0"
69+
gradlePlugins-agp = "8.0.0"
70+
gradlePlugins-agp-alpha = "8.1.0-alpha01"
71+
gradlePlugins-agp-dev = "8.2.0-dev"
72+
gradlePlugins-crashlytics = "2.9.2"
73+
gradlePlugins-dependency-analysis = "1.0.0"
74+
75+
[libraries]
76+
com-google-guava = { module = "com.google.guava:guava", version.ref = "guavaVersion"}
77+
appcompat = { module = "com.android.support:appcompat-v7", version.ref = "appCompatVersion" }
78+
wearable-support = { group = " com.google.android.support ", name =" wearable ", version.ref = " wearableVersion " }
79+
multidex-lib = { module = "com.android.support:multidex", version.ref = "multi-dex" }
80+
81+
[bundles]
82+
misc = [
83+
"com-google-guava",
84+
"appcompat",
85+
]
86+
87+
[plugins]
88+
android-application = { id = "com.android.application", version.ref = "gradlePlugins-agp" }
89+
android-application2 = { id = "com.android.application", version.ref = "gradlePlugins-agp-alpha" }
90+
android-application3 = { id = "com.android.application", version.ref = "gradlePlugins-agp-dev" }
91+
crashlytics = { id = "com.google.firebase.crashlytics", version.ref = "gradlePlugins-crashlytics" }
92+
dependency-analysis = { id = "com.autonomousapps.dependency-analysis", version.ref = "gradlePlugins-dependency-analysis" }
7293
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7394

7495
You can also visit the
7596
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/GradleDetectorTest.kt)
7697
for the unit tests for this check to see additional scenarios.
7798

7899
The above example was automatically extracted from the first unit test
79-
found for this lint check, `GradleDetector.testVersionsFromGradleCache`.
100+
found for this lint check, `GradleDetector.testTomlVersionCatalogFile`.
80101
To report a problem with this extracted sample, visit
81102
https://issuetracker.google.com/issues/new?component=192708.
82103

0 commit comments

Comments
 (0)