Mill
API
Generated with
Mill/mill/mill.scalalib/mill.scalalib.spotless

mill.scalalib.spotless

package mill.scalalib.spotless

Members list

Type members

Classlikes

@Scaladoc(value = "/**\n * A specification for selecting files and the corresponding format steps to be applied.\n * @param steps Format steps to apply.\n * @param includes Path matcher patterns for files to format.\n * @param excludes Path matcher patterns for files to exclude from formatting.\n * @param lineEnding Name of line endings in files.\n * @param encoding Name of charset used for encoding files.\n * @param suppressions Lints to suppress.\n * @note Use with [[Format.RelPathRef.withDynamicRoot]] to configure any relative references.\n * @see\n * - [[https://github.com/diffplug/spotless/blob/main/lib/src/main/java/com/diffplug/spotless/Formatter.java Formatter]]\n * - [[https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String) Path matcher pattern]]\n * - [[https://github.com/diffplug/spotless/tree/main/plugin-gradle#line-endings-and-encodings-invisible-stuff Line endings and encodings]]\n */")
case class Format(steps: Seq[Step], includes: Seq[String], excludes: Seq[String], lineEnding: String, encoding: String, suppressions: Seq[Suppress])

A specification for selecting files and the corresponding format steps to be applied.

A specification for selecting files and the corresponding format steps to be applied.

Value parameters

encoding

Name of charset used for encoding files.

excludes

Path matcher patterns for files to exclude from formatting.

includes

Path matcher patterns for files to format.

lineEnding

Name of line endings in files.

steps

Format steps to apply.

suppressions

Lints to suppress.

Attributes

See also
Note

Use with Format.RelPathRef.withDynamicRoot to configure any relative references.

Companion
object
Source
Format.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Format

Attributes

Companion
class
Source
Format.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Format.type
@Scaladoc(value = "/**\n * Enables formatting files using [[https://github.com/diffplug/spotless Spotless]].\n * @note Any third party artifacts required by Spotless are resolved using [[defaultResolver]]\n * as \"runtime\" dependencies.\n * @see\n * - [[spotlessFormats]]\n * - [[spotless]]\n * - [[ratchet]]\n */")
trait SpotlessModule extends CoursierModule, OfflineSupportModule

Enables formatting files using Spotless.

Enables formatting files using Spotless.

Attributes

See also
Note

Any third party artifacts required by Spotless are resolved using defaultResolver as "runtime" dependencies.

Companion
object
Source
SpotlessModule.scala
Supertypes
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
object SpotlessModule extends ExternalModule, TaskModule, SpotlessModule

Attributes

Companion
trait
Source
SpotlessModule.scala
Supertypes
trait TaskModule
class BaseModule
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type
trait SpotlessWorker extends AutoCloseable

Attributes

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

Value members

Inherited fields

val value: ExternalModule

Attributes

Inherited from:
Alias
Source
ExternalModule.scala
Generated with