cli
API
Generated with
cli/scala.cli.commands.package0/Package

Package

scala.cli.commands.package0.Package$
object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers

Attributes

Graph
Supertypes
class Command[PackageOptions]
class CaseApp[PackageOptions]
class Object
trait Matchable
class Any
Self type
Package.type

Members list

Concise view

Type members

Classlikes

final class NoMainClassFoundForAssemblyError(cause: NoMainClassFoundError) extends BuildException

Attributes

Graph
Supertypes
class BuildException
trait Diagnostic
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any

Inherited classlikes

implicit class EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T])

Attributes

Inherited from:
CommandHelpers
Graph
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def assembly(build: Successful, destPath: Path, mainClassOpt: Option[String], extraProvided: Seq[AnyModule], withPreamble: Boolean, alreadyExistsCheck: () => Either[BuildException, Unit], logger: Logger): Either[BuildException, Unit]
def buildNative(build: Successful, mainClass: String, logger: Logger): Either[BuildException, Path]
override def buildOptions(options: PackageOptions): Option[BuildOptions]

Attributes

options

command-specific T options

Returns:

Tries to create BuildOptions based on sharedOptions and exits on error. Override to change this behaviour.

Definition Classes
def docJar(build: Successful, logger: Logger, extraArgs: Seq[String]): Either[BuildException, Path]
def finalBuildOptions(options: PackageOptions): BuildOptions
override def group: String

Attributes

Definition Classes
Command
override def helpFormat: HelpFormat

Attributes

Definition Classes
ScalaCommand -> CaseApp
def linkJs(build: Successful, dest: Path, mainClassOpt: Option[String], addTestInitializer: Boolean, config: ScalaJsLinkerConfig, fullOpt: Boolean, noOpt: Boolean, logger: Logger, scratchDirOpt: Option[Path]): Either[BuildException, Path]
override def name: String

Attributes

Definition Classes
Command
def providedFiles(build: Successful, provided: Seq[AnyModule], logger: Logger): Either[BuildException, Seq[Path]]

Returns the dependency sub-graph of the provided modules, that is, all their JARs and their transitive dependencies' JARs.

Returns the dependency sub-graph of the provided modules, that is, all their JARs and their transitive dependencies' JARs.

Note that this is not exactly the same as resolving those modules on their own (with their versions): other dependencies in the whole dependency sub-graph may bump versions in the provided dependencies sub-graph here.

Here, among the JARs of the whole dependency graph, we pick the ones that were pulled by the provided modules, and might have been bumped by other modules. This is strictly a subset of the whole dependency graph.

Attributes

override def runCommand(options: PackageOptions, args: RemainingArgs, logger: Logger): Unit

This should be overridden instead of run when extending ScalaCommand.

This should be overridden instead of run when extending ScalaCommand.

Attributes

options

the command's specific set of options

remainingArgs

arguments remaining after parsing options

Definition Classes
override def scalaSpecificationLevel: SpecificationLevel

Is that command a MUST / SHOULD / NICE TO have for the Scala runner specification?

Is that command a MUST / SHOULD / NICE TO have for the Scala runner specification?

Attributes

Definition Classes
override def sharedOptions(options: PackageOptions): Option[SharedOptions]

Attributes

Definition Classes
def sourceJar(build: Successful, defaultLastModified: Long): Array[Byte]
def withSourceJar[T](build: Successful, defaultLastModified: Long, fileName: String)(f: Path => T): T

Inherited methods

protected def SpecificationLevel: SpecificationLevel.type

Attributes

Inherited from:
RestrictableCommand
protected def actualCommandName: String

The actual sub-command name that was used. If the sub-command name is a list of strings, space is used as the separator. If argvOpt hasn't been defined, it defaults to name.

The actual sub-command name that was used. If the sub-command name is a list of strings, space is used as the separator. If argvOpt hasn't been defined, it defaults to name.

Attributes

Inherited from:
ScalaCommand
protected def actualFullCommand: String

Attributes

Inherited from:
ScalaCommand
protected def baseRunnerName: String

Attributes

Returns:

the actual Scala CLI base runner name, for SIP it is scala otherwise scala-cli

Inherited from:
ScalaCommand
protected def buildOptionsOrExit(options: PackageOptions): BuildOptions

Attributes

Inherited from:
ScalaCommand
def complete(args: Seq[String], index: Int): List[CompletionItem]

Attributes

Inherited from:
CaseApp
override def completer: Completer[T]

Attributes

Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def ensureNoDuplicates(): Unit

Attributes

Inherited from:
CaseApp
override def error(message: Error): Nothing

Attributes

Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def exit(code: Int): Nothing

Attributes

Inherited from:
CaseApp
def expandArgs(args: List[String]): List[String]

Arguments are expanded then parsed. By default, argument expansion is the identity function. Overriding this method allows plugging in an arbitrary argument expansion logic.

Arguments are expanded then parsed. By default, argument expansion is the identity function. Overriding this method allows plugging in an arbitrary argument expansion logic.

