Mill
API
Generated with
Mill/mill/mill.javalib/mill.javalib.spotless/SpotlessWorker

SpotlessWorker

mill.javalib.spotless.SpotlessWorker
trait SpotlessWorker extends AutoCloseable

Attributes

Source
SpotlessWorker.scala
Graph
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def format(check: Boolean)(using Log): Unit

Checks/fixes formatting in module files.

Checks/fixes formatting in module files.

Value parameters

check

If set, an error is raised on format errors. Otherwise, formatting is fixed.

Attributes

Source
SpotlessWorker.scala
def provision(using Log): Seq[PathRef]

Resolves and returns artifacts required for formatting.

Resolves and returns artifacts required for formatting.

Attributes

Source
SpotlessWorker.scala
def ratchet(check: Boolean, staged: Boolean, from: String, to: Option[String])(using Log & Workspace): Unit

Checks/fixes formatting in files that differ in 2 Git trees.

Checks/fixes formatting in files that differ in 2 Git trees.

Value parameters

check

If set, an error is raised on format errors. Otherwise, formatting is fixed.

from

Revision to compare against.

to

Revision to compare. When empty, - index tree is used, if staged is set - working tree is used, otherwise

Attributes

Source
SpotlessWorker.scala

Inherited and Abstract methods

def close(): Unit

Attributes

Inherited from:
AutoCloseable
Generated with