New scalafmt sbt plugin #1085

vovapolu · 2017-11-30T12:19:19Z

I renamed old plugin to sbt-cli-scalafmt, because it just calls cli interface (and because I couldn't come up with new name for my plugin :D). I also added new scripted tests in addition to old ones.

Plugin doesn't perform any caching, it just looks to unmanagedSources or sbt files and formats them. *Check tasks throw exceptions and print error messages when check is failed.

sjrd

The *Check tasks should definitely throw exceptions (MessageOnlyExceptions), otherwise they are not usable in the CI since they do not cause a non-zero exit code, hence do not fail the build.

sjrd · 2017-11-30T12:27:30Z

build.sbt

+    moduleName := "sbt-scalafmt",
+    isOnly(scala212),
+    sbtPlugin := true,
+    sbtVersion in Global := "1.0.0"


Don't put settings in Global in the settings of a project. It is extremely confusing as that affects the whole build, not just the project. It makes no sense.

old plugin has this setting too :)

Then fix the old plugin too ;)

This is effectively defining which sbt version the plugin targets, rather than defaulting whatever sbt version you're using for the whole build as defined in build.properties. I've used this in the past to ensure my plugin works on old versions of sbt while using the latest version to build the plugin.

sjrd · 2017-11-30T12:30:27Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    lazy val scalafmtOnCompile =
+      SettingKey[Boolean]("scalafmt-on-compile", "Format source when compiling")
+    lazy val scalafmtConfig =
+      TaskKey[File]("scalafmt-config", "Scalafmtter config file")


typo: Scalafmtter

sjrd · 2017-11-30T12:31:52Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      SettingKey[Boolean]("scalafmt-on-compile", "Format source when compiling")
+    lazy val scalafmtConfig =
+      TaskKey[File]("scalafmt-config", "Scalafmtter config file")
+    lazy val scalafmtSbt = TaskKey[Unit]("scalafmt-sbt", "Format SBT sources")


The - separated names is a relic of sbt 0.12, not to be used in sbt 1 anymore. This should be named scalafmtSbt, just like the val. In fact, you should probably use taskKey[Unit]("Format sbt sources") instead. Same for the other keys (e.g., scalafmtCheck).

