A B C D E F G H I J K L M N O P R S T U V W 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.SpotlessTask

antlr4(Action<Antlr4Extension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special antlr4-specific extension for antlr4 files.

Antlr4Extension - Class in com.diffplug.gradle.spotless

Antlr4Extension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.Antlr4Extension

Antlr4Extension.Antlr4FormatterConfig - Class in com.diffplug.gradle.spotless

antlr4Formatter() - Method in class com.diffplug.gradle.spotless.Antlr4Extension

antlr4Formatter(String) - Method in class com.diffplug.gradle.spotless.Antlr4Extension

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.SpotlessPluginRedirect

APPLY_DESCRIPTION - Static variable in class com.diffplug.gradle.spotless.SpotlessExtension

B

black() - Method in class com.diffplug.gradle.spotless.PythonExtension

black(String) - Method in class com.diffplug.gradle.spotless.PythonExtension

bumpThisNumberIfACustomStepChanges(int) - Method in class com.diffplug.gradle.spotless.FormatExtension

An optional performance optimization if you are using any of the custom methods.

C

CHECK_DESCRIPTION - Static variable in class com.diffplug.gradle.spotless.SpotlessExtension

clangFormat() - Method in class com.diffplug.gradle.spotless.FormatExtension

Uses the default version of clang-format.

clangFormat(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Uses the specified version of clang-format.

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.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

cpp(Action<CppExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special C/C++-specific extension.

CppExtension - Class in com.diffplug.gradle.spotless

CppExtension(SpotlessExtension) - 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

createFormatTasks(String, FormatExtension) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionImpl

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

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.

D

dbeaver() - Method in class com.diffplug.gradle.spotless.SqlExtension

delimiter(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig

dropboxStyle() - Method in class com.diffplug.gradle.spotless.KotlinExtension.KtfmtConfig

dropboxStyle() - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension.KtfmtConfig

E

eclipse() - Method in class com.diffplug.gradle.spotless.JavaExtension

eclipse(String) - Method in class com.diffplug.gradle.spotless.JavaExtension

eclipseCdt() - Method in class com.diffplug.gradle.spotless.CppExtension

eclipseCdt(String) - Method in class com.diffplug.gradle.spotless.CppExtension

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 SpotlessExtension.getEncoding()).

encoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

encoding - Variable in class com.diffplug.gradle.spotless.SpotlessTask

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.SpotlessTask

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

format(String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures a custom extension.

format(String, Class<T>, Action<T>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

FormatExtension - Class in com.diffplug.gradle.spotless

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

FormatExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.FormatExtension

FormatExtension.ClangFormatConfig - Class in com.diffplug.gradle.spotless

FormatExtension.EclipseWtpConfig - Class in com.diffplug.gradle.spotless

FormatExtension.LicenseHeaderConfig - Class in com.diffplug.gradle.spotless

Created by FormatExtension.licenseHeader(String, String) or FormatExtension.licenseHeaderFile(Object, String).

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.SpotlessExtension

Configures the special freshmark-specific extension.

FreshMarkExtension - Class in com.diffplug.gradle.spotless

FreshMarkExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.FreshMarkExtension

G

getEncoding() - Method in class com.diffplug.gradle.spotless.FormatExtension

Returns the encoding to use (defaults to SpotlessExtension.getEncoding().

getEncoding() - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Returns the encoding to use.

getEncoding() - Method in class com.diffplug.gradle.spotless.SpotlessTask

getExceptionPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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.

getLineEndings() - Method in class com.diffplug.gradle.spotless.FormatExtension

Returns the line endings to use (defaults to SpotlessExtension.getLineEndings().

getLineEndings() - Method in class com.diffplug.gradle.spotless.SpotlessExtension

getLineEndingsPolicy() - Method in class com.diffplug.gradle.spotless.SpotlessTask

getOutputDirectory() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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.SpotlessExtension

getRatchetSha() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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.SpotlessTask

getTarget() - Method in class com.diffplug.gradle.spotless.SpotlessTask

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.

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.SpotlessExtension

Configures the special groovy-specific extension.

GroovyExtension - Class in com.diffplug.gradle.spotless

GroovyExtension(SpotlessExtension) - 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.SpotlessExtension

Configures the special groovy-specific extension for Gradle files.

GroovyGradleExtension - Class in com.diffplug.gradle.spotless

GroovyGradleExtension(SpotlessExtension) - 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(String...) - Method in class com.diffplug.gradle.spotless.GroovyExtension

importOrder(String...) - Method in class com.diffplug.gradle.spotless.GroovyGradleExtension

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.SpotlessExtension

Returns true if Gradle’s check task should run spotlessCheck; false otherwise.

J

java(Action<JavaExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special java-specific extension.

JavaExtension - Class in com.diffplug.gradle.spotless

JavaExtension(SpotlessExtension) - 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.SpotlessExtension

Configures the special kotlin-specific extension.

KotlinExtension - Class in com.diffplug.gradle.spotless

KotlinExtension(SpotlessExtension) - 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.SpotlessExtension

Configures the special Gradle Kotlin DSL specific extension.

KotlinGradleExtension - Class in com.diffplug.gradle.spotless

KotlinGradleExtension(SpotlessExtension) - 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 and applies the dropbox style option 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.Antlr4Extension

licenseHeader(String) - Method in class com.diffplug.gradle.spotless.CppExtension

licenseHeader(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension

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

LicenseHeaderConfig(LicenseHeaderStep) - Constructor for class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig

licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.Antlr4Extension

licenseHeaderFile(Object) - Method in class com.diffplug.gradle.spotless.CppExtension

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

lineEndingsPolicy - Variable in class com.diffplug.gradle.spotless.SpotlessTask

M

maybeCreate(String, Class<T>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

N

noDefaultTargetException() - Method in class com.diffplug.gradle.spotless.FormatExtension

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.SpotlessTask

P

parseTarget(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension

FileCollections pass through raw.

pathToExe(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.ClangFormatConfig

pathToExe(String) - Method in class com.diffplug.gradle.spotless.PythonExtension.BlackConfig

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(InputChanges) - Method in class com.diffplug.gradle.spotless.SpotlessTaskImpl

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.

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

python(Action<PythonExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special python-specific extension for python files.

PythonExtension - Class in com.diffplug.gradle.spotless

PythonExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.PythonExtension

PythonExtension.BlackConfig - Class in com.diffplug.gradle.spotless

R

ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

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.SpotlessExtension

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.SpotlessExtension

Configures the special scala-specific extension.

ScalaExtension - Class in com.diffplug.gradle.spotless

ScalaExtension(SpotlessExtension) - 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 SpotlessExtension.getEncoding().

setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets the encoding to use (defaults to SpotlessExtension.getEncoding().

setEncoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

setEncoding(Charset) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Sets encoding to use (defaults to UTF_8).

setEncoding(String) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setEnforceCheck(boolean) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

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.SpotlessTask

setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.FormatExtension

Sets the line endings to use (defaults to SpotlessExtension.getLineEndings().

setLineEndings(LineEnding) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

setLineEndingsPolicy(LineEnding.Policy) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setRatchetFrom(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Allows you to override the value from the parent SpotlessExtension.setRatchetFrom(String) for this specific format.

setRatchetFrom(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

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.SpotlessTask

setTarget(Iterable<File>) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setupRatchet(GitRatchetGradle, String) - Method in class com.diffplug.gradle.spotless.SpotlessTask

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.Antlr4Extension

setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.CppExtension

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.PythonExtension

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

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

SpotlessExtensionImpl - Class in com.diffplug.gradle.spotless

SpotlessExtensionImpl(Project) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtensionImpl

SpotlessPlugin - Class in com.diffplug.gradle.spotless

SpotlessPlugin() - Constructor for class com.diffplug.gradle.spotless.SpotlessPlugin

SpotlessPluginRedirect - Class in com.diffplug.gradle.spotless

SpotlessPluginRedirect() - Constructor for class com.diffplug.gradle.spotless.SpotlessPluginRedirect

SpotlessTask - Class in com.diffplug.gradle.spotless

SpotlessTask() - Constructor for class com.diffplug.gradle.spotless.SpotlessTask

SpotlessTaskImpl - Class in com.diffplug.gradle.spotless

SpotlessTaskImpl() - Constructor for class com.diffplug.gradle.spotless.SpotlessTaskImpl

sql(Action<SqlExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension

Configures the special sql-specific extension for SQL files.

SqlExtension - Class in com.diffplug.gradle.spotless

SqlExtension(SpotlessExtension) - 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.SpotlessTask

style(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.ClangFormatConfig

Any of: LLVM, Google, Chromium, Mozilla, WebKit.

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.SpotlessTask

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.SpotlessExtension

toggleOffOn(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Disables formatting between the given tags.

toggleOffOn() - Method in class com.diffplug.gradle.spotless.FormatExtension

Disables formatting between spotless:off and spotless:on.

toggleOffOnDisable() - Method in class com.diffplug.gradle.spotless.FormatExtension

Undoes all previous calls to FormatExtension.toggleOffOn() and FormatExtension.toggleOffOn(String, String).

toggleOffOnRegex(String) - Method in class com.diffplug.gradle.spotless.FormatExtension

Given a regex with exactly one capturing group, disables formatting inside that captured group.

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.SpotlessExtension

Configures the special typescript-specific extension for typescript files.

TypescriptExtension - Class in com.diffplug.gradle.spotless

TypescriptExtension(SpotlessExtension) - 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

W

withinBlocks(String, String, String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.FormatExtension

spotless { format 'examples', { target 'src/**\/*.md' withinBlocks 'javascript examples', '\n```javascript\n', '\n```\n`, { prettier().config(['parser': 'javascript']) } ...

withinBlocks(String, String, String, Class<T>, Action<T>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Same as FormatExtension.withinBlocks(String, String, String, Action), except you can specify any language-specific subclass of FormatExtension to get language-specific steps.

withinBlocksRegex(String, String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Same as FormatExtension.withinBlocks(String, String, String, Action), except instead of an open/close pair, you specify a regex with exactly one capturing group.

withinBlocksRegex(String, String, Class<T>, Action<T>) - Method in class com.diffplug.gradle.spotless.FormatExtension

Same as FormatExtension.withinBlocksRegex(String, String, Action), except you can specify any language-specific subclass of FormatExtension to get language-specific steps.

Y

yearSeparator(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig

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