class

CRDoc::CLI

Inherits Reference < Object

Constants

DEFAULT_WIDTH = 80

Output width when stdout is not the real terminal.

EMPTY_QUERY = /\A[\s#@.:]*\z/

A query made only of these characters names nothing.

GLOB_CHARS = /[*?\[\]{}]/
INTERNAL_ERROR_STATUS = 70

Exit status for an unexpected exception.

KIND_GROUPS = {"type" => [Entry::Kind::Class, Entry::Kind::Struct, Entry::Kind::Module, Entry::Kind::Enum, Entry::Kind::Alias, Entry::Kind::Annotation], "method" => [Entry::Kind::Constructor, Entry::Kind::ClassMethod, Entry::Kind::InstanceMethod, Entry::Kind::Macro], "instance" => [Entry::Kind::InstanceMethod], "member" => [Entry::Kind::EnumMember], "const" => [Entry::Kind::Constant, Entry::Kind::EnumMember]}

Constructors

new(argv : Array(String), stdout : IO = STDOUT, stderr : IO = STDERR)
Source

Instance methods

action
Source
action=(action : Action)
Source
api_version
Source
api_version=(api_version : String | Nil)
Source
color_mode
Source
color_mode=(color_mode : ColorMode)
Source
excludes
Source
excludes=(excludes : Array(String))
Source
full=(full : Bool)
Source
full?
Source
includes
Source
includes=(includes : Array(String))
Source
kinds
Source
kinds=(kinds : Array(Entry::Kind) | Nil)
Source
lock_file
Source
lock_file=(lock_file : String)
Source
pager=(pager : Bool)
Source
pager?
Source
pattern
Source
pattern=(pattern : String | Nil)
Source
queries
Source
queries=(queries : Array(String))
Source
run

Runs the invocation and returns the process exit status.

Source
scope
Source
scope=(scope : Search::Scope)
Source
shard_spec
Source
shard_spec=(shard_spec : String | Nil)
Source
signatures=(signatures : Bool)
Source
signatures?
Source
source_name
Source
source_name=(source_name : String | Nil)
Source

Nested types