Mention val autoImport inside AutoPlugin in the docs

[unkarjedy]

In AutoPlugin you can use val autoImport: Keys.type = sbtidea.Keys. (see example)
However, it's not mentioned in the documentation https://www.scala-sbt.org/1.x/docs/Plugins.html
Related: #1314

[unkarjedy]

Also related https://youtrack.jetbrains.com/issue/SCL-20353/unused-declarations-detect-sbt.AutoPlugin-as-a-entry-point

[adpi2]

It is mentioned here: https://www.scala-sbt.org/1.x/docs/Plugins.html#Controlling+the+import+with+autoImport

More specificaly:

When an auto plugin provides a stable field such as val or object named autoImport, the contents of the field are wildcard imported in set, eval, and .sbt files.

[unkarjedy]

It is mentioned here:

Indeed!
I haven't noticed it.
I saw the example with object, but when I text-searched val autoImport I couldn't find any example.

I think it would be nice to have at least 1 example with val autoImport.
Examples with val and obj are quite different.
And this part of the documentation:

the contents of the field

is some undefined SBT magic.
(AFAIU with obejct it analyses declared fields and with val it just uses the value)

[eed3si9n]

As the name auto import suggests, it injects the following statement:

import x.y.SomePlugin.autoImport.*

From Scala or sbt's point of view if the term autoImport is a val or object doesn't really affect the behavior. We'd be happy to make a note of this in the doc to clarify this.