com.codacy.tools.scala.seed.utils.FileHelper.scala Maven / Gradle / Ivy

Go to download
package com.codacy.tools.scala.seed.utils

import java.nio.charset.StandardCharsets
import java.nio.file.{Path, StandardOpenOption}

import better.files.File

object FileHelper {

  /**
    * Create temporary file with a certain content
    */
  def createTmpFile(content: String, prefix: String = "config", suffix: String = ".conf"): Path = {
    val tmpFile = File.newTemporaryFile(prefix, suffix)
    tmpFile.write(content)(Seq(StandardOpenOption.CREATE), StandardCharsets.UTF_8)
    tmpFile.path
  }

  /**
    * Strip prefix from an absolute path guaranteeing it does not start with a slash (/)
    */
  def stripAbsolutePrefix(path: String, prefix: String): String = {
    path
      .stripPrefix(prefix)
      .stripPrefix("/")
  }

  /**
    * Find the configuration file path
    *
    * @param root path to search recursively
    * @param configFileNames to match the files while searching
    * @param maxDepth to search
    * @return config file path closer to the root
    */
  def findConfigurationFile(root: Path, configFileNames: Set[String], maxDepth: Int = 5): Option[Path] = {
    File(root)
      .walk(maxDepth = maxDepth)
      .find(file => configFileNames.contains(file.name))
      .map(_.path)
  }

}