Wiki for AutoDispose scope missing error prone check by bangarharshit · Pull Request #162 · uber/AutoDispose

bangarharshit · 2018-01-21T16:05:21Z

Wiki for AutoDispose scope missing error prone check. Fixes issue - #152 and references commit - #156.

ZacSweers · 2018-01-22T00:03:25Z

Wiki.md

@@ -0,0 +1,117 @@
+## Intro


Please put newlines after all headers. This header should just be the name of the wiki page, and H1 style

ZacSweers · 2018-01-22T00:03:36Z

Wiki.md

@@ -0,0 +1,117 @@
+## Intro
+[Error Prone](https://github.com/google/error-prone) check to detect missing AutoDispose scope within defined scoped elements.


This isn't a complete sentence

ZacSweers · 2018-01-22T00:03:52Z

Wiki.md

+## Installation
+
+Here are sample configurations which pulls in both the ErrorProne and the AutoDispose check.
+### Gradle


Newlines above headers too.

ZacSweers · 2018-01-22T00:04:28Z

Wiki.md

+
+Here are sample configurations which pulls in both the ErrorProne and the AutoDispose check.
+### Gradle
+```gradle


We should have an android example here too

Android example is same - annotationProcessor instead of apt

Make both please

ZacSweers · 2018-01-22T00:04:59Z

Wiki.md

+            </path>
+          </annotationProcessorPaths>
+          <compilerArgs>
+            <arg>--XepOpt:AutoDisposeLeakCheck=com.bluelinelabs.conductor.Controller,android.app.Activity</arg>


Explain this line with a comment indicating it's for configuration and optional, like in the gradle example

ZacSweers · 2018-01-22T00:10:46Z

Wiki.md

+                  ^
+    (see https://github.com/uber/AutoDispose/wiki/Error-Prone-Checker)
+```
+## Command line flags


Let's call this Configuration

ZacSweers · 2018-01-22T00:10:48Z

Wiki.md

+    (see https://github.com/uber/AutoDispose/wiki/Error-Prone-Checker)
+```
+## Command line flags
+By default the checker is applied to standard android components with lifecycle and autodispose interfaces:


Linkify these list items to docs. Also autodispose should be AutoDispose

Which docs are you talking about? Is there a link to javadocs?

yes - https://uber.github.io/AutoDispose/0.x/

ZacSweers · 2018-01-22T00:10:50Z

Wiki.md

+5. ScopeProvider
+6. LifecycleOwner
+
+It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).


this is part of a sentence, so Command-Line Flags all don't need to be capitalized. Error Prone should be Error-Prone

ZacSweers · 2018-01-22T00:10:52Z

Wiki.md

+
+It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).
+
+The following flag is supported and takes input in a form of comma separated list:


comma-separated list of fully qualified class names of Classes with scopes

Also, specify that the flag is UseAutoDispose. I see in the example though that it's AutoDisposeLeakCheck? Is that still the case? If so we should both fix it and also make it more specific, like ClassesWithScope

ZacSweers · 2018-01-22T00:10:53Z

Wiki.md

+
+- `-XepOpt:AutoDisposeLeakCheck=com.bluelinelabs.conductor.Controller,android.app.Activity`
+
+The check is now applied to `Controller` and `Activity` only.


"In this case, the check is now...", and emphasize only

ZacSweers · 2018-02-01T14:46:02Z

@harshitbangar123 ping, let's try to minimize how long these PRs are open for

bangarharshit · 2018-02-03T01:01:33Z

Sorry for the delay. I had to travel due to some urgent thing on my end. Working on it now.

bangarharshit

@hzsweers merged multiple formatting issues into 1 commit since they were fairly trivial.

bangarharshit · 2018-02-03T01:54:51Z

Wiki.md

@@ -0,0 +1,117 @@
+## Intro
+[Error Prone](https://github.com/google/error-prone) check to detect missing AutoDispose scope within defined scoped elements.


bangarharshit · 2018-02-03T01:55:04Z

Wiki.md

+## Installation
+
+Here are sample configurations which pulls in both the ErrorProne and the AutoDispose check.
+### Gradle


bangarharshit · 2018-02-03T01:55:15Z

Wiki.md

+
+Here are sample configurations which pulls in both the ErrorProne and the AutoDispose check.
+### Gradle
+```gradle


bangarharshit · 2018-02-03T01:56:03Z

Wiki.md

@@ -0,0 +1,117 @@
+## Intro


bangarharshit · 2018-02-03T01:56:31Z

Wiki.md

@@ -0,0 +1,117 @@
+## Intro
+[Error Prone](https://github.com/google/error-prone) check to detect missing AutoDispose scope within defined scoped elements.


bangarharshit · 2018-02-03T01:58:15Z

Wiki.md

+                  ^
+    (see https://github.com/uber/AutoDispose/wiki/Error-Prone-Checker)
+```
+## Command line flags


bangarharshit · 2018-02-03T01:58:26Z

Wiki.md

+    (see https://github.com/uber/AutoDispose/wiki/Error-Prone-Checker)
+```
+## Command line flags
+By default the checker is applied to standard android components with lifecycle and autodispose interfaces:


bangarharshit · 2018-02-03T01:58:45Z

Wiki.md

+5. ScopeProvider
+6. LifecycleOwner
+
+It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).


bangarharshit · 2018-02-03T01:59:03Z

Wiki.md

+
+It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).
+
+The following flag is supported and takes input in a form of comma separated list:


bangarharshit · 2018-02-03T01:59:12Z

Wiki.md

+
+- `-XepOpt:AutoDisposeLeakCheck=com.bluelinelabs.conductor.Controller,android.app.Activity`
+
+The check is now applied to `Controller` and `Activity` only.


ZacSweers · 2018-02-03T10:12:06Z

Let's keep them separate commits in the future still, as I have to basically reread the whole thing to verify now

ZacSweers · 2018-02-03T10:12:52Z

Wiki.md

@@ -1,85 +1,92 @@
-## Intro
+# Error Prone Checker


Error-Prone

ZacSweers · 2018-02-03T10:13:20Z

Wiki.md

+}
+
+plugins {
+  // we assume you are already using the Java plugin


Just put it anyway

ZacSweers · 2018-02-03T10:13:45Z

Wiki.md

+  errorprone "com.google.errorprone:error_prone_core:2.1.3"
+}
+
+tasks.withType(JavaCompile) {


Does this need to be qualified?

It works without that also but the flag will be available for all the checks but this is better - 3d7d905.

I meant JavaCompile

It doesn't need to be. Nullaway is configured like this - https://github.com/uber/NullAway

ZacSweers · 2018-02-03T10:14:27Z

Wiki.md

 6. LifecycleOwner

-It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).
+It can be configured by [Error-Prone's command line flags](http://errorprone.info/docs/flags).


via, not by

ZacSweers · 2018-02-03T10:14:36Z

Wiki.md

-The following flag is supported and takes input in a form of comma separated list:
+The following flag is supported and takes input in a form of comma separated list of fully qualified class names of Classes with scopes:

 - `-XepOpt:AutoDisposeLeakCheck=com.bluelinelabs.conductor.Controller,android.app.Activity`


Update for new name

ZacSweers · 2018-02-03T10:16:39Z

Wiki.md

+        .subscribe(new Consumer<Long>() {
+                  ^
+    (see https://github.com/uber/AutoDispose/wiki/Error-Prone-Checker)
+```


Space after code blocks too. This should be human readable before and after rendering

ZacSweers · 2018-02-03T15:59:33Z

Updated the wiki with a few little changes. Thanks!

bangarharshit · 2018-02-03T16:00:08Z

Thanks for being so patient.

bangarharshit mentioned this pull request Jan 21, 2018

Autodispose error prone checker #152

Closed

ZacSweers reviewed Jan 22, 2018

View reviewed changes

uber deleted a comment Jan 22, 2018

bangarharshit mentioned this pull request Feb 3, 2018

Error prone check configuration flag renamed to ClassesWithScope #167

Merged

bangarharshit added 4 commits February 3, 2018 07:06

Wiki for autodispose check

17c97e9

Fixed formatting issues

edba53c

Linkify docs and other formatting fixes

dcd50f8

flag renamed

c0f6c77

bangarharshit force-pushed the autodispose-wiki branch from 56fe011 to c0f6c77 Compare February 3, 2018 01:54

bangarharshit commented Feb 3, 2018

View reviewed changes

Some other formatting issues fix

16db2e2

ZacSweers reviewed Feb 3, 2018

View reviewed changes

bangarharshit added 3 commits February 3, 2018 19:34

Space after code module

7412a41

Made it more specific

3d7d905

Removed message for java plugin as android doesn't need it

ca4537e

ZacSweers closed this Feb 3, 2018

		@@ -0,0 +1,117 @@
		## Intro
		[Error Prone](https://github.com/google/error-prone) check to detect missing AutoDispose scope within defined scoped elements.


		It can be configured by [Error Prone's Command-Line Flags](http://errorprone.info/docs/flags).

		The following flag is supported and takes input in a form of comma separated list:


		- `-XepOpt:AutoDisposeLeakCheck=com.bluelinelabs.conductor.Controller,android.app.Activity`

		The check is now applied to `Controller` and `Activity` only.

Conversation

bangarharshit commented Jan 21, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZacSweers commented Feb 1, 2018

Uh oh!

bangarharshit commented Feb 3, 2018

Uh oh!

bangarharshit left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!