Add Android Linting Example

[c0d33ngr]

This is meant to to be a draft of item number 4 of issue #3868. The android linting

Hi @lihaoyi is this close to what you have in mind about the android linting or there's more?

[lihaoyi]

@c0d33ngr looks good, need to include an example test and explanation so we can include it in the documentation

[himanshumahajan138]

@c0d33ngr Buddy you did just basic linting but this is not the appropriate way tbh i have tried this on my example and its saying the miss of class file but class files only come after the compilation

so @lihaoyi i request you to please wait till my new pull request(anndroid bundle support) gets merged coz in that i have updated the whole android app building process and made it professional (now we can include custom resources)

so @c0d33ngr sorry to interrupt you, but please understand...

[lihaoyi]

@himanshumahajan138 completing bounties out of order is fine. I'll look at your PR if you wish and we can decide which one to merge first

[himanshumahajan138]

@himanshumahajan138 completing bounties out of order is fine. I'll look at your PR if you wish and we can decide which one to merge first

Ya I Agree We can decide which one to merge first

i was saying before becoz there will be need for updated code as you can see in my pr i have updated the codes with resources

so that's the only thing i was concerned about rest we can decide this...

[c0d33ngr]

mill.javalib.palantirformat.PalantirFormatModule.formatAll java.nio.file.NoSuchFileException: /workspaces/mill/bsp/test/src
    os.walk$stream$.attrs(ListOps.scala:205)
    os.walk$stream$.apply(ListOps.scala:166)
    os.walk$.apply(ListOps.scala:96)
    mill.javalib.palantirformat.PalantirFormatModule$.$anonfun$palantirArgs$2(PalantirFormatModule.scala:177)
    scala.collection.Iterator$$anon$10.nextCur(Iterator.scala:594)
    scala.collection.Iterator$$anon$10.hasNext(Iterator.scala:608)
    scala.collection.Iterator$$anon$6.hasNext(Iterator.scala:477)
    scala.collection.Iterator$$anon$6.hasNext(Iterator.scala:480)
    scala.collection.Iterator$$anon$9.hasNext(Iterator.scala:583)
    scala.collection.mutable.ListBuffer.addAll(ListBuffer.scala:145)
    scala.collection.mutable.ListBuffer.addAll(ListBuffer.scala:39)
    scala.collection.mutable.Growable.$plus$plus$eq(Growable.scala:69)
    scala.collection.mutable.Growable.$plus$plus$eq$(Growable.scala:69)
    scala.collection.mutable.AbstractBuffer.$plus$plus$eq(Buffer.scala:314)
    mill.javalib.palantirformat.PalantirFormatModule$.palantirArgs(PalantirFormatModule.scala:180)
    mill.javalib.palantirformat.PalantirFormatModule$.palantirAction(PalantirFormatModule.scala:131)
    mill.javalib.palantirformat.PalantirFormatModule$.$anonfun$formatAll$2(PalantirFormatModule.scala:102)
    scala.runtime.java8.JFunction0$mcV$sp.apply(JFunction0$mcV$sp.scala:18)

@lihaoyi this command below produce the error output above. What could be wrong?
I'm trying to lint java files
> ./mill mill.javalib.palantirformat.PalantirFormatModule/

[c0d33ngr]

@lihaoyi @0xnm does the PR addresses the android linting example opened issue? What changes are needed if it doesn't?

[lihaoyi]

@c0d33ngr the lint error should be fixed in latest main branch, if you merge in main it should work.

Give me some time to do a proper review, I'm not familiar with android haha

[lihaoyi]

FYI I'm planning on landing #3935 first before coming back to this, since that one is a larger and more invasive PR so this one would be easier to rebase/merge after

[lihaoyi]

Took a review pass. Looks like a straightforward change but left a few nits

[c0d33ngr]

Took a review pass. Looks like a straightforward change but left a few nits

I'll do the necessary changes and also include more features to it. I had to rewrite it as a module after looking through java linting in the codebase and also other android related modules

[c0d33ngr]

I was ill so I couldn't resolve the issues pointed out from code review on time but I'm good now

[c0d33ngr]

Alright @lihaoyi

Found out the solution from the doc here

[lihaoyi]

I think this looks good. @0xnm I don't know if you want to glance over this before I merge it

