Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scalafmt: use ammonite parser to handle scripts #3120

Merged
merged 1 commit into from
Feb 11, 2022
Merged

Scalafmt: use ammonite parser to handle scripts #3120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 6 additions & 29 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/Scalafmt.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ package org.scalafmt
import java.nio.file.Path

import metaconfig.Configured
import scala.annotation.tailrec
import scala.meta.Dialect
import scala.meta.Input
import scala.meta.parsers.ParseException
import scala.util.Failure
import scala.util.Success
import scala.util.Try
import scala.util.matching.Regex

import org.scalafmt.config.Config
import org.scalafmt.Error.PreciseIncomplete
Expand Down Expand Up @@ -100,36 +98,13 @@ object Scalafmt {
}
}

private def flatMapAll[A, B](xs: Iterator[A])(f: A => Try[B]): Try[Seq[B]] = {
val res = Seq.newBuilder[B]
@tailrec
def iter: Try[Seq[B]] =
if (!xs.hasNext) Success(res.result())
else
f(xs.next()) match {
case Success(x) => res += x; iter
case Failure(e) => Failure(e)
}
iter
}

// see: https://ammonite.io/#Save/LoadSession
private val ammonitePattern: Regex = "(?:\\s*\\n@(?=\\s))+".r

private def doFormat(
code: String,
style: ScalafmtConfig,
file: String,
range: Set[Range]
): Try[String] =
if (FileOps.isAmmonite(file)) {
// XXX: we won't support ranges as we don't keep track of lines
val chunks = ammonitePattern.split(code)
if (chunks.length <= 1) doFormatOne(code, style, file, range)
else
flatMapAll(chunks.iterator)(doFormatOne(_, style, file))
.map(_.mkString("\n@\n"))
} else if (FileOps.isMarkdown(file)) {
if (FileOps.isMarkdown(file)) {
val markdown = MarkdownFile.parse(Input.VirtualFile(file, code))

val resultIterator: Iterator[Try[String]] =
Expand All @@ -150,8 +125,10 @@ object Scalafmt {
} else
doFormatOne(code, style, file, range)

private[scalafmt] def toInput(code: String, file: String): Input.VirtualFile =
Input.VirtualFile(file, code)
private[scalafmt] def toInput(code: String, file: String): Input = {
val fileInput = Input.VirtualFile(file, code)
if (FileOps.isAmmonite(file)) Input.Ammonite(fileInput) else fileInput
}

private def doFormatOne(
code: String,
Expand All @@ -162,7 +139,7 @@ object Scalafmt {
if (code.matches("\\s*")) Try("\n")
else {
val runner = style.runner
val codeToInput: String => Input.VirtualFile = toInput(_, file)
val codeToInput: String => Input = toInput(_, file)
val parsed = runner.parse(Rewrite(codeToInput(code), style, codeToInput))
parsed.fold(
_.details match {
Expand Down
13 changes: 11 additions & 2 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/config/ScalafmtParser.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
package org.scalafmt.config

import scala.meta.Tree
import scala.meta._
import scala.meta.parsers.Parse
import scala.meta.parsers.Parsed

sealed class ScalafmtParser(val parse: Parse[_ <: Tree])

object ScalafmtParser {
case object Case extends ScalafmtParser(Parse.parseCase)
case object Stat extends ScalafmtParser(Parse.parseStat)
case object Source extends ScalafmtParser(Parse.parseSource)
case object Source extends ScalafmtParser(SourceParser)

implicit val codec = ReaderUtil.oneOf[ScalafmtParser](Case, Stat, Source)

private object SourceParser extends Parse[Tree] {
override def apply(input: Input, dialect: Dialect): Parsed[Tree] = {
val isAmmonite = input.isInstanceOf[Input.Ammonite]
val parser = if (isAmmonite) Parse.parseAmmonite else Parse.parseSource
parser(input, dialect)
}
}
}
4 changes: 4 additions & 0 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/internal/Router.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ class Router(formatOps: FormatOps) {
val newlines = formatToken.newlinesBetween

formatToken match {
// between sources (EOF -> @ -> BOF)
case FormatToken(_: T.EOF, _, _) => Seq(Split(Newline, 0))
case ft @ FormatToken(_, _: T.BOF, _) =>
Seq(Split(NoSplit.orNL(next(ft).right.is[T.EOF]), 0))
case FormatToken(_: T.BOF, right, _) =>
val policy = right match {
case T.Ident(name) // shebang in .sc files
Expand Down
9 changes: 4 additions & 5 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/rewrite/Rewrite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import scala.collection.mutable

import metaconfig.ConfCodecEx
import scala.meta._
import scala.meta.Input.VirtualFile
import scala.meta.tokens.Token.LF
import scala.meta.transversers.SimpleTraverser

Expand All @@ -16,15 +15,15 @@ import org.scalafmt.util.{TokenOps, TokenTraverser, TreeOps, Trivia, Whitespace}

case class RewriteCtx(
style: ScalafmtConfig,
fileName: String,
input: Input,
tree: Tree
) {
implicit val dialect = style.dialect

private val patchBuilder = mutable.Map.empty[(Int, Int), TokenPatch]

val tokens = tree.tokens
val tokenTraverser = new TokenTraverser(tokens, fileName)
val tokenTraverser = new TokenTraverser(tokens, input)
val matchingParens = TreeOps.getMatchingParentheses(tokens)

@inline def getMatching(a: Token): Token =
Expand Down Expand Up @@ -142,7 +141,7 @@ object Rewrite {
val default: Seq[Rewrite] = name2rewrite.values.toSeq

def apply(
input: VirtualFile,
input: Input,
style: ScalafmtConfig,
toInput: String => Input
): Input = {
Expand All @@ -152,7 +151,7 @@ object Rewrite {
} else {
style.runner.parse(input) match {
case Parsed.Success(ast) =>
val ctx = RewriteCtx(style, input.path, ast)
val ctx = RewriteCtx(style, input, ast)
val rewriteSessions = rewrites.map(_.create(ctx)).toList
val traverser = new SimpleTraverser {
override def apply(tree: Tree): Unit = {
Expand Down
7 changes: 3 additions & 4 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/util/TokenTraverser.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package org.scalafmt.util

import org.scalafmt.sysops.FileOps

import scala.annotation.tailrec
import scala.meta.Input
import scala.meta.tokens.Token
import scala.meta.tokens.Tokens

class TokenTraverser(tokens: Tokens, filename: String) {
class TokenTraverser(tokens: Tokens, input: Input) {
private[this] val (tok2idx, excludedTokens) = {
val map = Map.newBuilder[Token, Int]
val excluded = Set.newBuilder[TokenOps.TokenHash]
Expand All @@ -22,7 +21,7 @@ class TokenTraverser(tokens: Tokens, filename: String) {
map += (tok -> i)
i += 1
}
if (FileOps.isAmmonite(filename)) {
if (input.isInstanceOf[Input.Ammonite]) {
val realTokens = tokens.dropWhile(_.is[Token.BOF])
realTokens.headOption.foreach {
// shebang in .sc files
Expand Down
1 change: 1 addition & 0 deletions scalafmt-tests/src/test/resources/test/Dialect.source
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ import mill._
interp.repositories() =
interp.repositories() ++ Seq(coursier.MavenRepository("https://jitpack.io"))

@
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the double @ ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because there are two @ tokens in the source. old approach was splitting on one or more such tokens as delimiter, and outputting one. new one, obviously, doesn't remove tokens.

this change will not affect existing code. if it had already been handled by scalafmt, then it should have only one already.

@
import $ivy.`com.github.yyadavalli::mill-ensime:0.0.2`
<<< #2204 annotations
Expand Down
2 changes: 1 addition & 1 deletion scalafmt-tests/src/test/scala/org/scalafmt/FormatTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class FormatTests extends FunSuite with CanRunTests with FormatAssertions {
t.style.rewrite.rules.isEmpty &&
FormatTokensRewrite.getEnabledFactories(t.style).isEmpty &&
!t.style.assumeStandardLibraryStripMargin &&
!FileOps.isAmmonite(t.filename) && !FileOps.isMarkdown(t.filename) &&
!FileOps.isMarkdown(t.filename) &&
t.style.onTestFailure.isEmpty
)
assertFormatPreservesAst(
Expand Down