One such expansion logic involves replacing each argument of the form '@' with the contents of that file where each line in the file becomes a distinct argument. To enable this behavior, override this method as shown below.

Attributes

Example:
import caseapp.core.parser.PlatformArgsExpander
override def expandArgs(args: List[String]): List[String]
= PlatformArgsExpander.expand(args)
Inherited from:
CaseApp
def fullHelpAsked(progName: String): Nothing

Attributes

Inherited from:
CaseApp
protected def fullRunnerName: String

Attributes

Returns:

the actual Scala CLI runner name which was run

Inherited from:
ScalaCommand
override def hasFullHelp: Boolean

Attributes

Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def hasHelp: Boolean

Attributes

Inherited from:
CaseApp
def helpAsked(progName: String, maybeOptions: Either[Error, PackageOptions]): Nothing

Attributes

Inherited from:
CaseApp
override def hidden: Boolean

Attributes

Definition Classes
ScalaCommand -> Command
Inherited from:
ScalaCommand
def ignoreUnrecognized: Boolean

Whether to ignore unrecognized arguments.

Whether to ignore unrecognized arguments.

That is, if there are unrecognized arguments, the parsing still succeeds. The unparsed arguments are put in the args argument of run.

Attributes

Inherited from:
CaseApp
protected def invokeData: ScalaCliInvokeData

Attributes

Inherited from:
ScalaCommand
final def isRestricted: Boolean

Attributes

Inherited from:
RestrictableCommand
def main(progName: String, args: Array[String]): Unit

Attributes

Inherited from:
CaseApp
def main(args: Array[String]): Unit

Attributes

Inherited from:
CaseApp
def maybePrintGroupHelp(options: PackageOptions): Unit

Attributes

Inherited from:
ScalaCommand
def maybePrintSimpleScalacOutput(options: PackageOptions, buildOptions: BuildOptions): Unit

Print scalac output if passed options imply no inputs are necessary and raw scalac output is required instead. (i.e. --scalac-option -help)

Print scalac output if passed options imply no inputs are necessary and raw scalac output is required instead. (i.e. --scalac-option -help)

Attributes

options

command options

Inherited from:
ScalaCommand
def maybePrintToolsHelp(options: PackageOptions, buildOptions: BuildOptions): Unit

Attributes

Inherited from:
ScalaCommand
def names: List[List[String]]

Attributes

Inherited from:
Command
override def parser: Parser[T]

Attributes

Definition Classes
Inherited from:
RestrictableCommand
protected def progName: String

Attributes

Returns:

the actual Scala CLI program name which was run

Inherited from:
ScalaCommand
final override def run(options: PackageOptions, remainingArgs: RemainingArgs): Unit

This implementation is final. Override runCommand instead. This logic is invoked at the start of running every ScalaCommand.

This implementation is final. Override runCommand instead. This logic is invoked at the start of running every ScalaCommand.

Attributes

Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
override def setArgv(argv: Array[String]): Unit

Attributes

Definition Classes
Inherited from:
ScalaCommand
def stopAtFirstUnrecognized: Boolean

Whether to stop parsing at the first unrecognized argument.

Whether to stop parsing at the first unrecognized argument.

That is, stop parsing at the first non option (not starting with "-"), or the first unrecognized option. The unparsed arguments are put in the args argument of run.

Attributes

Inherited from:
CaseApp
def usageAsked(progName: String, maybeOptions: Either[Error, PackageOptions]): Nothing

Attributes

Inherited from:
CaseApp

Concrete fields

val hiddenHelpGroups: Seq[String]
val primaryHelpGroups: Seq[String]

Inherited fields

protected var argvOpt: Option[Array[String]]

Attributes

Inherited from:
ScalaCommand
lazy val finalHelp: Help[_]

Attributes

Inherited from:
CaseApp
override val messages: Help[PackageOptions]

Attributes

Inherited from:
ScalaCommand
lazy override val nameFormatter: Formatter[Name]

Attributes

Inherited from:
ScalaCommand

Givens

Inherited givens

given given_ScalaCliInvokeData: ScalaCliInvokeData

Attributes

Inherited from:
ScalaCommand

Extensions

Inherited extensions

extension (successfulBuild: Successful)
def copyOutput(sharedOptions: SharedOptions): Unit

-O -d defaults to --compile-output; if both are defined, --compile-output takes precedence

-O -d defaults to --compile-output; if both are defined, --compile-output takes precedence

Attributes

Inherited from:
BuildCommandHelpers
def retainedMainClass(logger: Logger, mainClasses: Seq[String]): Either[BuildException, String]

Attributes

Inherited from:
BuildCommandHelpers

Implicits

Inherited implicits

final implicit def EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T]): EitherBuildExceptionOps[E, T]

Attributes

Inherited from:
CommandHelpers
implicit val parser0: Parser[PackageOptions]

Attributes

Inherited from:
CaseApp
Generated with