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

Jump to bottom

State: correctly compute line widths in strings and interpolations with strip margin #3095

Merged
merged 3 commits into from
Feb 2, 2022
Merged

State: correctly compute line widths in strings and interpolations with strip margin #3095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f97dc5
Test non-idempotent format of interpolated strings
kitbellew Jan 31, 2022
0d2c47d
State: get string margin char from const strings
kitbellew Feb 1, 2022
6353943
State: use string margin char for interpolations
kitbellew Jan 31, 2022
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
51 changes: 47 additions & 4 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/internal/State.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,15 @@ object State {
}
}

private val stripMarginPattern =
Pattern.compile("\n(\\h*+\\|)?([^\n]*+)")
@inline
private def compileStripMarginPattern(pipe: Char) =
Pattern.compile(s"\n(\\h*+\\$pipe)?([^\n]*+)")

@inline
private def getStripMarginPattern(pipe: Char) =
if (pipe == '|') pipeStripMarginPattern else compileStripMarginPattern(pipe)

private val pipeStripMarginPattern = compileStripMarginPattern('|')

private val slcLine = Pattern.compile("^/\\/\\/*+\\h*+(.*?)\\h*+$")

Expand Down Expand Up @@ -346,21 +353,57 @@ object State {
val adjusted = 3 + (if (style.align.stripMargin) column else indent)
_ => adjusted
} else identity
getColumnsWithStripMargin(syntax, firstNL, margin, firstLength)
val pipe = getStripMarginChar(ft.meta.rightOwner)
getColumnsWithStripMargin(pipe, syntax, firstNL, margin, firstLength)
case _: Token.Interpolation.Part =>
val margin: Int => Int = if (style.assumeStandardLibraryStripMargin) {
// 1 for '|'
val adjusted = 1 + indent
_ => adjusted
} else identity
val pipe = getStripMarginCharForInterpolate(ft.meta.rightOwner)
getColumnsWithStripMargin(pipe, syntax, firstNL, margin, firstLength)
case _ =>
val lastNewline = syntax.length - syntax.lastIndexOf('\n') - 1
(firstLength, lastNewline)
}
}
}

private def getColumnsFromMultiline(
syntax: String,
firstNL: Int,
firstLength: Int
): (Int, Int) = {
@tailrec
def iter(prevMaxLength: Int, lineBeg: Int): (Int, Int) = {
val nextNL = syntax.indexOf('\n', lineBeg)
val length = (if (nextNL < 0) syntax.length else nextNL) - lineBeg
val maxLength = math.max(prevMaxLength, length)
if (nextNL < 0) (maxLength, length) else iter(maxLength, nextNL + 1)
}
iter(firstLength, firstNL + 1)
}

private def getColumnsWithStripMargin(
pipeOpt: Option[Char],
syntax: String,
firstNL: Int,
adjustMargin: Int => Int,
firstLength: Int
): (Int, Int) =
pipeOpt.fold(getColumnsFromMultiline(syntax, firstNL, firstLength))(
getColumnsWithStripMargin(_, syntax, firstNL, adjustMargin, firstLength)
)

private def getColumnsWithStripMargin(
pipe: Char,
syntax: String,
firstNL: Int,
adjustMargin: Int => Int,
firstLength: Int
): (Int, Int) = {
val matcher = stripMarginPattern.matcher(syntax)
val matcher = getStripMarginPattern(pipe).matcher(syntax)
matcher.region(firstNL, syntax.length)
if (!matcher.find()) (firstLength, firstLength)
else {
Expand Down
206 changes: 206 additions & 0 deletions scalafmt-tests/src/test/resources/test/StripMargin.stat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,3 +314,209 @@ final class MyClass {
println(s"""${1}
""".stripMargin)
}
<<< #3090 string without margin
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 string without margin, no align
maxColumn = 100
align.stripMargin = false
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 string with margin '|'
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 string with margin '='
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => """UPDATE mytable
=SET
= column = $thisvariablenameisreallylong
=WHERE column2 = ${foo.bar}""".stripMargin('=').update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
"""UPDATE mytable
=SET
= column = $thisvariablenameisreallylong
=WHERE column2 = ${foo.bar}""".stripMargin('=').update.run
).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 interpolation without margin
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 interpolation without margin, no align
maxColumn = 100
align.stripMargin = false
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong => fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin1.update.run).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 interpolation with margin '|'
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
|SET
| column = $thisvariablenameisreallylong
|WHERE column2 = ${foo.bar}""".stripMargin.update.run
).getOrElse {
().pure[ConnectionIO]
}
}
<<< #3090 interpolation with margin '='
maxColumn = 100
optIn.breaksInsideChains = true
===
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
=SET
= column = $thisvariablenameisreallylong
=WHERE column2 = ${foo.bar}""".stripMargin('=').update.run
).getOrElse {
().pure[ConnectionIO]
}
}
>>>
class Test {
val test = foo.bar.baz
.map(thisvariablenameisreallylong =>
fr"""UPDATE mytable
=SET
= column = $thisvariablenameisreallylong
=WHERE column2 = ${foo.bar}""".stripMargin('=').update.run
).getOrElse {
().pure[ConnectionIO]
}
}