struct Mint::Cli::DocsJson::Flags

• Mint::Cli::DocsJson::Flags
• Struct
• Value
• Object

Overview

Extend the flags struct to include the flag

Defined in:

commands/tool/docs_json.cr:3
commands/tool/docs_json.cr:8
commands/tool/docs_json.cr:12
commands/tool/docs_json.cr:16

Constant Summary

DESCRIPTIONS = {} of String => String

SPECS = {"__help__" => {kind: "bool", type: "Bool", default: "false", description: {"--help", "Displays help for the current command."}, short: "nil", long: "help", is_required: true}, "include_core" => {kind: "bool", type: "Bool", default: "false", description: {"--include-core", "If specified, documentation will be generated for the standard library as well."}, short: "nil", long: "include-core", is_required: true}, "include_packages" => {kind: "bool", type: "Bool", default: "false", description: {"--include-packages", "If specified, documentation will be generated for used packages as well."}, short: "nil", long: "include-packages", is_required: true}, "pretty" => {kind: "bool", type: "Bool", default: "false", description: {"--pretty", "If specified, the JSON will be pretty printed."}, short: "nil", long: "pretty", is_required: true}} of String => NamedTuple(kind: String, type: String, default: String, description: Tuple(String, String | ::Nil), short: String | ::Nil, long: String, is_required: Bool)

Constructors

• .new(command : Admiral::Command)

Instance Method Summary

• #__help__
• #include_core
• #include_packages
• #inspect(io)
• #pretty
• #validate!(command)

Constructor Detail

Instance Method Detail