mill.scalalib.spotless.Format
See theFormat companion object
@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 */")
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
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Members list
In this article