spotless-plugin-gradle releases

We adhere to the keepachangelog format (starting after version 3.27.0).

[Unreleased]

[5.6.1] - 2020-09-21

Fixed

5.6.0 introduced a bug where it was no longer possible to configure a single format twice, e.g. to have two java{} blocks in a single file. Fixed by #702.

[5.6.0] - 2020-09-21

Added

withinBlocks allows you to apply rules only to specific sections of files, for example formatting javascript within html, code examples within markdown, and things like that (implements #412 - formatting inception).

[5.5.2] - 2020-09-18

Fixed

Don't assume that file content passed into Prettier is at least 50 characters (#699).

[5.5.1] - 2020-09-12

Fixed

Improved JRE parsing to handle strings like 16-loom (fixes #693).

[5.5.0] - 2020-09-11

Added

New option toggleOffOn() which allows the tags spotless:off and spotless:on to protect sections of code from the rest of the formatters (#691).

Changed

When applying license headers for the first time, we are now more lenient about parsing existing years from the header (#690).

[5.4.0] - 2020-09-08

Added

googleJavaFormat() default version is now 1.9 on JDK 11+, while continuing to be 1.7 on earlier JDKs. This is especially helpful to removeUnusedImports(), since it always uses the default version of GJF (fixes #681).

Fixed

We did not proactively check to ensure that the Gradle version was modern enough, now we do (fixes #684).

[5.3.0] - 2020-08-29

Added

Added support for eclipse-jdt 4.14.0, 4.15.0 and 4.16.0 (#678).

Changed

Updated default eclipse-jdt from 4.13.0 to 4.16.0 (#678).

[5.2.0] - 2020-08-25

Added

It is now much easier for Spotless to integrate formatters with native executables. (#672)
- Added support for python, specifically black.
- Added support for clang-format for all formats.

Fixed

If you executed gradlew spotlessCheck multiple times within a single second (hard in practice, easy for a unit test) you could sometimes get an erroneous failure message. Fixed in #671.

[5.1.2] - 2020-08-21

Fixed

ktlint() is now more robust when parsing version string for version-dependent implementation details, fixes #668.

[5.1.1] - 2020-08-05

Fixed

Depending on the file system, executing gradle spotlessApply might change permission on the changed files from 644 to 755; fixes (#656)
When using the prettier or tsfmt steps, if any files were dirty then spotlessCheck would fail with java.net.ConnectException: Connection refused rather than the proper error message (#651).

Changed

Bump default ktfmt from 0.15 to 0.16, and remove duplicated logic for the --dropbox-style option (#642)

[5.1.0] - 2020-07-13

Added

Bump default ktfmt from 0.13 to 0.15, and add support for the --dropbox-style option (#641).

[5.0.0] - 2020-07-12

This release is exactly the same as 4.5.1, except:

it now has plugin id com.diffplug.spotless, rather than com.diffplug.gradle.spotless (why)
the minimum required Gradle has bumped from 2.14 to 5.4
all deprecated functionality has been removed
-PspotlessModern=true (introduced in 4.3.0) is now always on

If id 'com.diffplug.gradle.spotless' version '4.5.1' works without deprecation warnings, then you can upgrade to id 'com.diffplug.spotless' version '5.0.0' and no changes will be required.

BREAKING All deprecated functionality has been removed (#640).
- (dev-only) SpotlessTask was deleted, and SpotlessTaskModern was renamed to SpotlessTask (ditto for SpotlessPlugin and SpotlessExtension).
Introduced in earlier versions, but formerly gated behind -PspotlessModern=true
- We now calculate incremental builds using the new InputChanges rather than the deprecated IncrementalTaskInputs. (#607)
- We now use Gradle's config avoidance APIs. (#617)
- Spotless no longer creates any tasks eagerly. (#622)
- BREAKING The closures inside each format specification are now executed lazily on task configuration. (#618)

String isEager = 'nope'
spotless {
    java {
        isEager = 'yup'
    }
}
println "isEager $isEager"
// 'com.diffplug.gradle.spotless' -> isEager yup
// 'com.diffplug.spotless'        -> isEager nope

[4.5.1] - 2020-07-04

Fixed

Git-native handling of line endings was broken, now fixed (#639).

[4.5.0] - 2020-07-02

Added

Full support for the Gradle buildcache - previously only supported local, now supports remote too. Fixes #566 and #280, via changes in #621 and #571.
prettier will now autodetect the parser (and formatter) to use based on the filename, unless you override this using config() or configFile() with the option parser or filepath. (#620)
(user-invisible) moved the deprecated lib code which was only being used in deprecated parts of plugin-gradle into the .libdeprecated package. (#630)
Added ANTLR4 support (#326).

Fixed

LineEndings.GIT_ATTRIBUTES is now a bit more efficient, and paves the way for remote build cache support in Gradle. (#621)
ratchetFrom now ratchets from the merge base of HEAD and the specified branch. This fixes the surprising behavior when a remote branch advanced (#631 fixes #627).

Deprecated

The default targets for C/C++, freshmark, sql, and typescript now generate a warning, asking the user to specify a target manually. There is no well-established convention for these languages in the gradle ecosystem, and the performance of the default target is far worse than a user-provided one. If you dislike this change, please complain in #634.
customLazy and customLazyGroovy now generate a warning, asking the user to migrate to custom. There is no longer a performance advantage to customLazy in the new modern plugin. See #635 for example migrations.
inside the cpp { } block, the eclipse step now generates a warning, asking you to switch to eclipseCdt. It is the same underlying step, but the new name clears up any confusion with the more common Java eclipse. #636

[4.4.0] - 2020-06-19

Added

It is now possible to have multiple language-specific formats. (9a02419)

import com.diffplug.gradle.spotless.KotlinExtension
spotless {
  kotlin {
    target 'src/**/*.kt'
    ktlint()
  }
  format 'kotlinScript', KotlinExtension, {
    target 'src/**/*.kts'
    ktfmt()
  }
}

[4.3.1] - 2020-06-17

Changed

Nodejs-based formatters prettier and tsfmt 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, tslint 5.12.1 -> 6.1.2

Fixed

Using ratchetFrom 'origin/main' on a bare checkout generated a cryptic error, now generates a clear error. (#608)
Using ratchetFrom 'nonexistent-reference generated a cryptic error, now generates a clear error. (#612)

[4.3.0] - 2020-06-05

Deprecated

-PspotlessFiles has been deprecated and will be removed. It is slow and error-prone, especially for win/unix cross-platform, and we have better options available now:
- If you are formatting just one file, try the much faster IDE hook
- If you are integrating with git, try the much easier (and faster) ratchetFrom 'origin/main'
- If neither of these work for you, let us know in this PR.

Added

If you specify -PspotlessSetLicenseHeaderYearsFromGitHistory=true, Spotless will perform 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)
It is now possible for individual formats to set their own ratchetFrom value, similar to how formats can have their own encoding. (#605).
(spotless devs only) if you specify -PspotlessModern=true Spotless will run the in-progress Gradle 5.4+ code. The modernTest build task runs our test suite in this way. It will be weeks/months before this is recommended for end-users. (#598)

[4.2.1] - 2020-06-04

Fixed

ratchetFrom incorrectly marked every file as though it were clean on Windows. (#596)
- Also large performance improvement (win and unix) for multiproject builds. (#597)
Improved the warning message for paddedCell deprecation, along with many API-invisible fixes and cleanup. (#592)

[4.2.0] - 2020-06-03

Added

If you use ratchetFrom and licenseHeader, the year in your license header will now be automatically kept up-to-date for changed files. For example, if the current year is 2020: (#593)
- /** Copyright 2020 */ -> unchanged
- /** Copyright 1990 */ -> /** Copyright 1990-2020 */
- /** Copyright 1990-1993 */ -> /** Copyright 1990-2020 */
- You can disable this behavior with licenseHeader(...).updateYearWithLatest(false), or you can enable it without using ratchetFrom by using updateYearWithLatest(true) (not recommended).

Fixed

ratchetFrom had a bug (now fixed) such that it reported all files outside the root directory as changed. (#594)

[4.1.0] - 2020-06-01

Added

You can now ratchet a project's style by limiting Spotless only to files which have changed since a given git reference, e.g. ratchetFrom 'origin/main'. (#590)
Support for ktfmt in KotlinGradleExtension. (#583)

Fixed

Users can now run spotlessCheck and spotlessApply in the same build. (#584)
Fixed intermittent UnsatisfiedLinkError in nodejs-based steps. (#586)
- Also, a shared library used by the nodejs steps used to be extracted into the user home directory, but now it is extracted into {rootProject}/build/spotless-nodejs-cache.
Fixed intermittent java.nio.file.DirectoryNotEmptyException on incremental builds where folders had been removed. (#589)
Starting in 4.0, it is no longer possible for a project to format files which are not within its project folder (for example, :a can no longer format files in :b). We did not explicitly note this in the changelog entry for 4.0, and we gave a very confusing error message if users tried. We now give a more helpful error message, and this breaking change has been retroactively noted in the changelog for 4.0.0. (#588)

[4.0.1] - 2020-05-21

Fixed

If the encoding was set incorrectly, spotlessApply could clobber special characters. Spotless now prevents this, and helps to suggest the correct encoding. (#575)

[4.0.0] - 2020-05-17

TLDR: This version improves performance and adds support for the local Gradle Build Cache. You will not need to make any changes in your buildscript. It is a breaking change only for a few users who have built other plugins on top of this one.

Added

Support for the gradle build cache. (#576)
- The local cache will work great, but the remote cache will always miss until #566 is resolved.

Removed

BREAKING it used to be possible for any project to format files in any other project. For example, :a could format files in :b. It is now only possible to format files within the project directory. It is okay (but not advised) to format files in subprojects, since they are within the project directory.
(Power users only) BREAKING void SpotlessTask::setCheck() and setApply() have been removed. (#576)
- Previously, the check and apply tasks were just marker tasks, and they called setCheck and setApply on the "worker" task. Now check and apply are real tasks in their own right, so the marker-task kludge is no longer necessary.

Changed

(Power users only) BREAKING SpotlessTask FormatExtension::createIndependentTask has been removed, and replaced with SpotlessApply::createIndependentApplyTask. (#576)
Improve suggested gradle invocation for running spotlessApply. (#578)

[3.30.0] - 2020-05-11

Added

-PspotlessIdeHook which makes the VS Code extension faster and more reliable. See IDE_INTEGRATION.md for more details. (#568)

[3.29.0] - 2020-05-05

Added

🎉🎉🎉 VS Code Extension thanks to @badsyntax 🎉🎉🎉
Support for google-java-format 1.8 (requires build to run on Java 11+) (#562)
Support for ktfmt 0.13 (requires build to run on Java 11+) (#569)

Changed

PaddedCell is now always enabled. It is strictly better than non-padded cell, and there is no performance penalty. See here for detailed explanation. (#561)
Updated a bunch of dependencies, most notably jgit 5.5.0.201909110433-r -> 5.7.0.202003110725-r. (#564)

[3.28.1] - 2020-04-02

Fixed

Eclipse-WTP formatter (web tools platform, not java) handles some character encodings incorrectly on OS with non-unicode default file encoding #545. Fixed for Eclipse-WTP formatter Eclipse version 4.13.0 (default version).

[3.28.0] - 2020-03-20

Added

Enable IntelliJ-compatible token $today.year for specifying the year in license header files. (#542)

Fixed

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

[3.27.2] - 2020-03-05

Fixed

Add tests to SpecificFilesTest to fix #529
If you applied spotless to a subproject, but not to the root project, then on Gradle 6+ you would get the deprecation warning Using method Project#afterEvaluate(Action) when the project is already evaluated has been deprecated. This has now been fixed. (#506)

[3.27.1] - 2020-01-14

Fixed

licenseHeader and licenseHeaderFile accidentally returned a package-private config object, which is now public, fixes (#505).

[3.27.0] - 2020-01-01

Added method FormatExtension.createIndependentTask(String taskName) which allows creating a Spotless task outside of the check/apply lifecycle. See javadoc for details. (#500)
Running clean and spotlessCheck during a parallel build could cause exceptions, fixed by (#501).
Fixed Gradle 7 deprecation warnings that started being emitted in Gradle 6. (#503)
- Even if you're using a pre-6.0 version of Gradle, you will probably see small performance and stability improvements. The PR above finally fixed the root problems of (#372).

[3.26.1] - 2019-11-27

Revert the change in console display of errors from 3.26.0 (#485) because of these problems.
Bugfix: Fix NPE in EclipseXmlFormatterStepImpl (#489)

[3.26.0] - 2019-11-11

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 uses 9.8, whereas before it used 9.7. (#482)
Updated default eclipse-wtp from 4.12.0 to 4.13.0 (#482).
Updated default eclipse-groovy from 4.12.0 to 4.13.0 (#482).
Updated default eclipse-jdt from 4.12.0 to 4.13.0 (#482).
Updated default eclipse-cdt from 4.12.0 to 4.13.0 (#482).
Bump default version of KtLint from 0.34.2 to 0.35.0. (#473)
Several improvements to the console display of formatting errors. (#465)
- Visualize \r and \n as ␍ and ␊ when possible (#465)
- Make end-of-lines visible when file contains whitespace and end-of-line issues at the same time (#465)
- Print actual diff line instead of "1 more lines that didn't fit" (#467)

[3.25.0] - 2019-10-06

Spotless no longer breaks configuration avoidance for other tasks (specifically the check task and all of its dependees) (#463).
- Important change: Formerly, Spotless did not create its tasks until the afterEvaluate phase. Spotless now creates them as soon as the plugin is applied, and it creates the format-specific tasks as soon as the formats are defined. There is no performance degradation associated with this change, and it makes configuring Spotless easier.
Add support for ktlint 0.34+, and bump default version from 0.32.0 to 0.34.2. (#469)

[3.24.3] - 2019-09-23

Update jgit from 5.3.2.201906051522-r to 5.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)
Fixed a bad but simple bug in paddedCell() (#455)
- if a formatter was behaving correctly on a given file (was idempotent)
- but the file was not properly formatted
- spotlessCheck would improperly say "all good" even though spotlessApply would properly change them
- combined with up-to-date checking, could lead to even more confusing results, (#338)
- Fixed now!
When you specify targetExclude(), spotless no longer silently removes build directories from the exclusion (#457).
Bumped scalafmt default version from 1.1.0 to 2.0.1, since there are bugs in the old default (#458).

[3.24.2] - 2019-08-19

Fixed Warning deprecated usage found: Using the incremental task API without declaring any outputs has been deprecated. that started appearing in Gradle 5.5 (#434).

[3.24.1] - 2019-08-12

Fixes class loading issue with Java 9+ (#426).

[3.24.0] - 2019-07-29

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 3.26.0
Added new maven coordinates for scalafmt 2.0.0+, maintains backwards compatability (#415)

[3.23.1] - 2019-06-17

Fixes incorrect M2 cache directory path handling of Eclipse based formatters (#401)
Update jgit from 4.9.0.201710071750-r to 5.3.2.201906051522-r because gradle project is sometimes broken by apache httpcomponents in transitive dependency. (#407)

[3.23.0] - 2019-04-24

Updated default ktlint from 0.21.0 to 0.32.0, and Maven coords to com.pinterest (#394)

[3.22.0] - 2019-04-15

Updated default eclipse-cdt from 4.7.3a to 4.11.0 (#390).

[3.21.1] - 2019-03-29

Fixes incorrect plugin and pom metadata in 3.21.0 (#388).

[3.21.0] - 2019-03-28

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).
Fixed intermittent concurrency error while downloading formatter dependencies in multi-project builds (#372).