ammonite
package ammonite
- Alphabetic
- Public
- All
Type Members
-
case class
Main(predefCode: String = "", predefFile: Option[Path] = None, defaultPredef: Boolean = true, storageBackend: Storage = ..., wd: Path = os.pwd, welcomeBanner: Option[String] = Some(Defaults.welcomeBanner), inputStream: InputStream = System.in, outputStream: OutputStream = System.out, errorStream: OutputStream = System.err, verboseOutput: Boolean = true, remoteLogging: Boolean = true, colors: Colors = Colors.Default, replCodeWrapper: CodeWrapper = DefaultCodeWrapper, scriptCodeWrapper: CodeWrapper = DefaultCodeWrapper, alreadyLoadedDependencies: Seq[Dependency] = ..., importHooks: Map[Seq[String], ImportHook] = ImportHook.defaults, compilerBuilder: CompilerBuilder = ammonite.compiler.CompilerBuilder(), parser: () ⇒ Parser = () => ammonite.compiler.Parsers, classPathWhitelist: Set[Seq[String]] = Set.empty, warnings: Boolean = false) extends Product with Serializable
Contains the various entry points to the Ammonite REPL.
Contains the various entry points to the Ammonite REPL.
Configuration of the basic REPL is done by passing in arguments when constructing the Main instance, and the various entrypoints such as run runScript and so on are methods on that instance.
It is more or less equivalent to the ammonite.repl.Repl object itself, and has a similar set of parameters, but does not have any of the ammonite.repl.Repl's implementation-related code and provides a more convenient set of entry-points that a user can call.
Note that the instantiateRepl function generates a new Repl every time it is called!
- predefCode
Any additional code you want to run before the REPL session starts. Can contain multiple blocks separated by
@
s- defaultPredef
Do you want to include the "standard" predef imports provided by Ammonite? These include tools like
time
,grep
, the|
or|?
pipes from ammonite-ops, and other helpers. Can be disabled to give a clean namespace for you to fill using your own predef.- storageBackend
Where will all of Ammonite's persistent data get stored? Things like any
predef.sc
file, compilation/ivy caches, etc.. Defaults include Storage.Folder and Storage.InMemory, though you can create your own.- wd
The working directory of the REPL; when it load scripts, where the scripts will be considered relative to when assigning them packages
- inputStream
Where input to the Repl is coming from, typically System.in, but it could come from somewhere else e.g. across the network in the case of the SshdRepl
- outputStream
Primary output of code run using Ammonite
- errorStream
Error output when things go bad, typically System.err; also gets sent miscellaneous info messages that aren't strictly part of the REPL or script's output
-
class
MainRunner extends AnyRef
Bundles together:
Bundles together:
- All the code relying on cliConfig - Handling for the common input/output streams and print-streams - Logic around the watch-and-rerun flag
Value Members
- object AmmoniteMain
- object Main extends Serializable
- object MainRunner