RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.commands/PrettifyCommand

PrettifyCommand

com.ossuminc.riddl.commands.PrettifyCommand

See thePrettifyCommand companion object

class PrettifyCommand(using pc: PlatformContext) extends TranslationCommand[Options]

A command to Prettify RIDDL Source

Attributes

Companion: object
Source: PrettifyCommand.scala
Graph
Supertypes: class TranslationCommand[Options]

class PassCommand[Options]

trait Command[Options]

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

Provide a scopt OParser for the commands options type, OPT

Attributes

Returns: A pair: the OParser and the default values for OPT
Definition Classes: Command
Source: PrettifyCommand.scala

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
Definition Classes: PassCommand
Source: PrettifyCommand.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
Definition Classes: Command
Source: PrettifyCommand.scala

A method to override the options

Attributes

Source: PrettifyCommand.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: PassCommand -> Command
Source: PrettifyCommand.scala

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

Attributes

Inherited from:: Command
Source: Command.scala

Inherited fields

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

In this article

Generated with