mdoc.docs.FileModifier.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mdoc-docs_2.12 Show documentation

docs

The newest version!

package mdoc.docs

import java.nio.charset.StandardCharsets
import mdoc.Reporter
import mdoc.StringModifier
import mdoc.internal.pos.PositionSyntax._
import scala.meta.inputs.Input
import scala.meta.inputs.Position
import scala.meta.internal.io.FileIO
import scala.meta.io.AbsolutePath

class FileModifier extends StringModifier {
  val name = "file"
  override def process(
      info: String,
      code: Input,
      reporter: Reporter
  ): String = {
    val file = AbsolutePath(info)
    if (file.isFile) {
      val text = FileIO.slurp(file, StandardCharsets.UTF_8).trim
      val language = file.extension match {
        case "scala" => "scala"
        case "md" => "md"
        case _ => "text"
      }
      s"""
File: [${file.toNIO.getFileName}](https://github.com/scalameta/mdoc/blob/main/$info)
`````$language
$text
`````
"""
    } else {
      val pos = Position.Range(code, 0 - info.length - 1, 0 - 1).toUnslicedPosition
      reporter.error(pos, s"no such file: $file")
      ""
    }
  }

}