sjrd · 2017-11-30T12:36:23Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    (BuildPaths.projectStandard(proj.base) * GlobFilter("*.scala")).get)
+
+  lazy val scalafmtSettings: Seq[Def.Setting[_]] = Seq(
+    scalafmtOnCompile := false,


This particular default value should be set in the override def buildSettings of the AutoPlugin, so that it is easy for people to just set it for all their projects with scalafmtOnCompile in ThisBuild := true.

Better yet, in global settings. http://www.scala-sbt.org/1.0/docs/Plugins.html#projectSettings+and+buildSettings

No, I think this one should be in ThisBuild. If you have ProjectRefs to other directories outside your build, you don't want those to get reformatted when they're compiled.

Right, that's why false is the right default. But rather than define it for every build in the state, just define it once globally, then independent builds (or specific projects) can opt into formatting on compile.

sjrd · 2017-11-30T12:38:04Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  private lazy val projectSources = thisProject.map(proj =>
+    (BuildPaths.projectStandard(proj.base) * GlobFilter("*.scala")).get)
+
+  lazy val scalafmtSettings: Seq[Def.Setting[_]] = Seq(


I recommend calling this scalafmtConfigSettings, to make clear that they are meant to go through an inConfig(...) to be meaningful.

sjrd · 2017-11-30T12:39:42Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  lazy val scalafmtSettings: Seq[Def.Setting[_]] = Seq(
+    scalafmtOnCompile := false,
+    scalafmt := formatSources(
+      unmanagedSources.value,


You should read (unmanagedSources in scalafmt).value instead, so that it is possible to override the set of files processed by scalafmt independently of the sources given to the compiler. In complex builds, this can be necessary.

I think it's possible to do something like unmanagedSources.in(scalafmt).or(unmanagedSources).value so that it defaults to unmanagedSources if it's not defined when scoped under the scalafmt task.

(unmanagedSources in scalafmt).value automatically defaults to unmanagedSources.value if the former is not defined. You don't need to do anything for that, it's built in the scopes mechanism.

sjrd · 2017-11-30T12:40:51Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    },
+    scalafmtCheck :=
+      checkSources(
+        unmanagedSources.value,


Same: (unmanagedSources in scalafmt).value (not in scalafmtCheck in this case, because scalafmtCheck should always apply on the same set of sources as scalafmt).

sjrd · 2017-11-30T12:43:37Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      checkSources(sbtSources.value, sbtConfig.value, streams.value.log)
+      checkSources(projectSources.value, scalaConfig.value, streams.value.log)
+    },
+    compile := Def.taskDyn {


The very presence of this taskDyn will destroy inspect tree myProject/compile. Please don't do this.

I don't think there is any 100% correct way to do this, but I suspect doing the same as sbt-scalariform should be least controversial https://github.com/sbt/sbt-scalariform/blob/b33f32b43bd267a3b5e2b26a5962a77182709f52/src/main/scala/com/typesafe/sbt/SbtScalariform.scala#L82-L87 override compileInputs and move the dynTask to only cover the scalafmt-related parts

sjrd · 2017-11-30T12:44:00Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    compile := Def.taskDyn {
+      val defaultCompile = compile.taskValue
+      if (scalafmtOnCompile.value) {
+        scalafmt.value


This unconditionally applies scalafmt even when scalafmtOnCompile is false.

olafurpg

Nice work! Thanks a lot @sjrd for the review.

I left some comments.

olafurpg · 2017-11-30T13:09:18Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  lazy val scalafmtSettings: Seq[Def.Setting[_]] = Seq(
+    scalafmtOnCompile := false,
+    scalafmt := formatSources(
+      unmanagedSources.value,


I think it's possible to do something like unmanagedSources.in(scalafmt).or(unmanagedSources).value so that it defaults to unmanagedSources if it's not defined when scoped under the scalafmt task.

olafurpg · 2017-11-30T13:11:49Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  }
+  import autoImport._
+
+  private lazy val scalaConfig =


Call this scalafmtConfigParsed instead?

this means that if the config file changes, sbt needs to be restarted. It would be more idiomatic to assign this to a Task that can be cached based on the file.

scalafmtConfig is a TaskKey[File], and this is calling map on it, which will return an Def.Initialize[Task[Configured[ScalafmtConfig]]] (if I understand correctly) so it's ok.

olafurpg · 2017-11-30T13:14:07Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  import autoImport._
+
+  private lazy val scalaConfig =
+    scalafmtConfig.map(Config.fromHoconFile(_).get)


.get throws an exception on failure with full stacktrace, I think we can throw new MessageOnlyException(e.getMessage) to avoid the stack trace

olafurpg · 2017-11-30T13:19:59Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  private lazy val scalaConfig =
+    scalafmtConfig.map(Config.fromHoconFile(_).get)
+  private lazy val sbtConfig =
+    scalaConfig.map(conf => conf.copy(runner = conf.runner.forSbt))


This would actually be nice to have in the public facing API. Can we move this to ScalafmtConfig.forSbt as well as add a forwarder method Scalafmt.configForSbt exactly like is done here here

scalafmt/scalafmt-core/shared/src/main/scala/org/scalafmt/Scalafmt.scala

Line 81 in 49815ab

def configWithDialect(

The forwarder method is there for binary compatibility reasons since ScalafmtConfig can break binary compatibility.

olafurpg · 2017-11-30T13:20:35Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  private lazy val sbtConfig =
+    scalaConfig.map(conf => conf.copy(runner = conf.runner.forSbt))
+
+  private type Input = String


This does not help readability IMO, either create a value class or use String.

@dwijnand Why did you put a dislike here?

Just because I disagree (even if the type Input is just an alias, I think it's can be useful to have such aliases).

My view is that you might as well make it a value class then, a type alias like this gives a false sense of type safety

well, it's 2 vs 2, so I leave it :)

olafurpg · 2017-11-30T13:23:18Z

scalafmt-cli-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      Command.args("scalafmt", "run the scalafmt command line interface.") {
+        case (state, args) =>
+          org.scalafmt.cli.Cli.main("--non-interactive" +: args.toArray)
+          PlatformTokenizerCache.megaCache.clear()


You want to run this in the new plugin too, megaCache will eventually go away but for now it's best to call it on every file. scalameta/scalameta#1068

Call on every file? Your plugin calls it once at start.

And when I should call it? Even when I check source or only when format?

It's a bit trickier to decide compared to the cli, but I think we can do it once per config/project. This should ideally run whenever scalafmt is not running, otherwise it shoudl be a well-behaving cache and the only penalty for clearing it too often is a very minor slowdown hit.

olafurpg · 2017-11-30T13:24:18Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      onError: (File, Throwable) => T,
+      onFormat: (File, Input, Output) => T
+  ): Seq[Option[T]] = {
+    sources.map(


This formats files sequentially, for large projects it may pay off to do .par.map, but I'll leave it to you to decide.

we'll get parallelism for free across projects / configs because of the way sbt works, it's not so clear that parallelism at this level will improve performance. let's measure first.

right, since the plugin works at the granularity of project/config then you already get parallelism there. In the cli we use .par to run on all files in the repo

fommil · 2017-11-30T13:26:55Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

-          org.scalafmt.cli.Cli.main("--non-interactive" +: args.toArray)
-          PlatformTokenizerCache.megaCache.clear()
-          state
+    lazy val scalafmt = TaskKey[Unit]("scalafmt", "Format Scala sources")


these don't need to be lazy, also probably best to use the sbt macros so you don't need to repeat the name as a string.

vovapolu · 2017-12-01T16:36:05Z

@olafurpg Can you take a look now? I fixed all comments that were unanimously approved :D

olafurpg

Changes look great 👍 Second round of review

olafurpg · 2017-12-02T11:25:49Z

scalafmt-sbt-tests/src/sbt-test/scalafmt-sbt/sbt/test

@@ -0,0 +1,24 @@
+> p123/compile:scalafmt


Should we maybe add a negative check here?

-> p123/compile:scalafmtCheck

to validate check fails on misformatted files.

olafurpg · 2017-12-02T11:29:23Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

-          state
+    val scalafmt = taskKey[Unit]("Format Scala sources")
+    val scalafmtCheck =
+      taskKey[Boolean]("Check that Scala sources is formatted properly")


Fails if a Scala source is mis-formatted. Does not write to files.

olafurpg · 2017-12-02T11:29:56Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    val scalafmtCheck =
+      taskKey[Boolean]("Check that Scala sources is formatted properly")
+    val scalafmtOnCompile =
+      settingKey[Boolean]("Format source when compiling")


Format Scala source files on compile, off by default.

olafurpg · 2017-12-02T11:30:29Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      taskKey[Boolean]("Check that Scala sources is formatted properly")
+    val scalafmtOnCompile =
+      settingKey[Boolean]("Format source when compiling")
+    val scalafmtConfig = taskKey[File]("Scalafmt config file")


Location of .scalafmt.conf file

olafurpg · 2017-12-02T11:31:34Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    val scalafmtOnCompile =
+      settingKey[Boolean]("Format source when compiling")
+    val scalafmtConfig = taskKey[File]("Scalafmt config file")
+    val scalafmtSbt = taskKey[Unit]("Format SBT sources")


Format *.sbt and project/*.scala files for this sbt build

PS. it's written "sbt" in lowercase ;)

olafurpg · 2017-12-02T11:35:31Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  }
+  import autoImport._
+
+  private val scalaConfig = scalafmtConfig.map(Config.fromHoconFile(_) match {


Since scalafmtConfig is a task key, does that mean this will run on every scalafmt? Parsing config is pretty cheap but it's quite wasteful to do it if you run scalafmt on compile. Can we use sbt's caching utilities to avoid redundant work? http://www.scala-sbt.org/1.x/docs/Faq.html#How+can+a+task+avoid+redoing+work+if+the+input+files+are+unchanged%3F

Yeah, it's called quite a lot. I'll try to use some caching.

The solution in your link only works for generating output files. It doesn't cache any values of arbitrary type T.

olafurpg · 2017-12-02T11:36:08Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  })
+  private val sbtConfig = scalaConfig.map(_.forSbt)
+
+  private type Input = String


Fair enough, I don't feel strongly about this. I'm guilty of doing this myself sometimes 😏

olafurpg · 2017-12-02T11:38:35Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+  ): Seq[Option[T]] = {
+    sources.map(
+      file => {
+        val input = IO.read(file)


Would it make sense to make this a cached function? http://www.scala-sbt.org/1.x/docs/Faq.html#How+can+a+task+avoid+redoing+work+if+the+input+files+are+unchanged%3F

Scalafmt is around 6x slower than scalariform because it does a lot of work to figure out the best line wrapping (and the best-first algorithm I used is quite a bad fit for this domain, see #917). Scalafmt performance is usually not a problem for smaller files or if you run scalafmt infrequently but if you run it on compile on large source files it can impact compile times. I'll leave it to you to decide, I would at least keep it in mind.

olafurpg · 2017-12-02T11:42:38Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      checkSources(sbtSources.value, sbtConfig.value, streams.value.log)
+      checkSources(projectSources.value, scalaConfig.value, streams.value.log)
+    },
+    compileInputs in compile := Def.taskDyn {


iiuc, this implementation still breaks inspect tree compile, we need to push Def.taskDyn into a scalafmtDoAutoformat task, like is done here:

https://github.com/sbt/sbt-scalariform/blob/master/src/main/scala/com/typesafe/sbt/SbtScalariform.scala#L82-L87

I may be wrong @dwijnand may know better

well, I just copied it from neo-scalafmt-sbt plugin :D

Yes, Def.taskDyn "breaks" inspect - as in the dependencies don't show up.

In addition, note that this could/should be a settingDyn, as the test only depends on the value of a setting--the fact that the returned thing is a task is irrelevant. (Too many tasks out there are taskDyns where they could be settingDyns.) If sbt/sbt#3258 was implemented, this problem with breaking inspect wouldn't happen.

olafurpg · 2017-12-02T11:44:13Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    Seq(Compile, Test).flatMap(inConfig(_)(scalafmtConfigSettings))
+
+  override def buildSettings: Seq[Def.Setting[_]] = Seq(
+    scalafmtConfig := (baseDirectory in ThisBuild).value / ".scalafmt.conf"


Will this fail if the file does not exist? I think sbt-scalafmt should work fine out of the box without any .scalafmt.conf, do we have a test for this?

I can use default config when this file doesn't exist. I first used Option[File] with default None, but changed it thinking .scalafmt file should exists.

I often use scalafmt on smaller personal projects with the default config without making a .scalafmt file.

vovapolu · 2017-12-03T14:42:51Z

@olafurpg I think caching isn't going to be easy to implement. Your link is suitable for formatSources task, for example, but not for caching some values computed from files. So I suggest to leave it for next PRs :)

olafurpg

Only minor comments remaining, otherwise I think this plugin is soon ready for people to try out! 😄

olafurpg · 2017-12-03T15:36:50Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

-    val scalafmtSbt = taskKey[Unit]("Format SBT sources")
+      settingKey[Boolean](
+        "Format Scala source files on compile, off by default.")
+    val scalafmtConfig = taskKey[Option[File]](


Does this mean that you must scalafmtConfig := Some(file(".scalafmt.conf")) to avoid the default settings? I would prefer to make this non-Option and if the file does not exist then use default settings.

It searches for .scalafmt.conf file by default. And you can redefine it for your custom file.

I see, cool. OK this is fine then 👍

olafurpg · 2017-12-03T15:37:42Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

-        else Def.task(())
-      val previousInputs = (compileInputs in compile).value
-      task.map(_ => previousInputs)
+    scalafmtDoFormatOnCompile := Def.taskDyn {


As recommended by @sjrd we should make this a settingDyn

vovapolu · 2017-12-04T18:41:45Z

I'm merging it?

olafurpg · 2017-12-04T18:45:16Z

Please hold a bit, I want to give the plugin a swing locally first. I was traveling to Munich today, I'll try to take a look tomorrow!

sjrd

Looks good from my point of view.

I still think the sbtVersion in Global should be fixed, but it could be in a different PR, given that it's already broken in master anyway because of the other plugin.

olafurpg

I gave the plugin a swing locally and found a few low hanging improvements

olafurpg · 2017-12-05T14:07:41Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+      (file, e) => log.error(s"Error in ${file.toString}: $e"),
+      (file, input, output) => {
+        if (input != output) {
+          log.info(s"Successfully formatted ${file.toString}.")


This log entry will be quite noisy for large projects with 100s of sources. I propose we call this once per formatSources with a message like "Formatting 1 Scala source"/"Formatting 2 Scala sources" similar to how scalariform does https://github.com/sbt/sbt-scalariform/blob/a378b724a76ee94819939efc0e9adebd896e57d9/src/main/scala/com/typesafe/sbt/Scalariform.scala#L80

Output from testing plugin on akka build https://gist.github.com/olafurpg/7a33d069604324a8bf4249cb067b7dd0

olafurpg · 2017-12-05T14:17:33Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    },
+    scalafmtDoFormatOnCompile := Def.settingDyn {
+      if (scalafmtOnCompile.value) {
+        scalafmt in resolvedScoped.value.scope


This will run scalafmt on all sources on every compile, including nop compiles. It does not take advantage of incrementality. Is this expected/intended behavior? cc/ @fommil I think scalariform uses FileFunction.cached to make this incremental https://github.com/sbt/sbt-scalariform/blob/a378b724a76ee94819939efc0e9adebd896e57d9/src/main/scala/com/typesafe/sbt/Scalariform.scala#L85

yeah it's only supposed to be formatting files that are being compiled, not all of them

Let's leave caching for next PRs. I would like to implement it entirely, not only in some specific places. I will write a warning in the task description for now :)

@olafurpg that's a wrong solution. I don't know why scalariform uses it. FileFunction.cached accepts set of files, if you modify them (and we modify them by formatting), then it thinks that files are changed and runs the function again. So it needs two iteration to "converge" to formatted source and forget about it.

olafurpg · 2017-12-05T14:26:12Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+
+  lazy val scalafmtConfigSettings: Seq[Def.Setting[_]] = Seq(
+    scalafmt := formatSources(
+      (unmanagedSources in scalafmt).value,


This includes non-Scala source like *.java files. Running on the akka build results in a lot of parse errors like this

[error] Error in /Users/ollie/dev/akka/akka-testkit/src/test/java/akka/testkit/AkkaJUnitActorSystemResource.java: <input>:48: error: expected class or object definition [error] public class AkkaJUnitActorSystemResource extends ExternalResource { [error] ^ [error] Error in /Users/ollie/dev/akka/akka-testkit/src/test/java/akka/testkit/TestActorRefJavaCompile.java: <input>:10: error: expected class or object definition [error] public class TestActorRefJavaCompile { [error] ^

We should add some *.java files to the scripted tests

olafurpg · 2017-12-05T21:25:14Z

I just tried out the plugin on one of my projects and noticed that it formatted files that are excluded with project.excludeFilters in .scalafmt.conf. The plugin should use the (config: ScalafmtConfig).project.matcher.matches(String): Boolean to skip files.

scalafmt/scalafmt-core/shared/src/main/scala/org/scalafmt/config/ProjectFiles.scala

Line 13 in 6cddfe9

lazy val matcher: FilterMatcher =

The setting is used here for example: https://github.com/scalameta/language-server/blob/573863cb1db6bf99ac73f35ac17f733b92044beb/.scalafmt.conf#L12-L15

The idiomatic way to do this in sbt-scalafmt would be to customize unmanagedSources.in(scalafmt) but that can't be picked up by editor integrations like IntelliJ, so that's why it's supported via .scalafmt.conf.

olafurpg

Last fixes look great, we can leave caching for another PR. Only minor nitpick on language of logging, then we're good to merge 💯

olafurpg · 2017-12-12T09:55:00Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

@@ -21,7 +21,7 @@ object ScalafmtPlugin extends AutoPlugin {
        "Fails if a Scala source is mis-formatted. Does not write to files.")
    val scalafmtOnCompile =
      settingKey[Boolean](
-        "Format Scala source files on compile, off by default.")
+        "Format Scala source files on compile, off by default. Warning: It formats all project sources.")


What does this warning mean? Why should it not format all project sources?

olafurpg · 2017-12-12T09:58:13Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

        }
      }
-    )
+    ).flatten.sum
+    if (cnt > 0) {


cnt > 1 and then we avoid "Formatted 1 scala sources"

olafurpg · 2017-12-12T09:58:27Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

-    )
+    ).flatten.sum
+    if (cnt > 0) {
+      log.info(s"Successfully formatted $cnt scala files.")


Reformatted $cnt Scala sources

olafurpg · 2017-12-12T10:01:43Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+    taskKey[Unit]("Format Scala source files if scalafmtOnCompile is on.")
+
+  private val scalaConfig =
+    scalafmtConfig.map(_.map(Config.fromHoconFile(_) match {


Could we at least cache this by the timestamp of the file? I feel it's unnecessary to reparse the config for every project/config on every compile.

Here's what the IntelliJ plugin uses https://github.com/scalameta/scalafmt/blob/0f391aa351c59432d1cf6693b5658ab81d4de517/scalafmt-cli/src/main/scala/org/scalafmt/cli/StyleCache.scala

I see, sure we can leave it for a separate PR :)

Here's what the IntelliJ plugin uses

@olafurpg maybe simply reuse that object? It does just what we need

Go ahead, we might want to move it to the core module

olafurpg · 2017-12-12T10:06:36Z

scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala

+        "Fails if a Scala source is mis-formatted. Does not write to files.")
+    val scalafmtOnCompile =
+      settingKey[Boolean](
+        "Format Scala source files on compile, off by default. Warning: It formats all project sources.")


Let's remove this warning, it's not clear exactly what it's warning about and we will fix this in a future PR anyways.

olafurpg

LGTM 👍 Nice work @vovapolu !

I opened #1091 to track caching

Merging 💃

fommil · 2017-12-12T13:08:17Z

w00t! I'm really looking forward to format on compile in the follow up 😄 sounds like it's currently not doing the right thing?

olafurpg · 2017-12-13T16:14:16Z

Format on compile seems to work in the current version but it re-formats all of unmanagedSources.in(scalafmt), regardless of incremental compilation

コマンド変わったらしい scalameta/scalafmt#1085

scalafmt plugin commands changed. see - scalameta/scalafmt#1085 - https://github.com/scalameta/scalafmt/blob/v1.4.0/scalafmt-sbt/src/main/scala/org/scalafmt/sbt/ScalafmtPlugin.scala#L18-L32

vovapolu added 3 commits November 26, 2017 22:03

WIP new scalafmt sbt plugin

d9d0920

First tests for sbt plugin

e1812be

More tests for sbt-plugin

1ef7273

vovapolu changed the title ~~New scalafmt plugin~~ New scalafmt sbt plugin Nov 30, 2017

sjrd suggested changes Nov 30, 2017

View reviewed changes

olafurpg requested changes Nov 30, 2017

View reviewed changes

fommil reviewed Nov 30, 2017

View reviewed changes

vovapolu added 2 commits December 1, 2017 16:29

Fixes

e33449b

moved megaCache clearing

3ef624e

olafurpg requested changes Dec 2, 2017

View reviewed changes

Fixes 1.5 (without caching)

5bff421

olafurpg requested changes Dec 3, 2017

View reviewed changes

taskDyn to settingDyn

7b52844

sjrd approved these changes Dec 4, 2017

View reviewed changes

olafurpg requested changes Dec 5, 2017

View reviewed changes

olafurpg mentioned this pull request Dec 8, 2017

Configurable --output-format sbt/scalac/json/html/emacs/... scalacenter/scalafix#491

Closed

Fixes 1.55

bed8e83

olafurpg requested changes Dec 12, 2017

View reviewed changes

Minor fixes

c0e049b

olafurpg mentioned this pull request Dec 12, 2017

Make sbt-scalafmt format on compile incremental #1091

Closed

olafurpg approved these changes Dec 12, 2017

View reviewed changes

olafurpg merged commit 3df7c03 into scalameta:master Dec 12, 2017

dwijnand mentioned this pull request Dec 13, 2017

scalafmt still broken in 0.13.14-SNAPSHOT sbt/sbt#2837

Closed

olafurpg added this to the v1.3.1 milestone Jan 1, 2018

olafurpg mentioned this pull request Jan 1, 2018

revamp the sbt plugin #1081

Closed

xuwei-k added a commit to xuwei-k/S99 that referenced this pull request Jan 9, 2018

scalafmtを1.3.0から1.4.0にアップデート

3490c8d

コマンド変わったらしい scalameta/scalafmt#1085

xuwei-k mentioned this pull request Jan 9, 2018

scalafmtを1.3.0から1.4.0にアップデート scala-text/S99#60

Merged

xuwei-k added a commit to scala-text/S99 that referenced this pull request Jan 9, 2018

scalafmtを1.3.0から1.4.0にアップデート (#60)

03cd0d6

コマンド変わったらしい scalameta/scalafmt#1085

xuwei-k mentioned this pull request Jan 10, 2018

update sbt plugins msgpack/msgpack-java#452

Merged

olafurpg mentioned this pull request May 13, 2018

autoformat on compile #874

Closed

New scalafmt sbt plugin #1085

New scalafmt sbt plugin #1085

Conversation

vovapolu commented Nov 30, 2017 • edited Loading

sjrd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olafurpg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vovapolu commented Dec 1, 2017

olafurpg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vovapolu commented Dec 3, 2017

olafurpg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vovapolu commented Dec 4, 2017

olafurpg commented Dec 4, 2017

sjrd left a comment

Choose a reason for hiding this comment

olafurpg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vovapolu commented Nov 30, 2017 •

edited

Loading

fommil Dec 5, 2017 •

edited

Loading