Plugin

org.wartremover.Plugin
See thePlugin companion object
class Plugin extends StandardPlugin, CompilerPluginCompat

Attributes

Companion
object
Graph
Supertypes
trait StandardPlugin
trait Plugin
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def description: String

A one-line description of the plugin

A one-line description of the plugin

Attributes

Definition Classes
Plugin
override def name: String

The name of this plugin

The name of this plugin

Attributes

Definition Classes
Plugin

Inherited methods

final override def initialize(options: List[String])(using context: Context): List[PluginPhase]

Attributes

Definition Classes
Inherited from:
CompilerPluginCompat
def isResearch: Boolean

Is this plugin a research plugin?

Is this plugin a research plugin?

Research plugin receives a phase plan and return a new phase plan, while non-research plugin returns a list of phases to be inserted.

Attributes

Inherited from:
Plugin

Deprecated and Inherited methods

def init(options: List[String]): List[PluginPhase]

Non-research plugins should override this method to return the phases

Non-research plugins should override this method to return the phases

The phases returned must be freshly constructed (not reused and returned again on subsequent calls).

Value parameters

options

commandline options to the plugin.

Attributes

Returns

a list of phases to be added to the phase plan

Deprecated
[Since version Scala 3.5.0]
Inherited from:
StandardPlugin

Inherited fields

val optionsHelp: Option[String]

A description of this plugin's options, suitable as a response to the -help command-line option. Conventionally, the options should be listed with the -P:plugname: part included.

A description of this plugin's options, suitable as a response to the -help command-line option. Conventionally, the options should be listed with the -P:plugname: part included.

Attributes

Inherited from:
Plugin