Main Settings
API
Generated with
Main Settings/sbt/AutoPlugin

AutoPlugin

sbt.AutoPlugin
abstract class AutoPlugin extends Basic, PluginsFunctions

An AutoPlugin defines a group of settings and the conditions where the settings are automatically added to a build (called "activation"). The requires and trigger methods together define the conditions, and a method like projectSettings defines the settings to add.

Steps for plugin authors:

  1. Determine if the AutoPlugin should automatically be activated when all requirements are met, or should be opt-in.
  2. Determine the AutoPlugins that, when present (or absent), act as the requirements for the AutoPlugin.
  3. Determine the settings/configurations to that the AutoPlugin injects when activated.
  4. Determine the keys and other names to be automatically imported to *.sbt scripts.

For example, the following will automatically add the settings in projectSettings to a project that has both the Web and Javascript plugins enabled.

object MyPlugin extends sbt.AutoPlugin {
 override def requires = Web && Javascript
 override def trigger = allRequirements
 override def projectSettings = Seq(...)

 object autoImport {
   lazy val obfuscate = taskKey[Seq[File]]("Obfuscates the source.")
 }
}

Steps for users:

  1. Add dependencies on plugins in project/plugins.sbt as usual with addSbtPlugin
  2. Add key plugins to projects, which will automatically select the plugin + dependent plugin settings to add for those projects.
  3. Exclude plugins, if desired.

For example, given plugins Web and Javascript (perhaps provided by plugins added with addSbtPlugin),

myProject.enablePlugins(Web && Javascript)

will activate MyPlugin defined above and have its settings automatically added. If the user instead defines

myProject.enablePlugins(Web && Javascript).disablePlugins(MyPlugin)

then the MyPlugin settings (and anything that activates only when MyPlugin is activated) will not be added.

Attributes

Graph
Supertypes
class Basic
trait Plugins
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def buildSettings: Seq[Setting[_]]

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

The Setting to add to the build scope for each project that activates this AutoPlugin. The settings returned here are guaranteed to be added to a given build scope only once regardless of how many projects for that build activate this AutoPlugin.

Attributes

def derivedProjects(proj: ProjectDefinition[_]): Seq[Project]

The Projects to add to the current build based on an existing project.

The Projects to add to the current build based on an existing project.

Attributes

def extraProjects: Seq[Project]

The Projects to add to the current build.

The Projects to add to the current build.

Attributes

def globalSettings: Seq[Setting[_]]

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

The Settings to add to the global scope exactly once if any project activates this AutoPlugin.

Attributes

def projectConfigurations: Seq[Configuration]

The Configurations to add to each project that activates this AutoPlugin.

The Configurations to add to each project that activates this AutoPlugin.

Attributes

def projectSettings: Seq[Setting[_]]

The Settings to add in the scope of each project that activates this AutoPlugin.

The Settings to add in the scope of each project that activates this AutoPlugin.

Attributes

def requires: Plugins

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

This AutoPlugin requires the plugins the Plugins matcher returned by this method. See trigger.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def trigger: PluginTrigger

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

Determines whether this AutoPlugin will be activated for this project when the requires clause is satisfied.

When this method returns allRequirements, and requires method returns Web && Javascript, this plugin instance will be added automatically if the Web and Javascript plugins are enabled.

When this method returns noTrigger, and requires method returns Web && Javascript, this plugin instance will be added only if the build user enables it, but it will automatically add both Web and Javascript.

Attributes

Inherited methods

def &&(o: Basic): Plugins

Attributes

Inherited from:
Basic
def allRequirements: PluginTrigger

This plugin is activated when all required plugins are present.

This plugin is activated when all required plugins are present.

Attributes

Inherited from:
PluginsFunctions
def empty: Plugins

Plugins instance that doesn't require any Pluginss.

Plugins instance that doesn't require any Pluginss.

Attributes

Inherited from:
PluginsFunctions
def noTrigger: PluginTrigger

This plugin is activated only when it is manually activated.

This plugin is activated only when it is manually activated.

Attributes

Inherited from:
PluginsFunctions

Concrete fields

val label: String
Generated with