Skip to content

Commit be16d27

Browse files
Some doc for Serializer
1 parent c71bd11 commit be16d27

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

compiler/src/dotty/tools/dotc/coverage/Serializer.scala

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,34 @@ import java.io._
55

66
import scala.io.Source
77

8+
/**
9+
* Serializes scoverage data.
10+
* @see https://github.com/scoverage/scalac-scoverage-plugin/blob/main/scalac-scoverage-plugin/src/main/scala/scoverage/Serializer.scala
11+
*/
812
object Serializer:
913

10-
private val coverageFileName = "scoverage.coverage"
11-
private val coverageDataFormatVersion = "3.0"
14+
private val CoverageFileName = "scoverage.coverage"
15+
private val CoverageDataFormatVersion = "3.0"
1216

1317
/** Write out coverage data to the given data directory, using the default coverage filename */
1418
def serialize(coverage: Coverage, dataDir: String, sourceRoot: String): Unit =
1519
serialize(coverage, coverageFile(dataDir), new File(sourceRoot))
1620

1721
/** Write out coverage data to given file. */
1822
def serialize(coverage: Coverage, file: File, sourceRoot: File): Unit =
19-
val writer = new BufferedWriter(new FileWriter(file))
23+
val writer = BufferedWriter(FileWriter(file))
2024
serialize(coverage, writer, sourceRoot)
2125
writer.close()
2226

2327
def serialize(coverage: Coverage, writer: Writer, sourceRoot: File): Unit =
2428

2529
def getRelativePath(filePath: String): String =
2630
val base = sourceRoot.getCanonicalFile().toPath()
27-
val relPath = base.relativize(new File(filePath).getCanonicalFile().toPath())
31+
val relPath = base.relativize(File(filePath).getCanonicalFile().toPath())
2832
relPath.toString
2933

3034
def writeHeader(writer: Writer): Unit =
31-
writer.write(s"""# Coverage data, format version: $coverageDataFormatVersion
35+
writer.write(s"""# Coverage data, format version: $CoverageDataFormatVersion
3236
|# Statement data:
3337
|# - id
3438
|# - source path
@@ -71,9 +75,9 @@ object Serializer:
7175
|""".stripMargin)
7276

7377
writeHeader(writer)
74-
coverage.statements.toVector
78+
coverage.statements.toSeq
7579
.sortBy(_.id)
7680
.foreach(stmt => writeStatement(stmt, writer))
7781

7882
def coverageFile(dataDir: File): File = coverageFile(dataDir.getAbsolutePath)
79-
def coverageFile(dataDir: String): File = File(dataDir, coverageFileName)
83+
def coverageFile(dataDir: String): File = File(dataDir, CoverageFileName)

0 commit comments

Comments
 (0)