If you are a Spotless user (as opposed to developer), then you are probably looking for:
This document is intended for Spotless developers.
We adhere to the keepachangelog format (starting after version 1.27.0
).
- Bump ktfmt to 0.21 and add support to Google and Kotlinlang formats (#812)
- Allow licence headers to be blank (#801).
- Support for diktat (#789)
- Added support for
eclipse-cdt
,eclipse-jdt
, andeclipse-wtp
at4.18.0
.
- Bump
eclipse-jdt
default version from4.17.0
to4.18.0
. - Bump
eclipse-wtp
default version from4.17.0
to4.18.0
. - Bump
ktfmt
default version from0.16
to0.19
(#748 and #773). - Bump
jgit
from5.9
to5.10
(#773).
- Fixed
ratchetFrom
support for git-submodule (#746). - Fixed
ratchetFrom
excess memory consumption (#735). ktfmt
v0.19+ with dropbox-style works again (#765).prettier
no longer throws errors on empty files (#751).- Fixed error when running on root of windows mountpoint (#760).
- Fixed typo in javadoc comment for SQL_FORMATTER_INDENT_TYPE (#753).
- Fixed a bug which occurred if the root directory of the project was also the filesystem root (#732)
- Bump JGit from
5.8.0
to5.9.0
to improve performance (#726)
- Added support to npm-based steps for picking up
.npmrc
files (#727)
- Added support for eclipse-cdt 4.14.0, 4.16.0 and 4.17.0 (#722).
- Added support for eclipse-groovy 4.14.0, 4.15.0, 4.16.0 and 4.17.0 (#722).
- Added support for eclipse-jdt 4.17.0 (#722).
- Added support for eclipse-wtp 4.14.0, 4.15.0, 4.16.0 and 4.17.0 (#722).
- Updated default eclipse-cdt from 4.13.0 to 4.16.0 (#722). Note that version 4.17.0 is supported, but requires Java 11 or higher.
- Updated default eclipse-groovy from 4.13.0 to 4.17.0 (#722).
- Updated default eclipse-jdt from 4.16.0 to 4.17.0 (#722).
- Updated default eclipse-wtp from 4.13.0 to 4.17.0 (#722).
- Exposed new methods in
GitRatchet
to support faster ratcheting in the maven plugin (#706).
PipeStepPair.Builder
now has a method.buildStepWhichAppliesSubSteps(Path rootPath, Collection<FormatterStep> steps)
, which returns a singleFormatterStep
that applies the given steps within the regex defined earlier in the builder. Used for formatting inception (implements #412).
- Don't assume that file content passed into Prettier is at least 50 characters (diffplug#699).
- Improved JRE parsing to handle strings like
16-loom
(fixes #693).
PipeStepPair
which allows extracting blocks of text in one step, then injecting those blocks back in later. Currently only used forspotless:off
spotless:on
, but could also be used to apply different steps in different places (#691).
- When applying license headers for the first time, we are now more lenient about parsing existing years from the header (#690).
GoogleJavaFormatStep.defaultVersion()
now returns1.9
on JDK 11+, while continuing to return1.7
on earlier JDKs. This is especially helpful toRemoveUnusedImportsStep
, since it always uses the default version of GJF (fixes #681).
- We now run all tests against JDK 8, JDK 11, and also JDK 14 (#684).
- We had test files in
testlib/src/main/resources
namedmodule-info.java
andpackage-info.java
. They cause problems for the Eclipse IDE trying to interpret them literally. Added.test
suffix to the filenames so that eclipse doesn't barf on them anymore (#683).
- Added support for eclipse-jdt 4.14.0, 4.15.0 and 4.16.0 (#678).
- Updated default eclipse-jdt from 4.13.0 to 4.16.0 (#678).
- The ability to shell out to formatters with their own executables. (#672)
ProcessRunner
makes it easy to efficiently and debuggably call foreign executables, and pipe their stdout and stderr to strings.ForeignExe
finds executables on the path (or other strategies), and confirms that they have the correct version (to facilitate Spotless' caching). If the executable is not present or the wrong version, it points the user towards how to fix the problem.- These classes were used to add support for python black and clang-format.
- Incidental to this effort,
FormatterFunc.Closeable
now has new methods which make resource-handling safer. The old method is still available asofDangerous
, but it should not be used outside of a testing situation. There are some legacy usages ofofDangerous
in the codebase, and it would be nice to fix them, but the existing usages are using it safely.
KtLintStep
is now more robust when parsing version string for version-dependent implementation details, fixes #668.
FormatterFunc.Closeable
had a "use after free" bug which caused errors in the npm-based formatters (e.g. prettier) ifspotlessCheck
was called on dirty files. (#651)
- Bump default ktfmt from
0.15
to0.16
, and remove duplicated logic for the--dropbox-style
option (#642)
- Bump default ktfmt from 0.13 to 0.15, and add support for the --dropbox-style option (#641).
FileSignature.machineIsWin()
, to replace the now-deprecatedLineEnding.nativeIsWin()
, because it turns out that\r\n
is not a reliable way to detect the windows OS (#639).
GitAttributesLineEndings
was fatally broken (always returned platform default), and our tests missed it because they tested the part before the broken part (#639).
LineEnding.GIT_ATTRIBUTES
now creates a policy whose serialized state can be relocated from one machine to another. No user-visible change, but paves the way for remote build cache support in Gradle. (#621)
prettier
will now autodetect the parser (and formatter) to use based on the filename, unless you override this usingconfig
orconfigFile
with the optionparser
orfilepath
. (#620)GitRatchet
now lives inlib-extra
, and is shared acrossplugin-gradle
andplugin-maven
(#626).- Added ANTLR4 support (#326).
FormatterFunc.NeedsFile
for implementing file-based formatters more cleanly than we have so far (#637).
- BREAKING
FileSignature
can no longer sign folders, only files. Signatures are now based only on filename (not path), size, and a content hash. It throws an error if a signature is attempted on a folder or on multiple files with different paths but the same filename - it never breaks silently. This change does not break any of Spotless' internal logic, so it is unlikely to affect any of Spotless' consumers either. (#571) - BREAKING
FormatterFunc
no longerextends ThrowingEx.Function
andBiFunction
. In a major win for Java's idea of "target typing", this required no changes anywhere in the codebase except deleting theextends
part ofFormatterFunc
(#638). - BREAKING Heavy refactor of the
LicenseHeaderStep
public API. Doesn't change internal behavior, but makes implementation of the gradle and maven plugins much easier. (#628) - BREAKING Removed all deprecated methods and classes from
lib
andlib-extra
.
- Nodejs-based formatters
prettier
andtsfmt
now use native node instead of the J2V8 approach. (#606)- This removes the dependency to the no-longer-maintained Linux/Windows/macOs variants of J2V8.
- This enables spotless to use the latest
prettier
versions (instead of being stuck at prettier version <=1.19.0
) - Bumped default versions, prettier
1.16.4
->2.0.5
, tslint5.12.1
->6.1.2
- Our main branch is now called
main
. (#613)
LicenseHeaderStep.setLicenseHeaderYearsFromGitHistory
, which does an expensive search through git history to determine the oldest and newest commits for each file, and uses that to determine license header years. (#604)
- We are now running CI on windows. (#596)
- We are now dogfooding
ratchetFrom
andlicenseHeader
with a$YEAR
token to ensure that Spotless copyright headers stay up-to-date without adding noise to file history. (#595) - Added
LineEnding.nativeIsWin()
,FileSignature.pathNativeToUnix()
, andFileSignature.pathUnixToNative()
, along with many API-invisible fixes and cleanup. (#592)
LicenseHeaderStep
now has anupdateYearWithLatest
parameter which can update copyright headers to today's date. (#593)- Parsing of existing years from headers is now more lenient.
- The
LicenseHeaderStep
constructor is now public, which allows capturing its state lazily, which is helpful for setting defaults based onratchetFrom
.
NodeJsGlobal.setSharedLibFolder
allows to set the location of nodejs shared libs. (#586)PaddedCell.isClean()
returns the instance ofPaddedCell.DirtyState
which represents clean. (#590)
- Previously, the nodejs-based steps would throw
UnsatisfiedLinkError
if they were ever used from more than one classloader. Now they can be used from any number of classloaders (important for gradle build daemon). (#586)
PaddedCell.calculateDirtyState
is now defensive about misconfigured character encoding. (#575)
PaddedCell.DirtyState::writeCanonicalTo(File)
can now create a new file if necessary (previously required to overwrite an existing file) (#576).
PaddedCell.calculateDirtyState(Formatter, File, byte[])
to allow IDE integrations to send dirty editor buffers.
- Support for google-java-format 1.8 (including test infrastructure for Java 11). (#562)
- Improved PaddedCell such that it is as performant as non-padded cell - no reason not to have it always enabled. Deprecated all of
PaddedCellBulk
. (#561) - Support for ktfmt 0.13 (#569)
- Updated a bunch of dependencies, most notably: (#564)
- jgit
5.5.0.201909110433-r
->5.7.0.202003110725-r
- gradle
6.2.2
->6.3
- spotbugs gradle plugin
2.0.0
->4.0.8
- jgit
- Javadoc for the
ext/eclipse-*
projects. - Replace the deprecated
compile
withimplementation
for theext/eclipse-*
projects.
- Enable IntelliJ-compatible token
$today.year
for specifying the year in license header files. (#542)
- Eclipse-WTP formatter (web tools platform, not java) could encounter errors in parallel multiproject builds #492. Fixed for Eclipse-WTP formatter Eclipse version 4.13.0 (default version).
- All
CHANGES.md
are now in keepachangelog format. (#507) - We now use javadoc.io instead of github pages. (#508)
- We no longer publish
-SNAPSHOT
for every build tomain
, since we have good JitPack integration. (#508) - Improved how we use Spotless on itself. (#509)
- Fix build warnings when building on Gradle 6+, bump build gradle to 6.2.2, and fix javadoc links. (#536)
- Ignored
KtLintStepTest
, because gradle/gradle#11752 is causing too many CI failures. (#499)- Also fixed a minor problem in TestProvisioner.
- If you set the environment variable
SPOTLESS_EXCLUDE_MAVEN=true
then the maven plugin will be excluded from the build. (#502)- We have set this in JitPack, as a workaround for jitpack/jitpack.io#4112
- Deprecated
SpotlessCache.clear()
in favor of the newSpotlessCache.clearOnce(Object key)
. (#501)
- Revert the change in console display of errors from 1.26.0 (#485) because of these problems.
- Bugfix: Fix NPE in EclipseXmlFormatterStepImpl (#489)
- Fix project URLs in poms. (#478)
- Fix
ImportSorter
crashing with empty files. (#474)- Fixes #305 StringIndexOutOfBoundsException for empty Groovy file when performing importOrder
- Bugfix: CDT version
4.12.0
now properly uses9.8
, whereas before it used9.7
. (#482) - Add support for Eclipse 4.13 and all related formatters (JDT, CDT, WTP, and Groovy). (#480)
- Bump default version of KtLint from
0.34.2
to0.35.0
. (#473) - Several improvements to the console display of formatting errors. (#465)
- Automatically configure import order for IntelliJ IDEA with
.editorconfig
(#486)
- Add support for ktlint
0.34+
, and bump default version from0.32.0
to0.34.2
. (#469)
- Update jgit from
5.3.2.201906051522-r
to5.5.0.201909110433-r
. (#445)- Fixes #410 AccessDeniedException in MinGW/ GitBash.
- Also fixes occasional hang on NFS due to filesystem timers.
- Eclipse-based formatters used to leave temporary files around (#447). This is now fixed, but only for eclipse 4.12+, no back-port to older Eclipse formatter versions is planned. (#451)
PaddedCellBulk
had a bug where badly-formatted files with well-behaving formatters were being:- correctly formatted by "apply"
- but incorrectly marked as good by "check"
- this led to "check" says all good, but then "apply" still causes format (diffplug#453)
- combined with up-to-date checking, could lead to even more confusing results (diffplug#338)
- only affects the gradle plugin, since that was the only plugin to use this feature
- Minor change to
TestProvisioner
, which should fix the cache-breaking issues, allowing us to speed-up the CI builds a bit. - Bumped
scalafmt
default version from1.1.0
to2.0.1
, since there are bugs in the old default (#458).
- Fixes class loading issue with Java 9+ (#426).
- Updated default eclipse-wtp from 4.8.0 to 4.12.0 (#423).
- Updated default eclipse-groovy from 4.10 to 4.12.0 (#423).
- Updated default eclipse-jdt from 4.11.0 to 4.12.0 (#423).
- Updated default eclipse-cdt from 4.11.0 to 4.12.0 (#423).
- KNOWN BUG - accidentally published CDT 9.7 rather than 9.8 - fixed in 1.26.0
- Added new maven coordinates for scalafmt 2.0.0+, maintains backwards compatability (#415)
- Fixes incorrect M2 cache directory path handling of Eclipse based formatters (#401)
- Update jgit from
4.9.0.201710071750-r
to5.3.2.201906051522-r
because gradle project is sometimes broken byapache httpcomponents
in transitive dependency. (#407)
- Updated default ktlint from 0.21.0 to 0.32.0, and Maven coords to com.pinterest (#394)
- Updated default eclipse-cdt from 4.7.3a to 4.11.0 (#390).
- Fixes incorrect plugin and pom metadata in
1.21.0
(#388).
- We now use a remote build cache to speed up CI builds. Reduced build time from ~13 minutes to as low as ~3 minutes, dependending on how deep the change is (#380).
- Updated default eclipse-wtp from 4.7.3b to 4.8.0 (#382).
- Updated default eclipse-groovy from 4.8.1 to 4.10.0 (#382).
- Updated default eclipse-jdt from 4.10.0 to 4.11.0 (#384).
- Made npm package versions of
prettier
andtsfmt
(and its internal packages) configurable. (#363)- Updated default npm package version of
prettier
from 1.13.4 to 1.16.4 - Updated default npm package version of internally used typescript package from 2.9.2 to 3.3.3 and tslint package from 5.1.0 to 5.12.0 (both used by
tsfmt
)
- Updated default npm package version of
- Updated default eclipse-wtp from 4.7.3a to 4.7.3b (#371).
- Configured
build-scan
plugin in build (#356).- Runs on every CI build automatically.
- Users need to opt-in on their local machine.
- Default behavior of XML formatter changed to ignore external URIs (#369).
- WARNING RESOLVED: By default, xml formatter no longer downloads external entities. You can opt-in to resolve external entities by setting resolveExternalURI to true. However, if you do opt-in, be sure that all external entities are referenced over https and not http, or you may be vulnerable to XXE attacks.
WARNING: xml formatter in this version may be vulnerable to XXE attacks, fixed in 1.20.0 (see #358).
- Security fix: Updated groovy, c/c++, and eclipse WTP formatters so that they download their source jars securely using
https
rather thanhttp
(#360). - Updated default eclipse-jdt from 4.9.0 to 4.10.0 (#368)
WARNING: xml formatter in this version may be vulnerable to XXE attacks, fixed in 1.20.0 (see #358).
- CSS and XML extensions are discontinued (#325).
- Provided features with access to SLF4J interface of build tools. (#236)
- Updated default google-java-format from 1.5 to 1.7 (#335).
ImportOrderStep.createFromFile
is now lazy (#218).
WARNING: xml formatter in this version may be vulnerable to XXE attacks, fixed in 1.20.0 (see #358).
- Updated default eclipse-jdt from 4.7.3a to 4.9.0 (#316). New version addresses enum-tab formatting bug in 4.8 (#314).
WARNING: xml formatter in this version may be vulnerable to XXE attacks, fixed in 1.20.0 (see #358).
- Minor support for plugin-gradle and plugin-maven CSS plugins (#311).
WARNING: xml formatter in this version may be vulnerable to XXE attacks, fixed in 1.20.0 (see #358).
- Added C/C++ support (#232).
- Integrated Eclipse CDT formatter (#274)
- Extended dependency provisioner to exclude transitives on request (#297).This prevents unnecessary downloads of unused transitive dependencies for Eclipse based formatter steps.
- Updated default groovy-eclipse from 4.8.0 to 4.8.1 (#288). New version is based on Groovy-Eclipse 3.0.0.
- Integrated Eclipse WTP formatter (#290)
- Updated JSR305 annotation from 3.0.0 to 3.0.2 (#274)
- Migrated from FindBugs annotations 3.0.0 to SpotBugs annotations 3.1.6 (#274)
Formatter
now implementsAutoCloseable
. This means that users ofFormatter
are expected to use the try-with-resources pattern. The reason for this change is so thatFormatterFunc.Closeable
actually works. (#284)* Addedprettier
andtsfmt
support, as well as general infrastructure for callingnodeJS
code usingj2v8
(#283).
- Updated default groovy-eclipse from 4.6.3 to 4.8.0 (#244). New version allows to ignore internal formatter errors/warnings.
- Updated default eclipse-jdt from 4.7.2 to 4.8.0 (#239). New version fixes a bug preventing Java code formatting within JavaDoc comments (#191).
- Eclipse formatter versions decoupled from Spotless formatter step implementations to allow independent updates of maven-based Eclipse dependencies. (#253)
- Use guaranteed binary and source compatibility between releases of Scalafmt. (#260)
- Add line and column numbers to ktlint errors. (#251)
- Fixed a bug in
LicenseHeaderStep
which caused an exception with some malformed date-aware licenses. (#222) - Updated default ktlint from 0.14.0 to 0.21.0
- Add ability to pass custom options to ktlint in gradle plugin. See plugin-gradle/README for details.
- Added default indentation of
4
toIndentStep
. (#209)
- LicenseHeaderStep now supports customizing the year range separator in copyright notices. (#199)
- Breaking change to testlib - removed
ResourceHarness.write
and addedResourceHarness.[set/assert]File
for easier-to-read tests. (#203)
- Updated default ktlint from 0.6.1 to 0.14.0
- Updated default google-java-format from 1.3 to 1.5
- Updated default eclipse-jdt from 4.7.1 to 4.7.2
- Added a configuration option to
googleJavaFormat
to switch the formatter style (#193)
- LicenseHeaderStep now supports time-aware copyright notices in license headers. (#179, thanks to @baptistemesta)
- Updated default eclipse-jdt version to
4.7.1
from4.6.3
. - Updated jgit from
4.5.0.201609210915-r
to4.9.0.201710071750-r
. - Updated concurrent-trees from
2.6.0
to2.6.1
(performance improvement). - Added
dbeaverSql
formatter step, for formatting sql scripts. (#166)- Many thanks to Baptiste Mesta for porting to Spotless.
- Many thanks to DBeaver and the DBeaver contributors for building the implementation.
- Added
public static boolean PaddedCell::applyAnyChanged(Formatter formatter, File file)
.
- Added
KtLintStep.createForScript
.
- Deprecated
ImportOrderStep.createFromOrder(List<String>
in favor of(String...
.
- Default eclipse version for
EclipseFormatterStep
bumped to4.6.3
from4.6.1
. (#116) - Default scalafmt version for
ScalaFmtStep
bumped to1.1.0
from0.5.7
(#124)- Also added support for the API change to scalafmt introduced in
0.7.0-RC1
- Also added support for the API change to scalafmt introduced in
ImportOrderStep
can now handle multi-line comments and misplaced imports.- Especially helpful for Groovy and Gradle files.
- Fixed a bug in
PaddedCellBulk.check()
which caused acheck
to fail even after anapply
for cases which caused CYCLE.
- Added support for Groovy via greclipse.
- When a JarState resolution failed, it threw a Gradle-specific error message. That message has been moved out of
lib
and intoplugin-gradle
where it belongs.
- Deprecated
FileSignature.from
in favor ofFileSignature.signAsSet
and the newFileSignature.signAsList
. - Added a
FormatterProperties
class which loads.properties
files and eclipse-style.xml
files. SerializableFileFilter.skipFilesNamed
can now skip multiple file names.- Update default KtLint from 0.3.1 to 0.6.1.
- This means we no longer look for rules in the typo package
com.gihub.shyiko
, now only incom.github.shyiko
(note thet
).
- This means we no longer look for rules in the typo package
- Added support for Scala via scalafmt.
- Added support for Kotlin via ktlint.
- Better error messages for JarState.
- Improved test harnessing.
- Formatter now has pluggable exception policies,
- Initial release!