RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.command/Command

Command

com.ossuminc.riddl.command.Command

trait Command[OPT <: CommandOptions](val pluginName: String)(implicit evidence$1: ClassTag[OPT])

The service interface for Riddlc command plugins

Attributes

Source: Command.scala
Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InputFileCommand

class PassCommand[OPT]

class TranslationCommand[OPT]

class PrettifyCommand

class HugoCommand

class StatsCommand

class AboutCommand

class FromCommand

class HelpCommand

class InfoCommand

class InputFileCommand

class DumpCommand

class FlattenCommand

class ParseCommand

class ValidateCommand

class OnChangeCommand

class RepeatCommand

class VersionCommand
Show all

Members list

Value members

Abstract methods

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

Provide an scopt OParser for the commands options type, OPT

Attributes

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

Concrete methods

Attributes

Source: Command.scala

Attributes

Source: Command.scala

Attributes

Source: Command.scala

Attributes

Source: Command.scala

Attributes

Source: Command.scala

Attributes

Source: Command.scala

Execute the command given the options.

Execute the command given the options. Error should be returned as Left(messages) and not directly logged. The log is for verbose or debug output

Value parameters

commonOptions: The options common to all commands
log: A logger for logging errors, warnings, and info
options: The command specific options

Attributes

Returns: Either a set of Messages on error or a Unit on success
Source: Command.scala

Attributes

Source: Command.scala

Concrete fields

Attributes

Source: Command.scala

Attributes

Source: Command.scala

In this article

Generated with