spotless-plugin-gradle releases

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

[Unreleased]

Added

Support custom rule sets for Ktlint. (#1896

Fixed

Fix Eclipse JDT on some settings files. (#1864 fixes #1638)
Check if EditorConfig file exist for Ktlint in KotlinGradleExtension. (#1889)

Changes

Bump default ktlint version to latest 1.0.0 -> 1.0.1. (#1855)

Fixed

Fix GoogleJavaFormatConfig.reorderImports not working. (#1872)

[6.22.0] - 2023-09-28

Added

Added support for google-java-format's skip-javadoc-formatting option (#1793)
Add support for flexmark in gradle. Previously only Maven was supported. (#1801)
Add support for biome. The Rome project was renamed to Biome. The configuration is still the same, but you should switch to the new biome(...) function and adjust the version accordingly. (#1804).

Fixed

Fixed support for plugins when using Prettier version 3.0.0 and newer. (#1802)

Changes

Bump default ktlint version to latest 0.50.0 -> 1.0.0. (#1808)
POSSIBLY BREAKING the default line endings are now GIT_ATTRIBUTES_FAST_ALLSAME instead of GIT_ATTRIBUTES. (#1838)
- If all the files within a format have the same line endings, then there is no change in behavior.
- Fixes large performance regression. (#1527)

[6.21.0] - 2023-08-29

Added

Add a jsonPatch step to json formatter configurations. This allows patching of JSON documents using JSON Patches. (#1753)
Support GJF own import order. (#1780)

Fixed

Add support for prettier version 3.0.0 and newer. (#1760, #1751)
Fix npm install calls when npm cache is not up-to-date. (#1760, #1750)
Fix configuration cache failure when using LineEnding.GIT_ATTRIBUTES (#1644)
Fix configuration cache failure when formatting proto files with Buf. (#1779)
Check if EditorConfig file exist for Ktlint. (#1788)

Changes

Bump default eslint version to latest 8.31.0 -> 8.45.0 (#1761)
Bump default prettier version to latest (v2) 2.8.1 -> 2.8.8. (#1760)
Bump default greclipse version to latest 4.27 -> 4.28. (#1775)

[6.20.0] - 2023-07-17

Added

Add target option targetExcludeIfContentContains and targetExcludeIfContentContainsRegex to exclude files based on their text content. (#1749)
Add support for Protobuf formatting based on Buf (#1208).
Add an overload for FormatExtension.addStep which provides access to the FormatExtension's Provisioner, enabling custom steps to make use of third-party dependencies.

Fixed

Correctly support the syntax

spotless {
  yaml {
    jackson().yamlFeature("MINIMIZE_QUOTES", true)
  }
}

Changes

Bump default cleanthat version to latest 2.13 -> 2.17. (#1734)
Bump default ktlint version to latest 0.49.1 -> 0.50.0. (#1741)
- Dropped support for ktlint 0.47.x following our policy of supporting two breaking changes at a time.
- Dropped support for deprecated useExperimental parameter in favor of the ktlint_experimental property.

[6.19.0] - 2023-05-24

Added

Support Rome as a formatter for JavaScript and TypeScript code. Adds a new rome step to javascript and typescript formatter configurations. (#1663)
Add semantics-aware Java import ordering (i.e. sort by package, then class, then member). (#522)

Fixed

Added @DisableCachingByDefault to RegisterDependenciesTask. (#1666)
Fixed a regression which changed the import sorting order in googleJavaFormat introduced in 6.18.0. (#1680)
Equo-based formatters now work on platforms unsupported by Eclipse such as PowerPC (fixes durian-swt#20)
When P2 download fails, indicate the responsible formatter. (#1698)

Changes

Equo-based formatters now download metadata to ~/.m2/repository/dev/equo/p2-data rather than ~/.equo, and for CI machines without a home directory the p2 data goes to $GRADLE_USER_HOME/caches/p2-data. (#1714)
Bump default googleJavaFormat version to latest 1.16.0 -> 1.17.0. (#1710)
Bump default ktfmt version to latest 0.43 -> 0.44. (#1691)
Bump default ktlint version to latest 0.48.2 -> 0.49.1. (#1696)
- Dropped support for ktlint 0.46.x following our policy of supporting two breaking changes at a time.
Bump default sortpom version to latest 3.0.0 -> 3.2.1. (#1675)

[6.18.0] - 2023-04-06

Added

removeUnusedImport can be configured to rely on cleanthat-javaparser-unnecessaryimport. Default remains google-java-format. (#1589)
Added formatter for Gherkin feature files (#1649).
Support configuration of mirrors for P2 repositories (#1629):
```
spotless {
  java {
    eclipse().withP2Mirrors(['https://download.eclipse.org/', 'https://some.internal.mirror/eclipse'])
  }
}
```
Mirrors are selected by prefix match, for example https://download.eclipse.org/eclipse/updates/4.26/ will be redirected to https://some.internal.mirror/eclipse/eclipse/updates/4.26/. The same configuration exists for greclipse and eclipseCdt.
The style option in Palantir Java Format (#1654).

Fixed

Stop using deprecated conventions when used in Gradle >= 7.1. (#1618)

Changes

POTENTIALLY BREAKING Drop support for googleJavaFormat versions < 1.8. (#1630)
Bump default cleanthat version to latest 2.6 -> 2.13. (#1589 and #1661)
Bump default diktat version 1.2.4.2 -> 1.2.5. (#1631)
Bump default flexmark version 0.62.2 -> 0.64.0. (#1302)
Bump default googleJavaFormat version 1.15.0 -> 1.16.0. (#1630)
Bump default scalafmt version 3.7.1 -> 3.7.3. (#1584)
Bump default Eclipse formatters for the 2023-03 release. (#1662)
- JDT and GrEclipse 4.26 -> 4.27
  - Improve GrEclipse error reporting. (#1660)
- CDT 11.0 -> 11.1

[6.17.0] - 2023-03-13

Added

You can now put the filename into a license header template with $FILE. (#1605 fixes #1147)
licenseHeader default pattern for Java files is updated to (package|import|public|class|module) . (#1614)

Changes

All Eclipse formatters are now based on Equo Solstice OSGi and p2 shim. (#1524)
- Eclipse JDT bumped default to 4.26 from 4.21, oldest supported is 4.9.
  - We now recommend dropping the last .0, e.g. 4.26 instead of 4.26.0, you'll get warnings to help you switch.
- Eclipse Groovy bumped default to 4.26 from 4.21, oldest supported is 4.18.
- Eclipse CDT bumped default to 11.0 from 4.21, oldest supported is 10.6.
- Eclipse WTP is still WIP at #1622.

[6.16.0] - 2023-02-27

Added

cleanthat now has includeDraft option, to include draft mutators from composite mutators. (#1574)
npm-based formatters (prettier, tsfmt and eslint) now support caching of node_modules directory. To enable it, provide npmInstallCache() option. (#1590)

Fixed

json { jackson() can now handle Array as a root element. (#1585)
Reduce logging-noise created by npm-based formatters (#1590 fixes #1582)

Changes

Bump default cleanthat version to latest 2.1 -> 2.6. (#1569 and #1574)

[6.15.0] - 2023-02-10

Added

CleanThat Java Refactorer. (#1560)

Fixed

Allow multiple instances of the same npm-based formatter to be used simultaneously. E.g. use prettier for typescript and Java (using the community prettier-plugin-java) without messing up their respective node_module dependencies. (#1565)
ktfmt default style uses correct continuation indent. (#1562)

Changes

Bump default ktfmt version to latest 0.42 -> 0.43 (#1561)
Bump default jackson version to latest 2.14.1 -> 2.14.2 (#1536)

[6.14.1] - 2023-02-05

Fixed

freshmark fixed on java 15+ (#1304 fixes #803)
POTENTIALLY BREAKING sortByKeys for JSON formatting now takes into account objects inside arrays (#1546)

[6.14.0] - 2023-01-26

Added

Support jackson() for YAML and JSON files (#1492)
Prettier will now suggest to install plugins if a parser cannot be inferred from the file extension (#1511)
Allow to specify node executable for node-based formatters using nodeExecutable parameter (#1500)

Fixed

POTENTIALLY BREAKING Generate the correct qualifiedRuleId for Ktlint 0.48.x #1495
The default list of type annotations used by formatAnnotations has had 8 more annotations from the Checker Framework added #1494

Changes

POTENTIALLY BREAKING Bump minimum JRE from 8 to 11 (#1514 part 1 of #1337)
- You can bump your build JRE without bumping your requirements (docs).
Prettier will now suggest to install plugins if a parser cannot be inferred from the file extension (#1511)
POTENTIALLY BREAKING Removed support for KtLint 0.3x and 0.45.2 (#1475)
- KtLint does not maintain a stable API - before this PR, we supported every breaking change in the API since 2019.
- From now on, we will support no more than 2 breaking changes at a time.
npm-based formatters ESLint, prettier and tsfmt delay their npm install call until the formatters are first used. For Gradle this effectively moves the npm install call out of the configuration phase and as such enables better integration with gradle-node-plugin. (#1522)
Bump default ktlint version to latest 0.48.1 -> 0.48.2 (#1529)
Bump default scalafmt version to latest 3.6.1 -> 3.7.1 (#1529)

[6.13.0] - 2023-01-14

Added

POTENTIALLY BREAKING ktlint step now supports .editorconfig (#1442 implements #142)
- POTENTIALLY BREAKING ktlint step now modifies license headers. Make sure to put licenseHeader after ktlint.
Added skipLinesMatching option to licenseHeader to support formats where license header cannot be immediately added to the top of the file (e.g. xml, sh). (#1441)
Added support for npm-based ESLint formatter for javascript and typescript (#1453)
Better suggested messages when user's default is set by JVM limitation. (#995)

Fixed

Prevent tool configurations from being resolved outside project (#1447 fixes #1215)
Support ktlint 0.48+ new rule disabling syntax (#1456) fixes (#1444)
Fix subgroups leading catch all matcher.

Changes

Bump default ktlint version to latest 0.47.1 -> 0.48.1 (#1456)
Bump default version for prettier from 2.0.5 to 2.8.1 (#1453)

[6.12.1] - 2023-01-02

Fixed

Improve memory usage when using git ratchet (#1426)
Support ktlint 0.48+ (#1432) fixes (#1430)

Changes

Bump default ktlint version to latest 0.47.1 -> 0.48.0 (#1432)
Bump default ktfmt version to latest 0.41 -> 0.42 (#1421)

[6.12.0] - 2022-11-24

Added

importOrder now support groups of imports without blank lines (#1401)

Fixed

Don't treat @Value as a type annotation #1367
Support ktlint_disabled_rules in ktlint 0.47.x #1378

Changes

Bump default ktfmt version to latest 0.40 -> 0.41 (#1340)
Bump default scalafmt version to latest 3.5.9 -> 3.6.1 (#1373)
Bump default diktat version to latest 1.2.3 -> 1.2.4.2 (#1393)
Bump default palantir-java-format version to latest 2.10 -> 2.28 (#1393)

[6.11.0] - 2022-09-14

Added

formatAnnotations() step to correct formatting of Java type annotations. It puts type annotations on the same line as the type that they qualify. Run it after a Java formatting step, such as googleJavaFormat(). (#1275)

Changes

Bump default ktfmt version to latest 0.39 -> 0.40 (#1312)
Bump default ktlint version to latest 0.46.1 -> 0.47.1 (#1303)
- Also restored support for older versions of ktlint back to 0.31.0

[6.10.0] - 2022-08-23

Added

scalafmt integration now has a configuration option majorScalaVersion that allows you to configure the Scala version that gets resolved from the Maven artifact (#1283)

Changes

Add the ktlint rule in error messages when ktlint fails to apply a fix (#1279)
Bump default scalafmt to latest 3.0.8 -> 3.5.9 (removed support for pre-3.0.0) (#1283)

[6.9.1] - 2022-08-10

Fixed

Fix Clang not knowing the filename and changing the format (#1268 fixes #1267).

Changes

Bump default diktat version to latest 1.2.1 -> 1.2.3 (#1266)

[6.9.0] - 2022-07-28

Added

Clang and Black no longer break the build when the binary is unavailable, if they will not be run during that build (#1257).
License header support for Kotlin files without package or @file but do at least have import (#1263).

Fixed

Warnings about missing Task#usesService for Gradle 8.0 (#1262 fixes #1260)

[6.8.0] - 2022-06-30

Added

Support for MAC_CLASSIC (\r) line ending (#1243 fixes #1196)

Changes

Bump default ktlint version to latest 0.45.2 -> 0.46.1 (#1239)
- Minimum supported version also bumped to 0.46.0 (we have abandoned strong backward compatibility for ktlint, from here on out Spotless will only support the most-recent breaking change).
Bump default diktat version to latest 1.1.0 -> 1.2.1 (#1246)
- Minimum supported version also bumped to 1.2.1 (diktat is based on ktlint and has the same backward compatibility issues).
Bump default ktfmt version to latest 0.37 -> 0.39 (#1240)

[6.7.2] - 2022-06-11

Fixed

PalantirJavaFormatStep no longer needs the --add-exports calls in the org.gradle.jvmargs property in gradle.properties. (#1233)

[6.7.1] - 2022-06-10

Fixed

(Second try) googleJavaFormat and removeUnusedImports works on JDK16+ without jvm args workaround. (#1228)
- If you have a bunch of --add-exports calls in your org.gradle.jvmargs property in gradle.properties, you should be able to remove them. (fixes #834)

[6.7.0] - 2022-06-05

Added

Support for editorConfigOverride in ktlint. (#1218 fixes #1193)
- If you are using properties like indent_size, you should pass now pass them as editorConfigOverride and not as userData.

Fixed

googleJavaFormat and removeUnusedImports works on JDK16+ without jvm args workaround. (#1224)
- If you have a bunch of --add-exports calls in your org.gradle.jvmargs property in gradle.properties, you should be able to remove them. (fixes #834)

[6.6.1] - 2022-05-13

Fixed

More daemon memory consumption fixes (#1206 fixes #1194)

[6.6.0] - 2022-05-10

Added

FormatExtension.createIndependentApplyTaskLazy, with same functionality as createIndependentApplyTaskLazy but returning TaskProvider (#1198)

Fixed

Update the black version regex to fix 19.10b0 and earlier. (fixes #1195, regression introduced in 6.5.0)
Improved daemon memory consumption (#1198 fixes #1194)

Changes

Bump default ktfmt version to latest 0.36 -> 0.37. (#1200)

[6.5.2] - 2022-05-03

Changes

Bump default diktat version to latest 1.0.1 -> 1.1.0. (#1190)
- Converted diktat integration to use a compile-only source set. (fixes #524)
- Use the full path to a file in diktat integration. (fixes #1189)

[6.5.1] - 2022-04-27

Changes

Bump default ktfmt version to latest 0.35 -> 0.36. (#1183)
Bump default google-java-format version to latest 1.13.0 -> 1.15.0.
- ~~This means it is no longer necessary to use the --add-exports workaround (fixes #834).~~ --add-exports workaround is still needed.

[6.5.0] - 2022-04-22

Added

Added a runToFixMessage property to customize the run-to-fix message in spotlessCheck task. (#1175)
Added support for enabling ktlint experimental ruleset. (#1145)

Fixed

Fixed support for Python Black's new version reporting. (#1170)
All tasks (including helper tasks) are now part of the verification group. (fixes #1050)
Error messages for unexpected file encoding now works on Java 8. (fixes #1081)

Changed

Spotless now applies the base plugin to make sure that Spotless always has a check task to hook into. (#1179, fixes #1164, reverts #1014)
- Spotless used to work this way, we stopped applying base starting with version 6.0.3 (released Dec 2021) in order to play nicely with a now-outdated Android template, but not applying base causes more problems than it fixes (see #1164 for a good example).
- If you have anything like tasks.register<Delete>("clean" or tasks.register("clean", Delete), just change the register to named so that you are configuring the existing clean created by base, rather than creating a new task.
Bump default black version to latest 19.10b0 -> 22.3.0. (#1170)
Bump default ktfmt version to latest 0.34 -> 0.35. (#1159)
Bump default ktlint version to latest 0.43.2 -> 0.45.2. (#1177)

[6.4.2] - 2022-04-06

Fixed

Git user config and system config also included for defaultEndings configuration. (#540)

[6.4.1] - 2022-03-30

Fixed

Fixed ktfmt options configuration in Gradle plugin for Gradle Kotlin scripts (kts).

[6.4.0] - 2022-03-28

Added

Accept java.nio.charset.Charset type when setting the character encoding via encoding (#1128)
Added support for setting custom parameters for Kotlin ktfmt in Gradle plugin. (#1145)

[6.3.0] - 2022-02-15

Added

Added support for JSON formatting based on Gson (#1125).

Changed

Use SLF4J for logging (#1116)

[6.2.2] - 2022-02-09

Changed

Bump default ktfmt 0.30 -> 0.31 (#1118).

Fixed

Add full support for git worktrees (#1119).

[6.2.1] - 2022-02-01

Changed

Bump default versions of formatters (#1095).
- google-java-format 1.12.0 -> 1.13.0
- ktfmt 0.29 -> 0.30
Added support for git property core.autocrlf (#540)

[6.2.0] - 2022-01-13

Added

🎉🎉🎉 IntelliJ plugin thanks to @ragurney 🎉🎉🎉
Added support for the palantir-java-format Java formatter (#1083).

Fixed

Register spotlessPredeclare extension with type SpotlessExtensionPredeclare instead of the same SpotlessExtension as spotless so that Kotlin users can use configure<SpotlessExtensionPredeclare> (#1084).

[6.1.2] - 2022-01-07

Fixed

Update IndentStep to allow leading space on multiline comments (#1072).

[6.1.1] - 2022-01-06

Fixed

If the base plugin has already been applied, then there is no need for configuration of the clean task to trigger configuration of the Spotless tasks (#1068).

Changed

Bumped default DiKTat from 0.4.0 to 1.0.1. This is a breaking change for DiKTat users on the default version, because some rules were renamed/changed. Check DiKTat changelog for details.

[6.1.0] - 2021-12-23

Added

You can now predeclare formatter dependencies in the root project.
- specify one of:
- spotless { predeclareDeps() } to resolve all deps from the root project, which will show up in dependency reports.
- spotless { predeclareDepsFromBuildscript() } to resolve all deps from buildscript { repositories {, which will not show up in dependency reports (see #1027).
- and then below that you have a block where you simply declare each formatter which you are using, e.g.
- ```
spotless {
  ...
  predeclareDepsFromBuildscript()
}
spotlessPredeclare {
  java { eclipse() }
  kotlin { ktfmt('0.28') }
}
```
- By default, Spotless resolves all dependencies per-project, and the predeclaration above is unnecessary in the vast majority of cases.

[6.0.5] - 2021-12-16

Fixed

ratchetFrom is now faster and uses less memory (#1038).

[6.0.4] - 2021-12-07

Fixed

Fix Gradle composite builds (#860).

[6.0.3] - 2021-12-06

Fixed

Spotless no longer applies BasePlugin (#1014).
- This was done to ensure that any Spotless tasks would run after the clean task, but we found a way to do this without applying the BasePlugin. This resolves a conflict with the Android Gradle template (fixes #858).
Large parallel builds could throw ConcurrentModificationException (masked by "Cannot add a configuration with name"), now fixed. (#1015)

[6.0.2] - 2021-12-05

Changed

Bumped default ktlint from 0.43.0 to 0.43.2.

Fixed

Fixed problem with ktlint dependency variants (#993)

[6.0.1] - 2021-12-01

Changed

Added named option to licenseHeader to support alternate license header within same format (like java) (872).
Added onlyIfContentMatches option to licenseHeader to skip license header application based on source file content pattern (#650).
Bump jgit version (#992).
- jgit 5.10.0.202012080955-r -> 5.13.0.202109080827-r

[6.0.0] - 2021-11-09

Added

Support for Gradle Configuration Cache* (#982, #986)
- *Spotless must run on the same daemon that wrote the configuration cache. If it isn't, you'll get this error message:
- ```
Spotless JVM-local cache is stale. Regenerate the cache with
  rm -rf .gradle/configuration-cache
```
- To make this daemon-restriction obsolete, please see and upvote #987.

Changed

BREAKING Previously, many projects required buildscript { repositories { mavenCentral() }} at the top of their root project, because Spotless resolved its dependencies using the buildscript repositories. Spotless now resolves its dependencies from the normal project repositories of each project with a spotless {...} block. This means that you can remove the buildscript {} block, but you still need a repositories { mavenCentral() } (or similar) in each project which is using Spotless. (#980, #983)
- If you prefer the old behavior, it is available via predeclareDepsFromBuildscript() starting in 6.1.0.
BREAKING createIndepentApplyTask(String taskName) now requires that taskName does not end with Apply
Bump minimum required Gradle from 6.1 to 6.1.1.
Bump default formatter versions (#989)
- google-java-format 1.11.0 -> 1.12.0
- ktlint 0.42.1 -> 0.43.0
- ktfmt 0.27 -> 0.29
- scalafmt 3.0.0 -> 3.0.8

Removed

BREAKING removeFormat (which has been broken since 5.0) has been removed. Use clearSteps() as a workaround (#653).

[5.17.1] - 2021-10-26

Changed

Added support and bump Eclipse formatter default versions to 4.21 for eclipse-groovy. Change is only applied for JVM 11+.
Added support for ktlint's FilenameRule (#974).

Fixed

Temporary workspace deletion for Eclipse based formatters on JVM shutdown (#967). Change is only applied for Eclipse versions using JVM 11+, no back-port to older versions is planned.

[5.17.0] - 2021-10-13

Added

Added support for calling local binary formatters (#963)

Fixed

module-info formatting in eclipse-jdt versions 4.20 and 4.21. Note that the problem also affects older versions.
Added workaround to support projects using git worktrees (#965)

[5.16.0] - 2021-10-02

Added wildcardsLast() option for Java importOrder (#954)

Added

Added support for JBDI bind list params in sql formatter (#955)

[5.15.2] - 2021-09-27

Changed

Added support and bump Eclipse formatter default versions to 4.21 for eclipse-cdt, eclipse-jdt, eclipse-wtp. Change is only applied for JVM 11+.
Added groupArtifact option for google-java-format (#944)

[5.15.1] - 2021-09-20

Changed

Added support and bump Eclipse formatter default versions for JVM 11+. For older JVMs the previous defaults remain.
- eclipse-cdt from 4.16 to 4.20
- eclipse-groovy from 4.19 to 4.20
- eclipse-jdt from 4.19 to 4.20
- eclipse-wtp from 4.18 to 4.20

Fixed

Large parallel multiproject builds could sometimes generate hard-to-reproduce errors below (reported in #941, attempted fix in #942).
- :spotlessInternalRegisterDependencies task failed.
- Cannot add a configuration with name 'spotless-1911100560'
Spotless does not yet support configuration-cache, but now it can never interfere with configuration-cache for other tasks. (#720)
Bump minimum required Gradle from 5.4 to 6.1.

[5.15.0] - 2021-09-04

Added

Added support for google-java-format's skip-reflowing-long-strings option (#929)

[5.14.3] - 2021-08-20

Changed

Added support for scalafmt 3.0.0 and bump default scalafmt version to 3.0.0 (#913).
Bump default versions (#915)
- ktfmt from 0.24 to 0.27
- ktlint from 0.35.0 to 0.42.1
- google-java-format from 1.10.0 to 1.11.0

[5.14.2] - 2021-07-20

Fixed

Improved SQL formatting with respect to comments

[5.14.1] - 2021-07-06

Changed

Improved exception messages for JSON formatting failures

[5.14.0] - 2021-06-17

Added

Added Gradle configuration JVM-based JSON formatting

Fixed

Fixed IndexOutOfBoundsException in parallel execution of eclipse-groovy formatter (#877)

[5.13.0] - 2021-06-10

Added

Added support for eclipse-cdt at 4.19.0. Note that version requires Java 11 or higher.
Added support for eclipse-groovy at 4.18.0 and 4.19.0.
Added support for eclipse-wtp at 4.19.0. Note that version requires Java 11 or higher.

Changed

Bump eclipse-groovy default version from 4.17.0 to 4.19.0.

[5.12.5] - 2021-05-13

Changed

Update ktfmt from 0.21 to 0.24

Fixed

The <url> field in the Maven POM is now set correctly (#798)
Node is re-installed if some other build step removed it (#863)

[5.12.4] - 2021-04-21

Fixed

Dependency configurations are now named rather than detached, attempt to fix #815.

[5.12.3] - 2021-04-21

Fixed

Explicitly separate target file from git arguments when parsing year for license header to prevent command from failing on argument-like paths (#847)

[5.12.2] - 2021-04-20

Fixed

LicenseHeaderStep treats address as copyright year (#716)

[5.12.1] - 2021-04-13

Fixed

Fix license header bug for years in range (#840).

[5.12.0] - 2021-04-10

Added

Added support for eclipse-jdt at 4.19.0.

Changed

Bump eclipse-jdt default version from 4.18.0 to 4.19.0.
Bump google-java-format default version from 1.9 to 1.10.0.
Expose configuration exceptions from scalafmt (#837)

Fixed

Exclude .git, .gradle and build directories when multiple targets are specified (#835).
- As part of this fix, **/blah.txt is now handled the same as **/*.txt, which was always the expected behavior. Very unlikely to cause any user-visible changes in behavior.

[5.11.1] - 2021-03-26

Fixed

Ensure consistent ordering of task inputs for RegisterDependenciesTask,bso the task is up-to-date when the spotless config has not changed.

[5.11.0] - 2021-03-05

Added

Bump ktfmt to 0.21 and add support to Google and Kotlinlang formats (#812)

[5.10.2] - 2021-02-16

Fixed

Allow licence headers to be blank (#801).

[5.10.1] - 2021-02-11

Fixed

Fixed the clean task when Gradle's configuration cache is enabled (#796)

[5.10.0] - 2021-02-09

Added

Support for diktat in KotlinGradleExtension (#789)

[5.9.0] - 2021-01-04

Added

Added support for eclipse-cdt, eclipse-jdt, and eclipse-wtp at 4.18.0.

Changed

Bump eclipse-jdt default version from 4.17.0 to 4.18.0.
Bump eclipse-wtp default version from 4.17.0 to 4.18.0.
Bump ktfmt default version from 0.16 to 0.19 (#748 and #773).

Fixed

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).
No longer declare inputs on SpotlessCheck and SpotlessApply since they don't have any outputs (worker task still does up-to-date and caching) (#741).

[5.8.2] - 2020-11-16

Fixed

Fixed a bug which occurred if the root directory of the project was also the filesystem root (#732)

[5.8.1] - 2020-11-13

Fixed

Bump JGit from 5.8.0 to 5.9.0 to improve performance (#726)

[5.8.0] - 2020-11-12

Added

Added support to npm-based steps for picking up .npmrc files (#727)

[5.7.0] - 2020-10-20

Added

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

Changed

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

[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 (diffplug#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).