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

A

addMutator(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
addMutators(Collection<String>) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
addStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a new step.
addStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
addStep(Function<Provisioner, FormatterStep>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a new step that requires a Provisioner.
addTypeAnnotation(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.FormatAnnotationsConfig
 
AJacksonGradleConfig<T extends AJacksonGradleConfig> - Class in com.diffplug.gradle.spotless
 
AJacksonGradleConfig(JacksonConfig, FormatExtension) - Constructor for class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
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

BaseGroovyExtension - Class in com.diffplug.gradle.spotless
 
BaseGroovyExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.BaseGroovyExtension
 
BaseGroovyExtension.GrEclipseConfig - Class in com.diffplug.gradle.spotless
 
BaseKotlinExtension - Class in com.diffplug.gradle.spotless
 
BaseKotlinExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.BaseKotlinExtension
 
BaseKotlinExtension.DiktatConfig - Class in com.diffplug.gradle.spotless
 
BaseKotlinExtension.KtfmtConfig - Class in com.diffplug.gradle.spotless
 
BaseKotlinExtension.KtfmtConfig.ConfigurableStyle - Class in com.diffplug.gradle.spotless
 
BaseKotlinExtension.KtlintConfig - Class in com.diffplug.gradle.spotless
 
biome() - Method in class com.diffplug.gradle.spotless.FormatExtension
Defaults to downloading the default Biome version from the network.
biome() - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Defaults to downloading the default Biome version from the network.
biome() - Method in class com.diffplug.gradle.spotless.JsonExtension
Defaults to downloading the default Biome version from the network.
biome() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Defaults to downloading the default Biome version from the network.
biome(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Downloads the given Biome version from the network.
biome(String) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Downloads the given Biome version from the network.
biome(String) - Method in class com.diffplug.gradle.spotless.JsonExtension
Downloads the given Biome version from the network.
biome(String) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Downloads the given Biome version from the network.
BiomeGeneric(String) - Constructor for class com.diffplug.gradle.spotless.FormatExtension.BiomeGeneric
Creates a new Rome config that downloads the Rome executable for the given version from the network.
BiomeJs(String) - Constructor for class com.diffplug.gradle.spotless.JavascriptExtension.BiomeJs
Creates a new Biome formatter step config for formatting JavaScript files.
BiomeJson(String) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.BiomeJson
Creates a new Biome formatter step config for formatting JSON files.
BiomeTs(String) - Constructor for class com.diffplug.gradle.spotless.TypescriptExtension.BiomeTs
Creates a new Biome formatter step config for formatting TypeScript files.
black() - Method in class com.diffplug.gradle.spotless.PythonExtension
 
black(String) - Method in class com.diffplug.gradle.spotless.PythonExtension
 
buf() - Method in class com.diffplug.gradle.spotless.ProtobufExtension
 
buf(String) - Method in class com.diffplug.gradle.spotless.ProtobufExtension
Adds the specified version of buf.
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.
cleanthat() - Method in class com.diffplug.gradle.spotless.JavaExtension
Apply CleanThat refactoring rules.
clearMutators() - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
clearSteps() - Method in class com.diffplug.gradle.spotless.FormatExtension
Clears all of the existing steps.
close() - Method in class com.diffplug.gradle.spotless.SpotlessTaskService
 
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.BaseKotlinExtension.DiktatConfig
 
configFile(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.PrettierConfig
 
configFile(Object) - Method in class com.diffplug.gradle.spotless.JavascriptExtension.EslintBaseConfig
 
configFile(Object) - Method in class com.diffplug.gradle.spotless.ScalaExtension.ScalaFmtConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension.GrEclipseConfig
 
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.JavaExtension.EclipseConfig
 
configFile(Object...) - Method in class com.diffplug.gradle.spotless.SqlExtension.DBeaverSQLFormatterConfig
 
configJs(String) - Method in class com.diffplug.gradle.spotless.JavascriptExtension.EslintBaseConfig
 
configPath(Object) - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Optional path to the directory with configuration file for Biome.
ConfigurableStyle() - Constructor for class com.diffplug.gradle.spotless.BaseKotlinExtension.KtfmtConfig.ConfigurableStyle
 
configure(Consumer<KtfmtStep.KtfmtFormattingOptions>) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtfmtConfig.ConfigurableStyle
 
configure(Consumer<KtfmtStep.KtfmtFormattingOptions>) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtfmtConfig
 
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
 
createFormatTasks(String, FormatExtension) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionPredeclare
 
createIndependentApplyTask(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
createIndependentApplyTaskLazy(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Creates an independent SpotlessApply for (very) unusual circumstances.
createLive(String) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
createStep() - Method in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.FormatExtension.PrettierConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.JavascriptEslintConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.JavascriptPrettierConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Creates a new formatter step that formats code by calling the Biome executable, using the current configuration.
createStep() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptEslintConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 
createStep() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptPrettierConfig
 
createStep() - Method in class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
 
custom(String, FormatterFunc) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a custom step.
custom(String, Closure<String>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Adds a custom step.
customRuleSets(List<String>) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtlintConfig
 

D

dbeaver() - Method in class com.diffplug.gradle.spotless.SqlExtension
 
delimiter(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
devDependencies(Map<String, String>) - Method in class com.diffplug.gradle.spotless.JavascriptExtension.EslintBaseConfig
 
diktat() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
 
diktat(String) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
Adds the specified version of diktat.
downloadDir(Object) - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Optional directory where the downloaded Biome executable is placed.
dropboxStyle() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.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
 
editorConfigOverride(Map<String, Object>) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtlintConfig
 
encoding - Variable in class com.diffplug.gradle.spotless.SpotlessTask
 
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(Charset) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Sets encoding to use (defaults to UTF_8).
endWithNewline() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that files end with a single newline.
escapeHtml() - Method in class com.diffplug.gradle.spotless.JsonExtension.GsonConfig
 
eslint() - Method in class com.diffplug.gradle.spotless.JavascriptExtension
 
eslint() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
 
eslint(String) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
 
eslint(String) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
 
eslint(Map<String, String>) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
 
eslint(Map<String, String>) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
 
EslintBaseConfig(Project, Consumer<FormatterStep>, Map<String, String>) - Constructor for class com.diffplug.gradle.spotless.JavascriptExtension.EslintBaseConfig
 
eslintConfig() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.JavascriptEslintConfig
 
eslintConfig() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptEslintConfig
 
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.
excludeMutator(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 

F

feature(String, boolean) - Method in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
flexmark() - Method in class com.diffplug.gradle.spotless.FlexmarkExtension
 
flexmark(String) - Method in class com.diffplug.gradle.spotless.FlexmarkExtension
 
flexmark(Action<FlexmarkExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special flexmark-specific extension.
FlexmarkExtension - Class in com.diffplug.gradle.spotless
 
FlexmarkExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.FlexmarkExtension
 
FlexmarkExtension.FlexmarkFormatterConfig - Class in com.diffplug.gradle.spotless
 
format(String, Class<T>, Action<T>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
format(String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures a custom extension.
formatAnnotations() - Method in class com.diffplug.gradle.spotless.JavaExtension
Removes newlines between type annotations and types.
formatExtension - Variable in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
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.BiomeGeneric - Class in com.diffplug.gradle.spotless
Generic Biome formatter step that detects the language of the input file from the file name.
FormatExtension.ClangFormatConfig - Class in com.diffplug.gradle.spotless
 
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
 
FormatExtension.RomeGeneric - Class in com.diffplug.gradle.spotless
Deprecated.
Rome has transitioned to Biome. This will be removed shortly.
formatJavadoc(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
formatJavadoc(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.PalantirJavaFormatConfig
 
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

getBuildEventsListenerRegistry() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
getDir(File) - Method in class com.diffplug.gradle.spotless.GitRatchetGradle
 
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.SpotlessCheck
 
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.
getFs() - Method in class com.diffplug.gradle.spotless.SpotlessTaskImpl
 
getLanguage() - Method in class com.diffplug.gradle.spotless.FormatExtension.BiomeGeneric
 
getLanguage() - Method in class com.diffplug.gradle.spotless.FormatExtension.RomeGeneric
Deprecated.
 
getLanguage() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.BiomeJs
 
getLanguage() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.RomeJs
Deprecated.
 
getLanguage() - Method in class com.diffplug.gradle.spotless.JsonExtension.BiomeJson
 
getLanguage() - Method in class com.diffplug.gradle.spotless.JsonExtension.RomeJson
Deprecated.
 
getLanguage() - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Gets the language (syntax) of the input files to format.
getLanguage() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.BiomeTs
 
getLanguage() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.RomeTs
Deprecated.
 
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
 
getParent(File) - Method in class com.diffplug.gradle.spotless.GitRatchetGradle
 
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
 
getRunToFixMessage() - Method in class com.diffplug.gradle.spotless.SpotlessCheck
 
getSource() - Method in class com.diffplug.gradle.spotless.SpotlessDiagnoseTask
 
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
 
getTaskService() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
getThis() - Method in class com.diffplug.gradle.spotless.FormatExtension.BiomeGeneric
 
getThis() - Method in class com.diffplug.gradle.spotless.FormatExtension.RomeGeneric
Deprecated.
 
getThis() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.BiomeJs
 
getThis() - Method in class com.diffplug.gradle.spotless.JavascriptExtension.RomeJs
Deprecated.
 
getThis() - Method in class com.diffplug.gradle.spotless.JsonExtension.BiomeJson
 
getThis() - Method in class com.diffplug.gradle.spotless.JsonExtension.RomeJson
Deprecated.
 
getThis() - Method in class com.diffplug.gradle.spotless.RomeStepConfig
 
getThis() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.BiomeTs
 
getThis() - Method in class com.diffplug.gradle.spotless.TypescriptExtension.RomeTs
Deprecated.
 
getUnitOutput() - Method in class com.diffplug.gradle.spotless.RegisterDependenciesTask
 
gherkin(Action<GherkinExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special Gherkin-specific extension.
GherkinExtension - Class in com.diffplug.gradle.spotless
 
GherkinExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.GherkinExtension
 
GherkinExtension.GherkinUtilsConfig - Class in com.diffplug.gradle.spotless
 
gherkinUtils() - Method in class com.diffplug.gradle.spotless.GherkinExtension
 
GherkinUtilsConfig() - Constructor for class com.diffplug.gradle.spotless.GherkinExtension.GherkinUtilsConfig
 
GitRatchetGradle - Class in com.diffplug.gradle.spotless
Gradle implementation of GitRatchet.
GitRatchetGradle() - Constructor for class com.diffplug.gradle.spotless.GitRatchetGradle
 
go(Action<GoExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
GoExtension - Class in com.diffplug.gradle.spotless
 
GoExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.GoExtension
 
GoExtension.GofmtConfig - Class in com.diffplug.gradle.spotless
 
gofmt() - Method in class com.diffplug.gradle.spotless.GoExtension
 
gofmt(String) - Method in class com.diffplug.gradle.spotless.GoExtension
 
GofmtConfig(String) - Constructor for class com.diffplug.gradle.spotless.GoExtension.GofmtConfig
 
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.
googleStyle() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtfmtConfig
 
greclipse() - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension
 
greclipse(String) - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension
 
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
 
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
 
groupArtifact(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
groupArtifact(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
gson() - Method in class com.diffplug.gradle.spotless.JsonExtension
 
GsonConfig() - Constructor for class com.diffplug.gradle.spotless.JsonExtension.GsonConfig
 

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.BaseGroovyExtension
 
importOrder(String...) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension
 
importOrderFile(Object) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
includeDraft(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
indentWithSpaces() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using spaces.
indentWithSpaces(int) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using spaces.
indentWithSpaces(int) - Method in class com.diffplug.gradle.spotless.JsonExtension.GsonConfig
 
indentWithSpaces(int) - Method in class com.diffplug.gradle.spotless.JsonExtension.SimpleConfig
 
indentWithTabs() - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures that the files are indented using tabs.
indentWithTabs(int) - 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.
isLicenseHeaderStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
isScript() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
 
isScript() - Method in class com.diffplug.gradle.spotless.KotlinExtension
 
isScript() - Method in class com.diffplug.gradle.spotless.KotlinGradleExtension
 

J

jackson() - Method in class com.diffplug.gradle.spotless.JsonExtension
 
jackson() - Method in class com.diffplug.gradle.spotless.YamlExtension
 
jacksonConfig - Variable in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
jacksonConfig - Variable in class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
 
jacksonConfig - Variable in class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
 
JacksonJsonGradleConfig(FormatExtension) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
 
JacksonJsonGradleConfig(JacksonJsonConfig, FormatExtension) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
 
JacksonYamlGradleConfig(FormatExtension) - Constructor for class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
 
JacksonYamlGradleConfig(JacksonYamlConfig, FormatExtension) - Constructor for class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
 
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.CleanthatJavaConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.EclipseConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.FormatAnnotationsConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.GoogleJavaFormatConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.ImportOrderConfig - Class in com.diffplug.gradle.spotless
 
JavaExtension.PalantirJavaFormatConfig - Class in com.diffplug.gradle.spotless
 
javascript(Action<JavascriptExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special javascript-specific extension for javascript files.
JavascriptEslintConfig(Map<String, String>) - Constructor for class com.diffplug.gradle.spotless.JavascriptExtension.JavascriptEslintConfig
 
JavascriptExtension - Class in com.diffplug.gradle.spotless
 
JavascriptExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.JavascriptExtension
 
JavascriptExtension.BiomeJs - Class in com.diffplug.gradle.spotless
Biome formatter step for JavaScript.
JavascriptExtension.EslintBaseConfig<T extends JavascriptExtension.EslintBaseConfig<?>> - Class in com.diffplug.gradle.spotless
 
JavascriptExtension.JavascriptEslintConfig - Class in com.diffplug.gradle.spotless
 
JavascriptExtension.JavascriptPrettierConfig - Class in com.diffplug.gradle.spotless
Overrides the parser to be set to a js parser.
JavascriptExtension.RomeJs - Class in com.diffplug.gradle.spotless
Deprecated.
Rome has transitioned to Biome. This will be removed shortly.
json(Action<JsonExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special JSON-specific extension.
JsonExtension - Class in com.diffplug.gradle.spotless
 
JsonExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.JsonExtension
 
JsonExtension.BiomeJson - Class in com.diffplug.gradle.spotless
Biome formatter step for JSON.
JsonExtension.GsonConfig - Class in com.diffplug.gradle.spotless
 
JsonExtension.JacksonJsonGradleConfig - Class in com.diffplug.gradle.spotless
 
JsonExtension.JsonPatchConfig - Class in com.diffplug.gradle.spotless
 
JsonExtension.RomeJson - Class in com.diffplug.gradle.spotless
Deprecated.
Rome has transitioned to Biome. This will be removed shortly.
JsonExtension.SimpleConfig - Class in com.diffplug.gradle.spotless
 
jsonFeature(String, boolean) - Method in class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
Refers to com.fasterxml.jackson.core.JsonGenerator.Feature
jsonPatch(String, List<Map<String, Object>>) - Method in class com.diffplug.gradle.spotless.JsonExtension
 
jsonPatch(List<Map<String, Object>>) - Method in class com.diffplug.gradle.spotless.JsonExtension
 
JsonPatchConfig(String, List<Map<String, Object>>) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.JsonPatchConfig
 
JsonPatchConfig(List<Map<String, Object>>) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.JsonPatchConfig
 

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
 
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
 
kotlinlangStyle() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtfmtConfig
 
ktfmt() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
Uses the ktfmt jar to format source code.
ktfmt(String) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
Uses the given version of ktfmt and applies the dropbox style option to format source code.
ktlint() - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
 
ktlint(String) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension
Adds the specified version of ktlint.

L

language(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.BiomeGeneric
Sets the language (syntax) of the input files to format.
language(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.RomeGeneric
Deprecated.
Sets the language (syntax) of the input files to format.
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.Antlr4Extension
 
licenseHeader(String) - Method in class com.diffplug.gradle.spotless.CppExtension
 
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.ProtobufExtension
 
licenseHeader(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
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) - 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.ProtobufExtension
 
licenseHeaderFile(Object, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
lineEndingsPolicy - Variable in class com.diffplug.gradle.spotless.SpotlessTask
 

M

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

N

NAME - Static variable in class com.diffplug.gradle.spotless.GoExtension
 
named(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
nativeCmd(String, String, List<String>) - Method in class com.diffplug.gradle.spotless.FormatExtension
Ensures formatting of files via native binary.
nodeExecutable(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
noDefaultTargetException() - Method in class com.diffplug.gradle.spotless.FormatExtension
 
nodeFile - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmExecutable(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmFile - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmInstallCache - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmInstallCache() - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmInstallCache(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmrc(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
npmrcFile - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
NpmStepConfig(Project, Consumer<FormatterStep>) - Constructor for class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 

O

onFinish(FinishEvent) - Method in class com.diffplug.gradle.spotless.SpotlessTaskService
 
onlyIfContentMatches(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
outputDirectory - Variable in class com.diffplug.gradle.spotless.SpotlessTask
 

P

palantirJavaFormat() - Method in class com.diffplug.gradle.spotless.JavaExtension
Uses the palantir-java-format jar to format source code.
palantirJavaFormat(String) - Method in class com.diffplug.gradle.spotless.JavaExtension
Uses the given version of palantir-java-format to format source code.
parseTarget(Object) - Method in class com.diffplug.gradle.spotless.FormatExtension
FileCollections pass through raw.
pathToExe(Object) - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Optional path to the Biome executable.
pathToExe(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.ClangFormatConfig
 
pathToExe(String) - Method in class com.diffplug.gradle.spotless.ProtobufExtension.BufFormatExtension
When used in conjunction with the buf-gradle-plugin, the buf executable can be resolved from its bufTool configuration:
pathToExe(String) - Method in class com.diffplug.gradle.spotless.PythonExtension.BlackConfig
 
pathToExe(String) - Method in class com.diffplug.gradle.spotless.ShellExtension.ShfmtExtension
 
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
 
predeclare(GradleProvisioner.Policy) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
predeclare(GradleProvisioner.Policy) - Method in class com.diffplug.gradle.spotless.SpotlessExtensionPredeclare
 
predeclareDeps() - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
predeclareDepsFromBuildscript() - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
prettier() - Method in class com.diffplug.gradle.spotless.FormatExtension
Uses the default version of prettier.
prettier() - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Uses the default version of prettier.
prettier() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses the default version of prettier.
prettier(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Uses the specified version of prettier.
prettier(String) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Uses the specified 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.FormatExtension
Uses exactly the npm packages specified in the map.
prettier(Map<String, String>) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Uses exactly the npm packages specified in the map.
prettier(Map<String, String>) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Uses exactly the npm packages specified in the map.
project - Variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
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
 
protobuf(Action<ProtobufExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special protobuf-specific extension.
ProtobufExtension - Class in com.diffplug.gradle.spotless
 
ProtobufExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.ProtobufExtension
 
ProtobufExtension.BufFormatExtension - Class in com.diffplug.gradle.spotless
 
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 - Variable in class com.diffplug.gradle.spotless.SpotlessTask
Stored so that the configuration cache can recreate the GitRatchetGradle state.
ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
 
ratchetFrom(String) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
 
reflowLongStrings() - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
reflowLongStrings(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
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
 
removeSemicolons() - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension
 
removeTypeAnnotation(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.FormatAnnotationsConfig
 
removeUnusedImports() - Method in class com.diffplug.gradle.spotless.JavaExtension
Removes any unused imports.
removeUnusedImports(String) - Method in class com.diffplug.gradle.spotless.JavaExtension
 
reorderImports(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
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() - Method in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
replaceStep() - Method in class com.diffplug.gradle.spotless.RomeStepConfig
Creates a new Biome step and replaces the existing Biome step in the list of format steps.
replaceStep(FormatterStep) - Method in class com.diffplug.gradle.spotless.FormatExtension
Replaces the given step.
rome() - Method in class com.diffplug.gradle.spotless.FormatExtension
rome() - Method in class com.diffplug.gradle.spotless.JavascriptExtension
Deprecated.
rome() - Method in class com.diffplug.gradle.spotless.JsonExtension
Deprecated.
rome() - Method in class com.diffplug.gradle.spotless.TypescriptExtension
Deprecated.
rome(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
rome(String) - Method in class com.diffplug.gradle.spotless.JavascriptExtension
rome(String) - Method in class com.diffplug.gradle.spotless.JsonExtension
Deprecated.
rome(String) - Method in class com.diffplug.gradle.spotless.TypescriptExtension
RomeGeneric(String) - Constructor for class com.diffplug.gradle.spotless.FormatExtension.RomeGeneric
Deprecated.
Creates a new Rome config that downloads the Rome executable for the given version from the network.
RomeJs(String) - Constructor for class com.diffplug.gradle.spotless.JavascriptExtension.RomeJs
Deprecated.
Creates a new Rome formatter step config for formatting JavaScript files.
RomeJson(String) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.RomeJson
Deprecated.
Creates a new Rome formatter step config for formatting JSON files.
RomeStepConfig<Self extends RomeStepConfig<Self>> - Class in com.diffplug.gradle.spotless
 
RomeStepConfig(Project, Consumer<FormatterStep>, BiomeFlavor, String) - Constructor for class com.diffplug.gradle.spotless.RomeStepConfig
 
RomeTs(String) - Constructor for class com.diffplug.gradle.spotless.TypescriptExtension.RomeTs
Deprecated.
Creates a new Rome formatter step config for formatting TypeScript files.

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
 
scalaMajorVersion(String) - Method in class com.diffplug.gradle.spotless.ScalaExtension.ScalaFmtConfig
 
self() - Method in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
self() - Method in class com.diffplug.gradle.spotless.JsonExtension.JacksonJsonGradleConfig
 
self() - Method in class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
 
semanticSort() - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
semanticSort(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
setEditorConfigPath(Object) - Method in class com.diffplug.gradle.spotless.BaseKotlinExtension.KtlintConfig
 
setEncoding(String) - 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(String) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
setEncoding(Charset) - 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.SpotlessExtension
Sets encoding to use (defaults to UTF_8).
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(Provider<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
setSteps(List<FormatterStep>) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
setTarget(Iterable<File>) - Method in class com.diffplug.gradle.spotless.SpotlessTask
 
setupRatchet(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.FlexmarkExtension
 
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.GherkinExtension
 
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.JavascriptExtension
 
setupTask(SpotlessTask) - Method in class com.diffplug.gradle.spotless.JsonExtension
 
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.ProtobufExtension
If the user hasn't specified files, assume all protobuf files should be checked.
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.ShellExtension
If the user hasn't specified files, assume all shell files should be checked.
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.YamlExtension
 
shell(Action<ShellExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special shell-specific extension.
ShellExtension - Class in com.diffplug.gradle.spotless
 
ShellExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.ShellExtension
 
ShellExtension.ShfmtExtension - Class in com.diffplug.gradle.spotless
 
shfmt() - Method in class com.diffplug.gradle.spotless.ShellExtension
Adds the specified version of shfmt.
shfmt(String) - Method in class com.diffplug.gradle.spotless.ShellExtension
Adds the specified version of shfmt.
simple() - Method in class com.diffplug.gradle.spotless.JsonExtension
 
SimpleConfig(int) - Constructor for class com.diffplug.gradle.spotless.JsonExtension.SimpleConfig
 
skipJavadocFormatting() - Method in class com.diffplug.gradle.spotless.JavaExtension.GoogleJavaFormatConfig
 
skipLinesMatching(String) - Method in class com.diffplug.gradle.spotless.FormatExtension.LicenseHeaderConfig
 
sortByKeys() - Method in class com.diffplug.gradle.spotless.JsonExtension.GsonConfig
 
sourceCompatibility(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
SPOTLESS_NPM_INSTALL_CACHE_DEFAULT_NAME - Static variable in class com.diffplug.gradle.spotless.FormatExtension.NpmStepConfig
 
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
 
SpotlessExtensionPredeclare - Class in com.diffplug.gradle.spotless
 
SpotlessExtensionPredeclare(Project, GradleProvisioner.Policy) - Constructor for class com.diffplug.gradle.spotless.SpotlessExtensionPredeclare
 
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
 
SpotlessTaskService - Class in com.diffplug.gradle.spotless
Allows the check and apply tasks to coordinate with each other (and the source task) to reduce duplicated work (e.g.
SpotlessTaskService() - Constructor for class com.diffplug.gradle.spotless.SpotlessTaskService
 
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
 
style(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.PalantirJavaFormatConfig
 

T

target - Variable in class com.diffplug.gradle.spotless.FormatExtension
The files to be formatted = (target - targetExclude).
target - Variable in class com.diffplug.gradle.spotless.SpotlessTask
 
target(Object...) - Method in class com.diffplug.gradle.spotless.FormatExtension
Sets which files should be formatted.
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.
targetExcludeContentPattern - Variable in class com.diffplug.gradle.spotless.FormatExtension
The value from which files will be excluded if their content contain it.
targetExcludeIfContentContains(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Excludes all files whose content contains string.
targetExcludeIfContentContainsRegex(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Excludes all files whose content contains the given regex.
TASK_GROUP - Static variable in class com.diffplug.gradle.spotless.SpotlessExtension
 
toggleOffOn() - Method in class com.diffplug.gradle.spotless.FormatExtension
Disables formatting between spotless:off and spotless:on.
toggleOffOn(String, String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Disables formatting between the given tags.
toggleOffOnDisable() - Method in class com.diffplug.gradle.spotless.FormatExtension
toggleOffOnRegex(String) - Method in class com.diffplug.gradle.spotless.FormatExtension
Given a regex with *exactly one capturing group*, disables formatting inside that captured group.
treatAsClass(String...) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
treatAsClass(Collection<String>) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
treatAsPackage(String...) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
treatAsPackage(Collection<String>) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
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.TypescriptEslintConfig
 
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.
TypescriptEslintConfig(Map<String, String>) - Constructor for class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptEslintConfig
 
TypescriptExtension - Class in com.diffplug.gradle.spotless
 
TypescriptExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.TypescriptExtension
 
TypescriptExtension.BiomeTs - Class in com.diffplug.gradle.spotless
Biome formatter step for TypeScript.
TypescriptExtension.RomeTs - Class in com.diffplug.gradle.spotless
Deprecated.
Rome has transitioned to Biome. This will be removed shortly.
TypescriptExtension.TypescriptEslintConfig - Class in com.diffplug.gradle.spotless
 
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
 

V

version - Variable in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
version(String) - Method in class com.diffplug.gradle.spotless.AJacksonGradleConfig
 
version(String) - Method in class com.diffplug.gradle.spotless.GherkinExtension.GherkinUtilsConfig
 
version(String) - Method in class com.diffplug.gradle.spotless.JavaExtension.CleanthatJavaConfig
 
version(String) - Method in class com.diffplug.gradle.spotless.JsonExtension.GsonConfig
 
version(String) - Method in class com.diffplug.gradle.spotless.JsonExtension.JsonPatchConfig
 
vscodeFile(Object) - Method in class com.diffplug.gradle.spotless.TypescriptExtension.TypescriptFormatExtension
 

W

wildcardsLast() - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
Sorts wildcard imports after non-wildcard imports, instead of before.
wildcardsLast(boolean) - Method in class com.diffplug.gradle.spotless.JavaExtension.ImportOrderConfig
 
withGoExecutable(String) - Method in class com.diffplug.gradle.spotless.GoExtension.GofmtConfig
 
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.
withinBlocks(String, String, String, Action<FormatExtension>) - Method in class com.diffplug.gradle.spotless.FormatExtension
spotless { format 'examples', { target '*.md' withinBlocks 'javascript examples', '\n```javascript\n', '\n```\n', { prettier().config(['parser': 'javascript']) } ...
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.
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.
withP2Mirrors(Map<String, String>) - Method in class com.diffplug.gradle.spotless.BaseGroovyExtension.GrEclipseConfig
 
withP2Mirrors(Map<String, String>) - Method in class com.diffplug.gradle.spotless.CppExtension.EclipseConfig
 
withP2Mirrors(Map<String, String>) - Method in class com.diffplug.gradle.spotless.JavaExtension.EclipseConfig
 

Y

yaml(Action<YamlExtension>) - Method in class com.diffplug.gradle.spotless.SpotlessExtension
Configures the special YAML-specific extension.
YamlExtension - Class in com.diffplug.gradle.spotless
 
YamlExtension(SpotlessExtension) - Constructor for class com.diffplug.gradle.spotless.YamlExtension
 
YamlExtension.JacksonYamlGradleConfig - Class in com.diffplug.gradle.spotless
 
yamlFeature(String, boolean) - Method in class com.diffplug.gradle.spotless.YamlExtension.JacksonYamlGradleConfig
Refers to com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature
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 
All Classes All Packages