com.diffplug.gradle.spotless

Class FormatExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

Direct Known Subclasses:

FreshMarkExtension, JavaExtension

public class FormatExtension
extends Object

Adds a `spotless{Name}Check` and `spotless{Name}Apply` task.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected SpotlessExtension	root
protected List<FormatterStep>	steps The steps that need to be added.
protected FileCollection	target The files that need to be formatted.

Constructor Summary

Constructors

Constructor and Description
FormatExtension(String name, SpotlessExtension root)

Method Summary

Modifier and Type	Method and Description
void	custom(String name, groovy.lang.Closure<String> formatter) Adds a custom step.
void	custom(String name, Throwing.Function<String,String> formatter) Adds a custom step.
void	customLazy(String name, Throwing.Supplier<Throwing.Function<String,String>> formatterSupplier) Adds the given custom step, which is constructed lazily for performance reasons.
void	customLazyGroovy(String name, Throwing.Supplier<groovy.lang.Closure<String>> formatterSupplier) Same as customLazy(String, com.diffplug.common.base.Throwing.Supplier), but for Groovy closures.
void	customReplace(String name, CharSequence original, CharSequence after) Highly efficient find-replace char sequence.
void	customReplaceRegex(String name, String regex, String replacement) Highly efficient find-replace regex.
void	endWithNewline() Ensures that files end with a single newline.
protected Project	getProject() Returns the project that this extension is attached to.
void	indentWithSpaces() Ensures that the files are indented using spaces.
void	indentWithSpaces(int tabToSpaces) Ensures that the files are indented using spaces.
void	indentWithTabs() Ensures that the files are indented using tabs.
void	indentWithTabs(int tabToSpaces) Ensures that the files are indented using tabs.
void	licenseHeader(String licenseHeader, String delimiter)
void	licenseHeaderFile(Object licenseHeaderFile, String delimiter)
protected FileCollection	parseTarget(Object target)
protected void	setupTask(FormatTask task) Sets up a FormatTask according to the values in this extension.
void	target(Object... targets) FileCollections pass through raw.
void	trimTrailingWhitespace() Removes trailing whitespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected final String name

root

protected final SpotlessExtension root

target

protected FileCollection target

The files that need to be formatted.

steps

protected List<FormatterStep> steps

The steps that need to be added.

Constructor Detail

FormatExtension

public FormatExtension(String name,
                       SpotlessExtension root)

Method Detail

target

public void target(Object... targets)

FileCollections pass through raw. Strings are treated as the 'include' arg to fileTree, with project.rootDir as the dir. List are treates as the 'includes' arg to fileTree, with project.rootDir as the dir. Anything else gets passed to getProject().files().

parseTarget

protected FileCollection parseTarget(Object target)

customLazy

public void customLazy(String name,
                       Throwing.Supplier<Throwing.Function<String,String>> formatterSupplier)

Adds the given custom step, which is constructed lazily for performance reasons. The resulting function will receive a string with unix-newlines, and it must return a string unix newlines. If you're getting errors about `closure cannot be cast to com.diffplug.common.base.Throwing$Function`, then use customLazyGroovy(String, com.diffplug.common.base.Throwing.Supplier).

customLazyGroovy

public void customLazyGroovy(String name,
                             Throwing.Supplier<groovy.lang.Closure<String>> formatterSupplier)

Same as customLazy(String, com.diffplug.common.base.Throwing.Supplier), but for Groovy closures.

custom

public void custom(String name,
                   groovy.lang.Closure<String> formatter)

Adds a custom step. Receives a string with unix-newlines, must return a string with unix newlines.

custom

public void custom(String name,
                   Throwing.Function<String,String> formatter)

Adds a custom step. Receives a string with unix-newlines, must return a string with unix newlines.

customReplace

public void customReplace(String name,
                          CharSequence original,
                          CharSequence after)

Highly efficient find-replace char sequence.

customReplaceRegex

public void customReplaceRegex(String name,
                               String regex,
                               String replacement)

Highly efficient find-replace regex.

trimTrailingWhitespace

public void trimTrailingWhitespace()

Removes trailing whitespace.

endWithNewline

public void endWithNewline()

Ensures that files end with a single newline.

indentWithSpaces

public void indentWithSpaces(int tabToSpaces)

Ensures that the files are indented using spaces.

indentWithSpaces

public void indentWithSpaces()

Ensures that the files are indented using spaces.

indentWithTabs

public void indentWithTabs(int tabToSpaces)

Ensures that the files are indented using tabs.

indentWithTabs

public void indentWithTabs()

Ensures that the files are indented using tabs.

licenseHeader

public void licenseHeader(String licenseHeader,
                          String delimiter)

Parameters:

licenseHeader - Content that should be at the top of every file

delimiter - Spotless will look for a line that starts with this to know what the "top" is.

licenseHeaderFile

public void licenseHeaderFile(Object licenseHeaderFile,
                              String delimiter)

Parameters:

licenseHeaderFile - Content that should be at the top of every file

delimiter - Spotless will look for a line that starts with this to know what the "top" is.

setupTask

protected void setupTask(FormatTask task)
                  throws Exception

Sets up a FormatTask according to the values in this extension.

Throws:

Exception

getProject

protected Project getProject()

Returns the project that this extension is attached to.