unexpected changes in 3.8.4

[mr-git]

Required: Configuration

Please paste the smallest possible set of .scalafmt.conf
configuration parameters that reproduces the problem:

version = 3.8.4
...

Steps

Given code like this:

case class X(
  field: Int
)

Problem

Scalafmt formats code like this:

case class X(
    field: Int
)

There are extra 2 spaces added before field: Int

Expectation

I would like the formatted output to look like this:

case class X(
  field: Int
)

Workaround

Have to add extra config:

indent.defnSite = 2

[kitbellew]

@mr-git what kind of fix are you requesting, specifically? restore the bug that was there before?

[mr-git]

oh, I didn't expected that the default was intended to be 4.

[ekrich]

I am getting unexpected doc changes too. I can create another issue if needed. https://github.com/ekrich/sconfig/pull/416/files

[kitbellew]

I am getting unexpected doc changes too. I can create another issue if needed. https://github.com/ekrich/sconfig/pull/416/files

@ekrich yes, please, separate issue.

[kitbellew]

I am getting unexpected doc changes too. I can create another issue if needed. https://github.com/ekrich/sconfig/pull/416/files

@ekrich correction: for these changes, there's an issue submitted already. but you need to change

`Config}

to

`Config`

yourself.

[kitbellew]

i am closing this particular issue since it refers to a bug that had been properly fixed.

[mr-git]

Only now I found the https://scalameta.org/scalafmt/docs/configuration.html#indentdefnsite and I've missed that 4 years ago in c61232c config name changed from continuationIndent to indent, but behaviour didn't change. Most of our projects have continuationIndent.defnSite = 2 😞

[kitbellew]

Only now I found the https://scalameta.org/scalafmt/docs/configuration.html#indentdefnsite and I've missed that 4 years ago in c61232c config name changed from continuationIndent to indent, but behaviour didn't change. Most of our projects have continuationIndent.defnSite = 2 😞

are you saying that continuationIndent.defnSite = 2 is not taking effect (it should)?
it wouldn't have been evident since you pasted your configuration file as

version = 3.8.4
...

[mr-git]

probably something else is affecting the formatting in our case...

Our config is:

project.git = true

version = 3.8.3

maxColumn = 120

trailingCommas = always

continuationIndent {
  callSite = 2
  defnSite = 2
}

align.preset = some
align.tokenCategory {
  LeftArrow = Assign
  Equals = Assign
}
# Mostly subset of `align.preset=more`, but with extra settings for `=`
# For all settings see `AlignToken#default` in
# https://github.com/scalameta/scalafmt/blob/master/scalafmt-core/shared/src/main/scala/org/scalafmt/config/AlignToken.scala
align.tokens."+" = [
  { code = "%", owner = "Term.ApplyInfix" }  # This is for Dependencies.scala…
  { code = "%%", owner = "Term.ApplyInfix" } # … and this as well.
  { code = "%%%", owner = "Term.ApplyInfix" } # … and this as well.
  { code = "=>", owner = "(Case|Term.Function)" }
  { code = "<-", owner = "Enumerator.Generator" }
  { code = "=", owner = "(Defn.Val|Defn.Var|Type|Def|Enumerator.Val|Assign|Term.Param)" } # Defn.Val is mostly for Dependencies.scala,
  { code = "->", owner = "Term.ApplyInfix" }
]

newlines.implicitParamListModifierPrefer = before
newlines.beforeCurlyLambdaParams = multilineWithCaseOnly

indentOperator.topLevelOnly = true

docstrings.blankFirstLine = keep

includeCurlyBraceInSelectChains = true
includeNoParensInSelectChains = true
optIn.breakChainOnFirstMethodDot = true

runner.dialect = Scala213Source3
fileOverride {
  "glob:**/*.sbt" { runner.dialect = sbt1 }
}

When I change version to 3.8.4, all multi-line case class and function definitions get reformatted, which is unexpected.

When I replace continuationIndent with indent, I get expected formatting for case classes and function definitions.

I cannot repeat the issue on Scala 3 project with smaller config:

project.git = true

version = 3.8.4

maxColumn = 120

trailingCommas = always

continuationIndent {
  callSite = 2
  defnSite = 2
}

preset = default
align.preset = none

runner.dialect = Scala3
fileOverride {
  "glob:**/*.sbt" { runner.dialect = sbt1 }
}

Could it be, that something else affects application of continuationIndent when runner.dialect = Scala213Source3? Maybe some extra customization in first config blocks application of continuationIndent?

[mr-git]

Honestly, I was not fully aware how the scalafmt config is defined - I inherited the project with config and made [wrong] assumption that default indent is 2 🤷

[kitbellew]

probably something else is affecting the formatting in our case...

Our config is:

project.git = true

version = 3.8.3

maxColumn = 120

trailingCommas = always

continuationIndent {
  callSite = 2
  defnSite = 2
}

align.preset = some
align.tokenCategory {
  LeftArrow = Assign
  Equals = Assign
}
# Mostly subset of `align.preset=more`, but with extra settings for `=`
# For all settings see `AlignToken#default` in
# https://github.com/scalameta/scalafmt/blob/master/scalafmt-core/shared/src/main/scala/org/scalafmt/config/AlignToken.scala
align.tokens."+" = [
  { code = "%", owner = "Term.ApplyInfix" }  # This is for Dependencies.scala…
  { code = "%%", owner = "Term.ApplyInfix" } # … and this as well.
  { code = "%%%", owner = "Term.ApplyInfix" } # … and this as well.
  { code = "=>", owner = "(Case|Term.Function)" }
  { code = "<-", owner = "Enumerator.Generator" }
  { code = "=", owner = "(Defn.Val|Defn.Var|Type|Def|Enumerator.Val|Assign|Term.Param)" } # Defn.Val is mostly for Dependencies.scala,
  { code = "->", owner = "Term.ApplyInfix" }
]

newlines.implicitParamListModifierPrefer = before
newlines.beforeCurlyLambdaParams = multilineWithCaseOnly

indentOperator.topLevelOnly = true

docstrings.blankFirstLine = keep

includeCurlyBraceInSelectChains = true
includeNoParensInSelectChains = true
optIn.breakChainOnFirstMethodDot = true

runner.dialect = Scala213Source3
fileOverride {
  "glob:**/*.sbt" { runner.dialect = sbt1 }
}

When I change version to 3.8.4, all multi-line case class and function definitions get reformatted, which is unexpected.

When I replace continuationIndent with indent, I get expected formatting for case classes and function definitions.

I cannot repeat the issue on Scala 3 project with smaller config:

project.git = true

version = 3.8.4

maxColumn = 120

trailingCommas = always

continuationIndent {
  callSite = 2
  defnSite = 2
}

preset = default
align.preset = none

runner.dialect = Scala3
fileOverride {
  "glob:**/*.sbt" { runner.dialect = sbt1 }
}

Could it be, that something else affects application of continuationIndent when runner.dialect = Scala213Source3? Maybe some extra customization in first config blocks application of continuationIndent?

i don't see anything that springs at me. is your case available to check out and try? paldies.

[mr-git]

you can try with https://github.com/evolution-gaming/kafka-journal, I just tried to update version to 3.8.4 and ran fmt alisas in SBT - all case classes and function definitions were reformatted.

[mr-git]

evolution-gaming/kafka-journal#711 - PR for upgrade to 3.8.4 - it, unexpectedly, affected 128 files :(