All Classes and Interfaces
Class
Description
Settings and constants for Biome to use.
formatter step that formats JavaScript and TypeScript code with Biome:
https://github.com/biomejs/biome.
Enables CleanThat as a SpotLess step.
Gradle requires three things:
- Gradle defines cache equality based on your serialized representation
- Combined with remote build cache, you cannot have any absolute paths in
your serialized representation
- Combined with configuration cache, you must be able to roundtrip yourself
through serialization
These requirements are at odds with each other, as described in these issues
- Gradle issue to define custom equality
https://github.com/gradle/gradle/issues/29816
- Spotless plea for developer cache instead of configuration cache
https://github.com/diffplug/spotless/issues/987
- Spotless cache miss bug fixed by this class
https://github.com/diffplug/spotless/issues/2168
This class is a `List` which can optimize the
serialized representation for either
- roundtrip integrity
- OR
- equality
Because it is not possible to provide both at the same time.
Common utilities for C/C++
**Warning:** Use this class at your own risk.
SQL formatter step which wraps up DBeaver's SqlTokenizedFormatter implementation.
Wraps up diktat as a FormatterStep.
The clean/dirty state of a single file.
Computes a signature for any needed files.
A view of `FileSignature` which can be safely roundtripped.
A step for flexmark-java.
Forbids any wildcard import statements.
Finds a foreign executable and checks its version.
Some formatters put every annotation on its own line
-- even type annotations, which should be on the same line as the type they qualify.
Formatter which performs the full formatting.
A
Function<String, String> which can throw an exception.Function<String, String> and BiFunction<String, File, String> whose implementation
requires a resource which should be released when the function is no longer needed.Utility manages settings of formatter configured by properties.
An implementation of this class specifies a single step in a formatting process.
A step for FreshMark.
Abstract class responsible for installing a Git pre-push hook in a repository.
Implementation of
GitPrePushHookInstaller specifically for Gradle-based projects.Implementation of
GitPrePushHookInstaller specifically for Maven-based projects.Note: gofmt doesn't have a version flag, because it's part of standard Go distribution.
Wraps up google-java-format as a FormatterStep.
Simple step which checks for consistent indentation characters.
Signifies that a
public API is actually an implementation detail, and should be treated as if it
were private.A DTO holding the basic for Jackson-based formatters
Specialization of
JacksonConfig for JSON documentsSimple YAML formatter which reformats the file according to Jackson YAMLFactory.
Specialization of
JacksonConfig for YAML documentsSimple YAML formatter which reformats the file according to Jackson YAMLFactory.
Grabs a jar and its dependencies from maven,
and makes it easy to access the collection in
a classloader.
A lazily evaluated JarState, which becomes a set of files when serialized.
Simple JSON formatter which reformats the file according to the org.json library's default pretty-printing, but has no ability to customise more than the indentation size.
Java virtual machine helper
Utility to map constraints of formatter to this JVM
Wraps up ktfmt as a FormatterStep.
Used to allow multiple style option through formatting options and since when is each of them available.
Wraps up ktlint as a FormatterStep.
This is a utility class to allow for lazy evaluation of arguments to be passed to a logger
and thus avoid unnecessary computation of the arguments if the log level is not enabled.
Implements equality, hashcode, and serialization entirely in terms
of lazily-computed state.
Prefixes a license header before the package statement.
Represents the line endings which should be written by the tool.
A policy for line endings which can vary based on the specific file being requested.
Models a linted line or line range.
Any exception which implements this interface will have its lints extracted and reported cleanly to the user.
Marker interface to prevent lambda implementations of
single-method interfaces that require serializability.
An implementation of NoLambda in which equality is based on the serialized representation of itself.
Enum to make boolean logic more readable.
The kind of result.
Wraps up palantir-java-format fork of
google-java-format as a FormatterStep.
Shelling out to a process is harder than it ought to be in Java.
Many spotless steps require third-party libraries, but we want to keep
Spotless' dependencies minimal.
Removes all semicolons from the end of lines.
Uses google-java-format or cleanthat.UnnecessaryImport, but only to remove unused imports.
Wraps up scalafmt as a FormatterStep.
A file filter with full support for serialization.
This step is a flag which marks that `ConfigurationCacheHackList` should
serialize each item individually into `byte[]` array, rather than using normal
serialization.
Spotless' global cache.
**Warning:** Use this class at your own risk.
These FormatterStep are meant to be used for testing only.
Basic functional interfaces which throw exception, along with
static helper methods for calling them.
A bi-function that can throw any exception.
A function that can throw any exception.
A runnable that can throw any exception.
A supplier that can throw any exception.
A RuntimeException specifically for the purpose of wrapping non-runtime Exceptions as RuntimeExceptions.