Skip navigation links

com.diffplug.spotless:spotless-plugin-gradle:4.3.1 by DiffPlug

A B C D E F G H I J K L N O P R S T U V X Y 

A

addStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a new step.
addStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
aosp() - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
apply(Project) - Method in class com.diffplug.gradle.spotless.SpotlessPlugin
 
apply(Project) - Method in class com.diffplug.gradle.spotless.SpotlessPluginModern
 
APPLY_DESCRIPTION - Static variable in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 

B

bumpThisNumberIfACustomStepChanges(int) - Method in class com.diffplug.gradle.spotless.FormatExtension
An optional performance optimization if you are using any of the custom or customLazy methods.

C

CHECK_DESCRIPTION - Static variable in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
clearSteps() - Method in class com.diffplug.gradle.spotless.FormatExtension
Clears all of the existing steps.
com.diffplug.gradle.spotless - package com.diffplug.gradle.spotless
 
config(Map<String, Object>) - Method in class com.diffplug.gradle.spotless.FormatExtension.PrettierConfig
 
config(Map<String, Object>) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.CppExtension.EclipseConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.CssExtension.EclipseConfig
Deprecated.
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.FormatExtension.EclipseWtpConfig
 
configFile(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.PrettierConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.GroovyExtension.GrEclipseConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.JavaExtension.EclipseConfig
 
configFile(Object) - Method in class com.diffplug.gradle.spotless.ScalaExtension.ScalaFmtConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.SqlExtension.DBeaverSQLFormatterConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.XmlExtension.EclipseConfig
Deprecated.
 
configure(String, Class<T>, Action<T>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
cpp(Action<CppExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special C/C++-specific extension.
CppExtension - Class in com.diffplug.gradle.spotless
 
CppExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.CppExtension
 
CppExtension.EclipseConfig - Class in com.diffplug.gradle.spotless
 
createFormatTasks(String, FormatExtension) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Creates 3 tasks for the supplied format:
createFormatTasks(String, FormatExtension) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
createFormatTasks(String, FormatExtension) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionModern
 
createIndependentApplyTask(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Creates an independent SpotlessApply for (very) unusual circumstances.
createStep() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
css(Action<CssExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Deprecated.
CssExtension - Class in com.diffplug.gradle.spotless
Deprecated.
CssExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
CssExtension.EclipseConfig - Class in com.diffplug.gradle.spotless
Deprecated.
custom(String, Closure<String>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a custom step.
custom(String, FormatterFunc) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a custom step.
customLazy(String, ThrowingEx.Supplier<FormatterFunc>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds the given custom step, which is constructed lazily for performance reasons.
customLazyGroovy(String, ThrowingEx.Supplier<Closure<String>>) - Method in class com.diffplug.gradle.spotless.FormatExtension

D

dbeaver() - Method in class com.diffplug.gradle.spotless.SqlExtension
 
deletePreviousResult(File) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
delimiter(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 

E

eclipse() - Method in class com.diffplug.gradle.spotless.CppExtension
 
eclipse(String) - Method in class com.diffplug.gradle.spotless.CppExtension
 
eclipse() - Method in class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
eclipse(String) - Method in class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
eclipse() - Method in class com.diffplug.gradle.spotless.JavaExtension
 
eclipse(String) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
eclipse() - Method in class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
eclipse(String) - Method in class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
eclipseFormatFile(Object) - Method in class com.diffplug.gradle.spotless.JavaExtension
Deprecated.
eclipseFormatFile(String, Object) - Method in class com.diffplug.gradle.spotless.JavaExtension
Deprecated.
eclipseWtp(EclipseWtpFormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
eclipseWtp(EclipseWtpFormatterStep, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
encoding(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets encoding to use (defaults to SpotlessExtensionBase.getEncoding()).
encoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Sets encoding to use (defaults to UTF_8).
encoding - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
endWithNewline() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that files end with a single newline.
exceptionPolicy - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
excludeJava() - Method in class com.diffplug.gradle.spotless.GroovyExtension
Excludes .java files, to focus on only .groovy files.
excludeJava(boolean) - Method in class com.diffplug.gradle.spotless.GroovyExtension
Determines whether to exclude .java files, to focus on only .groovy files.

F

filePatterns - Variable in class com.diffplug.gradle.spotless.SpotlessTask
 
format(String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures a custom extension.
FormatExtension - Class in com.diffplug.gradle.spotless
Adds a spotless{Name}Check and spotless{Name}Apply task.
FormatExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.FormatExtension
 
FormatExtension.EclipseWtpConfig - Class in com.diffplug.gradle.spotless
 
FormatExtension.LicenseHeaderConfig - Class in com.diffplug.gradle.spotless
FormatExtension.NpmStepConfig<T extends FormatExtension.NpmStepConfig<?>> - Class in com.diffplug.gradle.spotless
 
FormatExtension.PrettierConfig - Class in com.diffplug.gradle.spotless
 
freshmark(Action<FreshMarkExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special freshmark-specific extension.
FreshMarkExtension - Class in com.diffplug.gradle.spotless
 
FreshMarkExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.FreshMarkExtension
 
fromProject(Project) - Static method in class com.diffplug.gradle.spotless.GradleProvisioner
Deprecated.

G

getApplyTask() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
Deprecated.
internal use only, allows coordination between check and apply when they are in the same build
getEncoding() - Method in class com.diffplug.gradle.spotless.FormatExtension
Returns the encoding to use (defaults to SpotlessExtensionBase.getEncoding().
getEncoding() - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Returns the encoding to use.
getEncoding() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getExceptionPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getExistingStep(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Deprecated.
getExistingStepIdx(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Returns the index of the existing step with the given name, or -1 if no such step exists.
getExtension() - Method in class com.diffplug.gradle.spotless.SpotlessPlugin
Deprecated.
getFilePatterns() - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
getLineEndings() - Method in class com.diffplug.gradle.spotless.FormatExtension
Returns the line endings to use (defaults to SpotlessExtensionBase.getLineEndings().
getLineEndings() - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
getLineEndingsPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getOutputDirectory() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getProject() - Method in class com.diffplug.gradle.spotless.FormatExtension
Returns the project that this extension is attached to.
getRatchetFrom() - Method in class com.diffplug.gradle.spotless.FormatExtension
 
getRatchetFrom() - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
getRatchetSha() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getRootProvisioner() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
getSource() - Method in class com.diffplug.gradle.spotless.SpotlessDiagnoseTask
 
getSpotlessOutDirectory() - Method in class com.diffplug.gradle.spotless.SpotlessApply
 
getSpotlessOutDirectory() - Method in class com.diffplug.gradle.spotless.SpotlessCheck
 
getSteps() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
getSteps() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getTarget() - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
getTarget() - Method in class com.diffplug.gradle.spotless.SpotlessTaskModern
 
getTasks() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
getUnitOutput() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
googleJavaFormat() - Method in class com.diffplug.gradle.spotless.JavaExtension
Uses the google-java-format jar to format source code.
googleJavaFormat(String) - Method in class com.diffplug.gradle.spotless.JavaExtension
Uses the given version of google-java-format to format source code.
GradleProvisioner - Class in com.diffplug.gradle.spotless
Deprecated.
greclipse() - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
greclipse(String) - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
greclipse() - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension
 
greclipse(String) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension
 
groovy(Action<GroovyExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special groovy-specific extension.
GroovyExtension - Class in com.diffplug.gradle.spotless
 
GroovyExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.GroovyExtension
 
GroovyExtension.GrEclipseConfig - Class in com.diffplug.gradle.spotless
 
groovyGradle(Action<GroovyGradleExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special groovy-specific extension for Gradle files.
GroovyGradleExtension - Class in com.diffplug.gradle.spotless
 
GroovyGradleExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.GroovyGradleExtension
 

H

HasBuiltinDelimiterForLicense - Interface in com.diffplug.gradle.spotless
Every FormatExtension has a method license(licenseContent, licenseDelimiter), where licenseDelimiter is a regex that separates the license part of the code from the content.

I

ignoreErrorForPath(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ignores errors for the given relative path.
ignoreErrorForStep(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ignores errors in the given step.
importOrder(List<String>) - Method in class com.diffplug.gradle.spotless.GroovyExtension
Deprecated.
importOrder(String...) - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
importOrder(String...) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension
 
importOrder(List<String>) - Method in class com.diffplug.gradle.spotless.JavaExtension
Deprecated.
importOrder(String...) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension
 
importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
indentWithSpaces(int) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using spaces.
indentWithSpaces() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using spaces.
indentWithTabs(int) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using tabs.
indentWithTabs() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using tabs.
isEnforceCheck() - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Returns true if Gradle’s check task should run spotlessCheck; false otherwise.
isPaddedCell() - Method in class com.diffplug.gradle.spotless.SpotlessTask
Deprecated.

J

java(Action<JavaExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special java-specific extension.
JavaExtension - Class in com.diffplug.gradle.spotless
 
JavaExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.JavaExtension
 
JavaExtension.EclipseConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.GoogleJavaFormatConfig - Class in com.diffplug.gradle.spotless
 

K

kotlin(Action<KotlinExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special kotlin-specific extension.
KotlinExtension - Class in com.diffplug.gradle.spotless
 
KotlinExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.KotlinExtension
 
KotlinExtension.KotlinFormatExtension - Class in com.diffplug.gradle.spotless
 
KotlinExtension.KtfmtConfig - Class in com.diffplug.gradle.spotless
 
kotlinGradle(Action<KotlinGradleExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special Gradle Kotlin DSL specific extension.
KotlinGradleExtension - Class in com.diffplug.gradle.spotless
 
KotlinGradleExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.KotlinGradleExtension
 
KotlinGradleExtension.KotlinFormatExtension - Class in com.diffplug.gradle.spotless
 
KotlinGradleExtension.KtfmtConfig - Class in com.diffplug.gradle.spotless
 
ktfmt() - Method in class com.diffplug.gradle.spotless.KotlinExtension
Uses the ktfmt jar to format source code.
ktfmt(String) - Method in class com.diffplug.gradle.spotless.KotlinExtension
Uses the given version of ktfmt to format source code.
ktfmt() - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
Uses the ktfmt jar to format source code.
ktfmt(String) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
Uses the given version of ktfmt to format source code.
ktlint(String) - Method in class com.diffplug.gradle.spotless.KotlinExtension
Adds the specified version of ktlint.
ktlint() - Method in class com.diffplug.gradle.spotless.KotlinExtension
 
ktlint(String) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
Adds the specified version of ktlint.
ktlint() - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
 

L

licenseHeader(String) - Method in class com.diffplug.gradle.spotless.CppExtension
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
licenseHeader(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
licenseHeader() - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
licenseHeader(String) - Method in interface com.diffplug.gradle.spotless.HasBuiltinDelimiterForLicense
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.KotlinExtension
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
LicenseHeaderConfig(String) - Constructor for class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.CppExtension
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
licenseHeaderFile(Object, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.GroovyExtension
 
licenseHeaderFile(Object) - Method in interface com.diffplug.gradle.spotless.HasBuiltinDelimiterForLicense
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.KotlinExtension
 
licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
lineEndingsPolicy - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 

N

npmExecutable(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmFile - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
NpmStepConfig() - Constructor for class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 

O

outputDirectory - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 

P

paddedCell() - Method in class com.diffplug.gradle.spotless.FormatExtension
Deprecated.
paddedCell(boolean) - Method in class com.diffplug.gradle.spotless.FormatExtension
Deprecated.
parseTarget(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension
FileCollections pass through raw.
performAction() - Method in class com.diffplug.gradle.spotless.SpotlessApply
 
performAction() - Method in class com.diffplug.gradle.spotless.SpotlessCheck
 
performAction() - Method in class com.diffplug.gradle.spotless.SpotlessDiagnoseTask
 
performAction(IncrementalTaskInputs) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
performAction(InputChanges) - Method in class com.diffplug.gradle.spotless.SpotlessTaskModern
 
performActionTest() - Method in class com.diffplug.gradle.spotless.SpotlessCheck
 
prettier() - Method in class com.diffplug.gradle.spotless.FormatExtension
Uses the default version of prettier.
prettier(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Uses the specified version of prettier.
prettier(Map<String, String>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Uses exactly the npm packages specified in the map.
prettier() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses the default version of prettier.
prettier(String) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses the specified version of prettier.
prettier(Map<String, String>) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses exactly the npm packages specified in the map.
processInputFile(Formatter, File) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
properties(Action<Map<String, Object>>) - Method in class com.diffplug.gradle.spotless.FreshMarkExtension
 
propertiesFile(Object...) - Method in class com.diffplug.gradle.spotless.FreshMarkExtension
 
propertyActions - Variable in class com.diffplug.gradle.spotless.FreshMarkExtension
 
provisioner() - Method in class com.diffplug.gradle.spotless.FormatExtension
 

R

ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
RegisterDependenciesTask - Class in com.diffplug.gradle.spotless
NOT AN END-USER TASK, DO NOT USE FOR ANYTHING!
RegisterDependenciesTask() - Constructor for class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
removeFormat(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Makes it possible to remove a format which was created earlier.
removeUnusedImports() - Method in class com.diffplug.gradle.spotless.JavaExtension
Removes any unused imports.
replace(String, CharSequence, CharSequence) - Method in class com.diffplug.gradle.spotless.FormatExtension
Highly efficient find-replace char sequence.
replaceRegex(String, String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Highly efficient find-replace regex.
replaceStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
Replaces the given step.

S

scala(Action<ScalaExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special scala-specific extension.
ScalaExtension - Class in com.diffplug.gradle.spotless
 
ScalaExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.ScalaExtension
 
ScalaExtension.ScalaFmtConfig - Class in com.diffplug.gradle.spotless
 
scalafmt() - Method in class com.diffplug.gradle.spotless.ScalaExtension
 
scalafmt(String) - Method in class com.diffplug.gradle.spotless.ScalaExtension
 
setEncoding(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets the encoding to use (defaults to SpotlessExtensionBase.getEncoding().
setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets the encoding to use (defaults to SpotlessExtensionBase.getEncoding().
setEncoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Sets encoding to use (defaults to UTF_8).
setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Sets encoding to use (defaults to UTF_8).
setEncoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setEnforceCheck(boolean) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures Gradle’s check task to run spotlessCheck if true, but to not do so if false.
setExceptionPolicy(FormatExceptionPolicy) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setFilePatterns(String) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets the line endings to use (defaults to SpotlessExtensionBase.getLineEndings().
setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
setLineEndingsPolicy(LineEnding.Policy) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setPaddedCell(boolean) - Method in class com.diffplug.gradle.spotless.SpotlessTask
Deprecated.
setRatchetFrom(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Allows you to override the value from the parent SpotlessExtensionBase.setRatchetFrom(String) for this specific format.
setRatchetFrom(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Limits the target to only the files which have changed since the given git reference, which is resolved according to this
setSpotlessOutDirectory(File) - Method in class com.diffplug.gradle.spotless.SpotlessApply
 
setSpotlessOutDirectory(File) - Method in class com.diffplug.gradle.spotless.SpotlessCheck
 
setSteps(List<FormatterStep>) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setTarget(Iterable<File>) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setupRatchet(GitRatchet, String) - Method in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.CppExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.CssExtension
Deprecated.
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets up a format task according to the values in this extension.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.FreshMarkExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.GroovyExtension
If the user hasn’t specified the files yet, we’ll assume he/she means all of the groovy files.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.JavaExtension
If the user hasn’t specified the files yet, we’ll assume he/she means all of the java files.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.KotlinExtension
If the user hasn’t specified the files yet, we’ll assume he/she means all of the kotlin files.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.ScalaExtension
If the user hasn’t specified the files yet, we’ll assume he/she means all of the scala files.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.SqlExtension
If the user hasn’t specified the files yet, we’ll assume he/she means all of the sql files.
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
SpotlessApply - Class in com.diffplug.gradle.spotless
 
SpotlessApply() - Constructor for class com.diffplug.gradle.spotless.SpotlessApply
 
SpotlessCheck - Class in com.diffplug.gradle.spotless
 
SpotlessCheck() - Constructor for class com.diffplug.gradle.spotless.SpotlessCheck
 
SpotlessDiagnoseTask - Class in com.diffplug.gradle.spotless
 
SpotlessDiagnoseTask() - Constructor for class com.diffplug.gradle.spotless.SpotlessDiagnoseTask
 
SpotlessExtension - Class in com.diffplug.gradle.spotless
 
SpotlessExtension(Project) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtension
 
SpotlessExtensionBase - Class in com.diffplug.gradle.spotless
 
SpotlessExtensionBase(Project) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
SpotlessExtensionModern - Class in com.diffplug.gradle.spotless
 
SpotlessExtensionModern(Project) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtensionModern
 
SpotlessPlugin - Class in com.diffplug.gradle.spotless
 
SpotlessPlugin() - Constructor for class com.diffplug.gradle.spotless.SpotlessPlugin
 
SpotlessPluginModern - Class in com.diffplug.gradle.spotless
 
SpotlessPluginModern() - Constructor for class com.diffplug.gradle.spotless.SpotlessPluginModern
 
SpotlessTask - Class in com.diffplug.gradle.spotless
 
SpotlessTask() - Constructor for class com.diffplug.gradle.spotless.SpotlessTask
 
SpotlessTaskBase - Class in com.diffplug.gradle.spotless
 
SpotlessTaskBase() - Constructor for class com.diffplug.gradle.spotless.SpotlessTaskBase
 
SpotlessTaskModern - Class in com.diffplug.gradle.spotless
 
SpotlessTaskModern() - Constructor for class com.diffplug.gradle.spotless.SpotlessTaskModern
 
sql(Action<SqlExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special sql-specific extension for SQL files.
SqlExtension - Class in com.diffplug.gradle.spotless
 
SqlExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.SqlExtension
 
SqlExtension.DBeaverSQLFormatterConfig - Class in com.diffplug.gradle.spotless
 
steps - Variable in class com.diffplug.gradle.spotless.FormatExtension
The steps that need to be added.
steps - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
style(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 

T

target - Variable in class com.diffplug.gradle.spotless.FormatExtension
The files to be formatted = (target - targetExclude).
target(Object...) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets which files should be formatted.
target - Variable in class com.diffplug.gradle.spotless.SpotlessTaskBase
 
targetExclude - Variable in class com.diffplug.gradle.spotless.FormatExtension
The files to be formatted = (target - targetExclude).
targetExclude(Object...) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets which files will be excluded from formatting.
TASK_GROUP - Static variable in class com.diffplug.gradle.spotless.SpotlessExtensionBase
 
trimTrailingWhitespace() - Method in class com.diffplug.gradle.spotless.FormatExtension
Removes trailing whitespace.
trivialFunction() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
tsconfigFile(Object) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
tsfmt() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses the default version of typescript-format.
tsfmt(String) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses the specified version of typescript-format.
tsfmt(Map<String, String>) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Creates a TypescriptFormatExtension using exactly the specified npm packages.
tsfmtFile(Object) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
tslintFile(Object) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
typescript(Action<TypescriptExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionBase
Configures the special typescript-specific extension for typescript files.
TypescriptExtension - Class in com.diffplug.gradle.spotless
 
TypescriptExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.TypescriptExtension
 
TypescriptExtension.TypescriptFormatExtension - Class in com.diffplug.gradle.spotless
 
TypescriptExtension.TypescriptPrettierConfig - Class in com.diffplug.gradle.spotless
Overrides the parser to be set to typescript, no matter what the user’s config says.

U

updateYearWithLatest(boolean) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
userData(Map<String, String>) - Method in class com.diffplug.gradle.spotless.KotlinExtension.KotlinFormatExtension
 
userData(Map<String, String>) - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension.KotlinFormatExtension
 

V

vscodeFile(Object) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 

X

xml(Action<XmlExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Deprecated.
XmlExtension - Class in com.diffplug.gradle.spotless
Deprecated.
XmlExtension(SpotlessExtensionBase) - Constructor for class com.diffplug.gradle.spotless.XmlExtension
Deprecated.
 
XmlExtension.EclipseConfig - Class in com.diffplug.gradle.spotless
Deprecated.
 

Y

yearSeparator(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
A B C D E F G H I J K L N O P R S T U V X Y 
Skip navigation links

com.diffplug.spotless:spotless-plugin-gradle:4.3.1 by DiffPlug