scala.cli.commands.clean.CleanOptions.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cli_3 Show documentation

cli

There is a newer version: 1.5.0

package scala.cli.commands.clean

import caseapp.*

import scala.cli.ScalaCli.fullRunnerName
import scala.cli.commands.shared._

// format: off
@HelpMessage(CleanOptions.helpMessage, "", CleanOptions.detailedHelpMessage)
final case class CleanOptions(
  @Recurse
    global: GlobalOptions = GlobalOptions(),
  @Recurse
    bspFile: SharedBspFileOptions = SharedBspFileOptions(),
  @Recurse
    workspace: SharedWorkspaceOptions = SharedWorkspaceOptions()
) extends HasGlobalOptions
// format: on

object CleanOptions {
  implicit lazy val parser: Parser[CleanOptions] = Parser.derive
  implicit lazy val help: Help[CleanOptions]     = Help.derive
  val cmdName                                    = "clean"
  private val helpHeader                         = "Clean the workspace."
  val helpMessage: String = HelpMessages.shortHelpMessage(cmdName, helpHeader)
  val detailedHelpMessage: String =
    s"""$helpHeader
       |
       |Passed inputs will establish the $fullRunnerName project, for which the workspace will be cleaned.
       |
       |${HelpMessages.commandDocWebsiteReference(cmdName)}""".stripMargin
}