Skip to content

Latest commit

 

History

History
741 lines (611 loc) · 52.5 KB

CHANGES.md

File metadata and controls

741 lines (611 loc) · 52.5 KB

spotless-lib and spotless-lib-extra releases

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

[Unreleased]

Changes

  • POTENTIALLY BREAKING Bump bytecode from Java 8 to 11 (#1530 part 2 of #1337)
  • POTENTIALLY BREAKING sortByKeys for JSON formatting now takes into account objects inside arrays (#1546)

[2.34.0] - 2023-01-26

Added

  • Formatter now has a field public static final File NO_FILE_SENTINEL which can be used to pass string content to a Formatter or FormatterStep when there is no actual File to format. (#1525)

[2.33.0] - 2023-01-26

Added

  • ProcessRunner has added some convenience methods so it can be used for maven testing. (#1496)
  • ProcessRunner allows to limit captured output to a certain number of bytes. (#1511)
  • ProcessRunner is now capable of handling long-running tasks where waiting for exit is delegated to the caller. (#1511)
  • Allow to specify node executable for node-based formatters using nodeExecutable parameter (#1500)

Fixed

  • 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, next release likely to bump bytecode to Java 11 (#1514 part 1 of #1337)
  • Rename YamlJacksonStep into JacksonYamlStep while normalizing Jackson usage (#1492)
  • Convert gson integration to use a compile-only source set (#1510).
  • ** 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.
  • NpmFormatterStepStateBase delays npm install call until the formatter is first used. This 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)

[2.32.0] - 2023-01-13

Added

  • Add option editorConfigFile for ktLint #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).
  • Add YAML support through Jackson (#1478)
  • 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

  • Support ktlint 0.48+ new rule disabling syntax (#1456) fixes (#1444)
  • Fix subgroups leading catch all matcher.

Changes

  • Bump default version for prettier from 2.0.5 to 2.8.1 (#1453)
  • Bump the dev version of Gradle from 7.5.1 to 7.6 (#1409)
    • We also removed the no-longer-required dependency org.codehaus.groovy:groovy-xml
  • Breaking changes to Spotless' internal testing infrastructure testlib (#1443)
    • ResourceHarness no longer has any duplicated functionality which was also present in StepHarness
    • StepHarness now operates on Formatter rather than a FormatterStep
    • StepHarnessWithFile now takes a ResourceHarness in its constructor to handle the file manipulation parts
    • Standardized that we test exception messages, not types, which will ease the transition to linting later on
    • Bump default ktlint version to latest 0.47.1 -> 0.48.1 (#1456)
  • Switch our publishing infrastructure from CircleCI to GitHub Actions (#1462).
    • Help wanted for moving our tests too (#1472)

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

[2.31.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
  • Share git repositories across projects when using ratchet (#1426)

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)

[2.30.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

[2.29.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)
    • Converted scalafmt integration to use a compile-only source set (fixes #524)

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)

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

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

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

[2.26.2] - 2022-06-11

Fixed

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

[2.26.1] - 2022-06-10

Fixed

  • (Second try) googleJavaFormat and removeUnusedImports works on JDK16+ without jvm args workaround. (#1228)

[2.26.0] - 2022-06-05

Added

  • Support for editorConfigOverride in ktlint. (#1218 fixes #1193)

Fixed

  • google-java-format and RemoveUnusedImportsStep works on JDK16+ without jvm args workaround. (#1224 fixes #834)

[2.25.3] - 2022-05-10

Fixed

  • Update the black version regex to fix 19.10b0 and earlier. (fixes #1195, regression introduced in 2.25.0)
  • GitAttributesLineEndings$RelocatablePolicy and FormatterStepImpl now null-out their initialization lambdas after their state has been calculated, which allows GC to collect variables which were incidentally captured but not needed in the calculated state. (#1198)

Changes

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

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

[2.25.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.

[2.25.0] - 2022-04-22

Added

  • Added support for enabling ktlint experimental ruleset. (#1145)

Fixed

  • Fixed support for Python Black's new version reporting. (#1170)
  • Error messages for unexpected file encoding now works on Java 8. (fixes #1081)

Changes

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

[2.24.2] - 2022-04-06

Fixed

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

[2.24.1] - 2022-03-30

Fixed

  • Fixed access modifiers for setters in KtfmtStep configuration

[2.24.0] - 2022-03-28

Added

  • Added support for setting custom parameters for Kotlin ktfmt in Gradle and Maven plugins. (#1145)

[2.23.0] - 2022-02-15

Added

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

Changed

  • Use SLF4J for logging (#1116)

[2.22.2] - 2022-02-09

Changed

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

Fixed

  • Add full support for git worktrees (#1119).

[2.22.1] - 2022-02-01

Changed

  • Bump CI from Java 15 to 17 (#1094).
  • 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)

[2.22.0] - 2022-01-13

Added

[2.21.2] - 2022-01-07

Fixed

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

[2.21.1] - 2022-01-06

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.

[2.21.0] - 2021-12-23

Added

  • Added support for Markdown with flexmark at 0.62.2 (#1011).

[2.20.3] - 2021-12-15

Fixed

  • Performance improvements to GitRatchet (#1038).

[2.20.2] - 2021-12-05

Changed

  • Bumped default ktlint from 0.43.0 to 0.43.2.
  • Converted ktlint integration to use a compile-only source set. (#524)

[2.20.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

[2.20.0] - 2021-11-09

Added

  • DiffMessageFormatter can now generate messages based on a folder of cleaned files, as an alternative to a Formatter (#982).

Fixed

  • Fix CI and various spotbugs nits (#988).

Changed

  • 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

[2.19.2] - 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.

[2.19.1] - 2021-10-13

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)

[2.19.0] - 2021-10-02

  • Added wildcardsLast option for Java ImportOrderStep (#954)

Added

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

[2.18.0] - 2021-09-30

Added

  • Added support for custom JSR223 formatters (#945)
  • Added support for formatting and sorting Maven POMs (#946)

[2.17.0] - 2021-09-27

Added

  • Added support for calling local binary formatters (#949)

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)

[2.16.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

[2.16.0] - 2021-09-04

Added

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

[2.15.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
  • Fix javadoc publishing (#916 fixes #775).

[2.15.2] - 2021-07-20

Fixed

[2.15.1] - 2021-07-06

Changed

[2.15.0] - 2021-06-17

Added

[2.14.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.

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

[2.13.4] - 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)

[2.13.3] - 2021-04-20

Fixed

  • LicenseHeaderStep treats address as copyright year (#716)

[2.13.2] - 2021-04-12

Fixed

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

[2.13.1] - 2021-04-10

Changed

  • Update default google-java-format from 1.9 to 1.10.0
  • Expose configuration exceptions from scalafmt (#837)

[2.13.0] - 2021-03-05

Added

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

[2.12.1] - 2021-02-16

Fixed

  • Allow licence headers to be blank (#801).

[2.12.0] - 2021-02-09

Added

  • Support for diktat (#789)

[2.11.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).
  • Bump jgit from 5.9 to 5.10 (#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).
  • Fixed typo in javadoc comment for SQL_FORMATTER_INDENT_TYPE (#753).

[2.10.2] - 2020-11-16

Fixed

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

[2.10.1] - 2020-11-13

Fixed

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

[2.10.0] - 2020-11-02

Added

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

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

[2.8.0] - 2020-10-05

Added

  • Exposed new methods in GitRatchet to support faster ratcheting in the maven plugin (#706).

[2.7.0] - 2020-09-21

Added

  • PipeStepPair.Builder now has a method .buildStepWhichAppliesSubSteps(Path rootPath, Collection<FormatterStep> steps), which returns a single FormatterStep that applies the given steps within the regex defined earlier in the builder. Used for formatting inception (implements #412).

[2.6.2] - 2020-09-18

Fixed

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

[2.6.1] - 2020-09-12

Fixed

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

[2.6.0] - 2020-09-11

Added

  • PipeStepPair which allows extracting blocks of text in one step, then injecting those blocks back in later. Currently only used for spotless:off spotless:on, but could also be used to apply different steps in different places (#691).

Changed

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

[2.5.0] - 2020-09-08

Added

  • GoogleJavaFormatStep.defaultVersion() now returns 1.9 on JDK 11+, while continuing to return 1.7 on earlier JDKs. This is especially helpful to RemoveUnusedImportsStep, since it always uses the default version of GJF (fixes #681).

Fixed

  • We now run all tests against JDK 8, JDK 11, and also JDK 14 (#684).
  • We had test files in testlib/src/main/resources named module-info.java and package-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).

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

[2.3.0] - 2020-08-25

Added

  • 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 as ofDangerous, but it should not be used outside of a testing situation. There are some legacy usages of ofDangerous in the codebase, and it would be nice to fix them, but the existing usages are using it safely.

[2.2.2] - 2020-08-21

Fixed

  • KtLintStep is now more robust when parsing version string for version-dependent implementation details, fixes #668.

[2.2.1] - 2020-08-05

Fixed

  • FormatterFunc.Closeable had a "use after free" bug which caused errors in the npm-based formatters (e.g. prettier) if spotlessCheck was called on dirty files. (#651)

Changed

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

[2.2.0] - 2020-07-13

Added

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

[2.1.0] - 2020-07-04

Added

  • FileSignature.machineIsWin(), to replace the now-deprecated LineEnding.nativeIsWin(), because it turns out that \r\n is not a reliable way to detect the windows OS (#639).

Fixed

  • GitAttributesLineEndings was fatally broken (always returned platform default), and our tests missed it because they tested the part before the broken part (#639).

[2.0.0] - 2020-07-02

Changed

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

Added

  • 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)
  • GitRatchet now lives in lib-extra, and is shared across plugin-gradle and plugin-maven (#626).
  • Added ANTLR4 support (#326).
  • FormatterFunc.NeedsFile for implementing file-based formatters more cleanly than we have so far (#637).

Changed

  • 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)
    • This change allows the maven plugin to cache classloaders across subprojects when loading config resources from the classpath (fixes #559).
    • This change also allows the gradle plugin to work with the remote buildcache (fixes #280).
  • BREAKING FormatterFunc no longer extends ThrowingEx.Function and BiFunction. In a major win for Java's idea of "target typing", this required no changes anywhere in the codebase except deleting the extends part of FormatterFunc (#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 and lib-extra.
    • #629 removes the code which wasn't being used in plugin-gradle or plugin-maven.
    • #630 moves the code which was still being used in deprecated parts of plugin-gradle into .deprecated package in plugin-gradle, which allows us to break lib without a breaking change in plugin-gradle.

[1.34.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
  • Our main branch is now called main. (#613)

[1.34.0] - 2020-06-05

Added

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

[1.33.1] - 2020-06-04

  • We are now running CI on windows. (#596)
  • We are now dogfooding ratchetFrom and licenseHeader 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(), and FileSignature.pathUnixToNative(), along with many API-invisible fixes and cleanup. (#592)

[1.33.0] - 2020-06-03

Added

  • LicenseHeaderStep now has an updateYearWithLatest 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 on ratchetFrom.

[1.32.0] - 2020-06-01

Added

  • NodeJsGlobal.setSharedLibFolder allows to set the location of nodejs shared libs. (#586)
  • PaddedCell.isClean() returns the instance of PaddedCell.DirtyState which represents clean. (#590)

Fixed

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

[1.31.0] - 2020-05-21

Added

  • PaddedCell.calculateDirtyState is now defensive about misconfigured character encoding. (#575)

[1.30.1] - 2020-05-17

Fixed

  • PaddedCell.DirtyState::writeCanonicalTo(File) can now create a new file if necessary (previously required to overwrite an existing file) (#576).

[1.30.0] - 2020-05-11

Added

  • PaddedCell.calculateDirtyState(Formatter, File, byte[]) to allow IDE integrations to send dirty editor buffers.

[1.29.0] - 2020-05-05

Added

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

Changed

  • 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

[1.28.1] - 2020-04-02

Fixed

  • Javadoc for the ext/eclipse-* projects.
  • Replace the deprecated compile with implementation for the ext/eclipse-* projects.

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

Build

  • 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 to main, 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)

[1.27.0] - 2020-01-01

  • 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)
  • Deprecated SpotlessCache.clear() in favor of the new SpotlessCache.clearOnce(Object key). (#501)

[1.26.1] - 2019-11-27

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

[1.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)
  • 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 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)
  • Automatically configure import order for IntelliJ IDEA with .editorconfig (#486)

[1.25.0] - 2019-10-06

  • Add support for ktlint 0.34+, and bump default version from 0.32.0 to 0.34.2. (#469)

[1.24.3] - 2019-09-23

  • Update jgit from 5.3.2.201906051522-r to 5.5.0.201909110433-r. (#445)
  • 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 from 1.1.0 to 2.0.1, since there are bugs in the old default (#458).

[1.24.1] - 2019-08-12

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

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

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

[1.23.0] - 2019-04-24

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

[1.22.0] - 2019-04-15

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

[1.21.1] - 2019-03-29

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

[1.21.0] - 2019-03-28

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

[1.20.0] - 2019-03-11

  • Made npm package versions of prettier and tsfmt (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 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.

[1.19.0] - 2019-03-11

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 than http (#360).
  • Updated default eclipse-jdt from 4.9.0 to 4.10.0 (#368)

[1.18.0] - 2019-02-11

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

[1.17.0] - 2018-10-30

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

[1.16.0] - 2018-10-30

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

[1.15.0] - 2018-09-23

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 implements AutoCloseable. This means that users of Formatter are expected to use the try-with-resources pattern. The reason for this change is so that FormatterFunc.Closeable actually works. (#284)* Added prettier and tsfmt support, as well as general infrastructure for calling nodeJS code using j2v8 (#283).

[1.14.0] - 2018-07-24

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

[1.13.0] - 2018-06-01

  • Add line and column numbers to ktlint errors. (#251)

[1.12.0] - 2018-05-14

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

[1.11.0] - 2018-02-26

  • Added default indentation of 4 to IndentStep. (#209)

[1.10.0] - 2018-02-15

  • LicenseHeaderStep now supports customizing the year range separator in copyright notices. (#199)
  • Breaking change to testlib - removed ResourceHarness.write and added ResourceHarness.[set/assert]File for easier-to-read tests. (#203)

[1.9.0] - 2018-02-05

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

[1.8.0] - 2018-01-02

  • LicenseHeaderStep now supports time-aware copyright notices in license headers. (#179, thanks to @baptistemesta)

[1.7.0] - 2018-12-02

  • Updated default eclipse-jdt version to 4.7.1 from 4.6.3.
  • Updated jgit from 4.5.0.201609210915-r to 4.9.0.201710071750-r.
  • Updated concurrent-trees from 2.6.0 to 2.6.1 (performance improvement).
  • Added dbeaverSql formatter step, for formatting sql scripts. (#166)

[1.6.0] - 2017-09-29

  • Added public static boolean PaddedCell::applyAnyChanged(Formatter formatter, File file).

[1.5.1] - 2017-08-14

  • Added KtLintStep.createForScript.

[1.5.0] - 2017-08-13

  • Deprecated ImportOrderStep.createFromOrder(List<String> in favor of (String....

[1.4.1] - 2017-07-11

  • Default eclipse version for EclipseFormatterStep bumped to 4.6.3 from 4.6.1. (#116)
  • Default scalafmt version for ScalaFmtStep bumped to 1.1.0 from 0.5.7 (#124)
    • Also added support for the API change to scalafmt introduced in 0.7.0-RC1

[1.4.0] - 2017-05-21

  • ImportOrderStep can now handle multi-line comments and misplaced imports.
    • Especially helpful for Groovy and Gradle files.

[1.3.2] - 2017-05-03

  • Fixed a bug in PaddedCellBulk.check() which caused a check to fail even after an apply for cases which caused CYCLE.

[1.3.0] - 2017-04-11

  • 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 into plugin-gradle where it belongs.

[1.2.0] - 2017-04-03

  • Deprecated FileSignature.from in favor of FileSignature.signAsSet and the new FileSignature.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 in com.github.shyiko (note the t).

[1.1.0] - 2017-02-27

  • 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,

[1.0.0] - 2017-01-09

  • Initial release!