Add documentation for majorScalaVersion

diffplug · Aug 23, 2022 · 30d72d8 · 30d72d8
1 parent 677415e
commit 30d72d8
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -12,6 +12,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Changes
 * Converted `scalafmt` integration to use a compile-only source set. (fixes [#524](https://github.com/diffplug/spotless/issues/524))
+* `scalafmt` integration now has a configuration option `majorScalaVersion` that allows you to configure the Scala version that gets resolved from the maven artifact. [#1283](https://github.com/diffplug/spotless/pull/1283)
 * Add the `ktlint` rule in error messages when `ktlint` fails to apply a fix ([#1279](https://github.com/diffplug/spotless/pull/1279))
 
 ## [2.28.1] - 2022-08-10

diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md
@@ -388,8 +388,8 @@ spotless {
 ```gradle
 spotless {
   scala {
-    // version and configFile are both optional
-    scalafmt('2.6.1').configFile('scalafmt.conf')
+    // version and configFile, majorScalaVersion are all optional
+    scalafmt('2.6.1').configFile('scalafmt.conf').majorScalaVersion('2.13')
 ```
 
 <a name="applying-to-cc-sources"></a>

diff --git a/plugin-maven/README.md b/plugin-maven/README.md
@@ -395,6 +395,7 @@ Groovy-Eclipse formatting errors/warnings lead per default to a build failure. T
 <scalafmt>
   <version>2.0.1</version>              <!-- optional -->
   <file>${project.basedir}/scalafmt.conf</file> <!-- optional -->
+  <majorScalaVersion>2.13</majorScalaVersion> <!-- optional -->
 </scalafmt>
 ```