[c0d33ngr]

Hi @lihaoyi took a break off the issue fro sometime, now working on it

I want to ask how to use runClassapth() and sources() within another task

runClasspath().mkString(":").toString and sources().toStringdoesn't seem to work even though storing the path values in a variable and printing it out do displays the values

Got something like this as error

[1-61] Class path entry /workspaces/milling-two/3-linting/out/app/androidLintRun.dest/ref does not exist

[1-61] Source folder /workspaces/milling-two/3-linting/out/app/androidLintRun.dest/Vector(ref does not exist.

  // Specify additional flag options for Android Lint not defined in `AndroidLintModule`
  def androidLintArgs: T[Seq[String]] = Task {
    val cp = runClasspath().mkString(":").toString
    println(cp)
    val src = sources().toString
    println(src)
    Seq(
      "--classpath",
      runClasspath().mkString(":").toString,
      "--sources",
      sources().toString
    )
  }

[lihaoyi]

@c0d33ngr runClasspath() returns a Seq[PathRef] IIRC, so you need to .map(_.path) to turn it into raw paths suitable for external programs. Same with sources()

[c0d33ngr]

@c0d33ngr runClasspath() returns a Seq[PathRef] IIRC, so you need to .map(_.path) to turn it into raw paths suitable for external programs. Same with sources()

Okay thank you, trying it out

[c0d33ngr]

@0xnm please review when less busy. I've done the changes you requested

Also, to make use of checkOnly, disable, enable and others in the mill Android lint, pass in the --check flag for specific checks in the androidLintArgs as it's done with --classpath and --sources in the linting example

checkOnly equivalent to android lint cli flag --check
disable equivalent to --disable
enable equivalent to --enable
And so on

[c0d33ngr]

AndroidManifest.xml:4: Error: Class referenced in the manifest, com.helloworld.app.MainActivity, was not found in the project or the libraries [MissingClass]
        <activity android:name=".MainActivity"
                                ~~~~~~~~~~~~~
1 errors, 0 warnings

Hi @0xnm do you have any idea to why the lint cli tool couldn't spot the it?
I tried including generatedSources, compileClasspath but the lint doesn't seem to find the file it needed

[0xnm]

I suggest you to check the arguments you are calling lint tool with and verify that your MainActivity.java file path is in the list of the sources passed.

[c0d33ngr]

I suggest you to check the arguments you are calling lint tool with and verify that your MainActivity.java file path is in the list of the sources passed.

Okay... I'll look into that

What think of the PR any changes needed?

[c0d33ngr]

Hi @0xnm , the suggestion you gave work. It was the sources() path. The --sources flag expect millSourcesPath + /src/main/java/ and not millSourcesPath + /src

You can review when less busy

[0xnm]

It looks reasonable to me. This first drop of lint support doesn't obviously support all the configuration options available in AGP and options supported by the tool, but it is a reasonable basis for doing a simple lint run.

One more handy thing to have is maybe to provide module-independent runner/report collector (see existing verification tooling modules in the codebase, they have static methods with Evaluator), but it is not a blocker for me.

I left some comments, for the rest I think @lihaoyi can do a review.

[0xnm]

probably a change to rollback? seems like this was a separator

[c0d33ngr]

please I do not fully understand what you meant here

[0xnm]

nit: it is not only txt file, but also html

[0xnm]

actually HTML is generated as well

[0xnm]

Suggested change

	// The demos are adjusting severity lelvel of linting issue, enable and disable linting issue
	// The demos are adjusting severity level of linting issue, enable and disable linting issue

[0xnm]

I'm not sure if fmt is used in this codebase as a word, it seems it is rather format which is widely used.

[0xnm]

I think you shouldn't hardcode path as main/java, because both pieces can be actually different. I would suggest to use Lib.findSourceFiles (extension can be both .java and .kotlin) at least with the given sources.

Ideally, in order to not have a huge path with each individual files there, it should be a way to find a common roots for the given set of the files, but I don't know if there are utility methods in the project's codebase to compute that.

[c0d33ngr]

I needed directory path to the sources file that's why I did that using the most common /src/main/java

[0xnm]

actual files can be under any path of sources() root, so hardcoding main/java doesn't work: nothing prevents having source files under sources()/foo/bar/foobar, for example.