An abstract base class for translation style commands. That is, they translate an input file into an output directory of files.
Type parameters
- OPT
-
The option type for the command
Value parameters
- name
-
The name of the command to pass to Command
Attributes
- Companion
- object
- Source
- TranslationCommand.scala
- Graph
-
- Supertypes
- Known subtypes
-
class PrettifyCommand
Members list
Value members
Inherited methods
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
The basic implementation of the command.
The basic implementation of the command. This should be called with super.run(...) from the subclass implementation.
Value parameters
- commonOptions
-
The options common to all commands
- log
-
A log for logging errors, warnings, and info
- originalOptions
-
The original options to the command
- outputDirOverride
-
Any override to the outputDir option from the command line
Attributes
- Returns
-
Either a set of Messages on error or a Unit on success
- Definition Classes
- Inherited from:
- PassCommand
- Source
- PassCommand.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Inherited and Abstract methods
Provide a scopt OParser for the commands options type, OPT
Provide a scopt OParser for the commands options type, OPT
Attributes
- Returns
-
A pair: the OParser and the default values for OPT
- Inherited from:
- Command
- Source
- Command.scala
Get the passes to run given basic input for pass creation
Get the passes to run given basic input for pass creation
Value parameters
- commonOptions
-
The common options for the command
- log
-
The log to use
- options
-
The command options
Attributes
- Returns
-
A com.ossuminc.riddl.passes.PassCreator function that creates the pass
- Inherited from:
- PassCommand
- Source
- PassCommand.scala
Provide a typesafe/Config reader for the commands options.
Provide a typesafe/Config reader for the commands options. This reader should read an object having the same name as the command. The fields of that object must correspond to the fields of the OPT type.
Attributes
- Returns
-
A pureconfig.ConfigReader[OPT] that knows how to read OPT
- Inherited from:
- Command
- Source
- Command.scala
A method to override the options
Inherited fields
Attributes
- Inherited from:
- Command
- Source
- Command.scala
Attributes
- Inherited from:
- Command
- Source
- Command.scala