scalafmtCheck not accepting formatted code

[fdietze]

addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "1.6.0-RC3")

(default configuration)

In my sbt project I have several (heavily reduced) scala-files. When I run scalafmt and then scalafmtCheck, These files get reported as not being properly formatted. The second one only gets reported after the first one is changed to be properly formatted.

object MainViewParts {

  val syncModeSwitcher =
    span(
      state.syncMode
        .map {
          mode =>
            span(
              title := "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              onClick
                .map(
                  _ =>
                    (if (mode == SyncMode.Live) SyncMode.Local
                     else SyncMode.Live): SyncMode
                ) --> state.syncMode
            )
        }
    )

}

Shortening the string makes this one work.

object TestView extends View {
  override def apply() = {
    div(
      div(
        (5 to 5).map { res => 5},
        //
      )
    )
  }
}

Removing the comment makes this one work.

object ViewConfigParser {
  val page: P[Page] = P( pageMode ~/ (pageSeparator ~/ nodeIdList ~ (pageSeparator ~ nodeIdList).?).? ~/ (urlSeparator | End) )
    .map {
      case x => Page()
    }
}

Do you need more examples?

[olafurpg]

Thanks for reporting! I am unable to reproduce, I tried both with the cli and sbt plugin.

Can you please update https://github.com/olafurpg/repro-scalafmt/blob/master/src/main/scala/Issue1231.scala with an input that reproduces the issue?

[fdietze]

This was hard to find out: running scalafmt a second time in the same sbt session doesn't do anything. (see olafurpg/repro-scalafmt#1)

When running it twice in different sbt sessions, my whole project passes the checks.

[tanishiking]

I took a stub at this issue and found that these regressions are caused by idempotency violations (not an issue of sbt-scalafmt)

When running it twice in different sbt sessions, my whole project passes the checks.

The cause of this phenomenon is an idempotency violation and sbt.
Since sbt seems cache the unmanagedSources in scalafmt in a same session, scalafmtCheck after running scalafmt twice in a same sbt session will fail because of idempotency violation.
(On the other hand, we can pass scalafmtCheck after we run scalafmt twice in the different sbt sessions because the cache is purged on second scalafmt (in different sbt session))

---

By the way, I tried to fix the violations reported in #1231 (comment)

• object MainViewParts { ...
  • I couldn't reproduce this...
• object TestView extends View { ...
  • I found that this was caused by trailingCommas: always behaves incorrectly for comments with alignment whitespace #1254 and has been fixed in Fix trailing commas always/never not to put/delete trailing comma on incorrect location #1262
  • I added a test Add test for preserving location of comment when removing trailing comma #1296
• object ViewConfigParser { ...
  • I added the following test

<<< test
object ViewConfigParser {
  val page: P[Page] = P( pageMode ~/ (pageSeparator ~/ nodeIdList ~ (pageSeparator ~ nodeIdList).?).? ~/ (urlSeparator | End) ).
  map {
    case x => Page()
  }
}
>>>
object ViewConfigParser {
  val page: P[Page] =
    P(pageMode ~/ (pageSeparator ~/ nodeIdList ~ (pageSeparator ~ nodeIdList).?).? ~/ (urlSeparator | End))
      .map {
        case x => Page()
      }
}

and got the following diff

[info] - newdefault/ColumnWidth.stat: test                                     | *** FAILED ***
[info]   Idempotency violated
[info]
[info]   ===========
[info]   => Obtained
[info]   ===========
[info]   object ViewConfigParser {
[info]     val page: P[Page] = P(
[info]       pageMode ~/ (pageSeparator ~/ nodeIdList ~ (pageSeparator ~ nodeIdList).?).? ~/ (urlSeparator | End)
[info]     ).map {
[info]       case x => Page()
[info]     }
[info]   }
[info]
[info]
[info]   =======
[info]   => Diff
[info]   =======
[info]      ).map {
[info]   -    case x => Page()
[info]   -  }
[info]   +      case x => Page()
[info]   +    }
[info]    } (FormatTests.scala:79)

I know the redundant indentations are caused by

scalafmt/scalafmt-core/shared/src/main/scala/org/scalafmt/internal/Router.scala

Line 697 in eae26c9

.withIndent(indent, close, Right),

(indentation for P( ... ) which has too long columns add redundant indentation indentation on case x => Page() and }), but the logic for caluculating the indentation is too complicated for me to fix the idempotency violation without breaking other test cases...
As #1278 (review), we may we want to invest our efforts in #917

[dwijnand]

Is this still present in 2.0.0-RC4?

[joan38]

@dwijnand 2.0.0-RC4 of what?

[dwijnand]

Scalafmt

[joan38]

Indeed I didn't notice that 2.x RC series were out.
Anybody knows if it's fixed?

[Krever]

I just run into it with plugin in version 2.0.0 and version = "2.0.0-RC6" in conf file. Gladly executing clean solved the issue.

[poslegm]

Is it still actual? I can't reproduce

[fdietze]

Not sure, I'm not using scalafmt at the moment. And if you can't reproduce, it might be a sign that this issue is fixed. :)