class Crystal::Command

Defined in:

compiler/crystal/command.cr
compiler/crystal/command/clear_cache.cr
compiler/crystal/command/cursor.cr
compiler/crystal/command/docs.cr
compiler/crystal/command/env.cr
compiler/crystal/command/eval.cr
compiler/crystal/command/format.cr
compiler/crystal/command/playground.cr
compiler/crystal/command/repl.cr
compiler/crystal/command/spec.cr
compiler/crystal/tools/dependencies.cr
compiler/crystal/tools/flags.cr
compiler/crystal/tools/macro_code_coverage.cr
compiler/crystal/tools/unreachable.cr
compiler/crystal/warnings.cr

Constant Summary

COMMANDS_USAGE = "Usage: crystal tool [tool] [switches] [program file] [--] [arguments]\n\nTool:\n context show context for given location\n dependencies show file dependency tree\n expand show macro expansion for given location\n flags print all macro `flag?` values\n format format project, directories and/or files\n hierarchy show type hierarchy\n implementations show implementations for given call in location\n macro_code_coverage generate a macro code coverage report\n types show type of main variables\n unreachable show methods that are never called\n --help, -h show this help"
USAGE = "Usage: crystal [command] [switches] [program file] [--] [arguments]\n\nCommand:\n init generate a new project\n build build an executable\n clear_cache clear the compiler cache\n docs generate documentation\n env print Crystal environment information\n eval eval code from args or standard input\n i/interactive starts interactive Crystal\n play starts Crystal playground server\n run (default) build and run program\n spec build and run specs (in spec directory)\n tool run a tool\n help, --help, -h show this help\n version, --version, -v show version\n\nRun a command followed by --help to see command specific information, ex:\n crystal <command> --help"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new, unsafe_construct(address : Pointer, *args, **opts) : self unsafe_construct

Class methods inherited from class Reference

pre_initialize(address : Pointer) pre_initialize

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io : String | IO, root : String)
from_json(string_or_io : String | IO) from_json, from_yaml(string_or_io : String | IO) from_yaml

Macros inherited from class Object

class_getter(*names, &block) class_getter, class_getter!(*names) class_getter!, class_getter?(*names, &block) class_getter?, class_property(*names, &block) class_property, class_property!(*names) class_property!, class_property?(*names, &block) class_property?, class_setter(*names) class_setter, def_clone def_clone, def_equals(*fields) def_equals, def_equals_and_hash(*fields) def_equals_and_hash, def_hash(*fields) def_hash, delegate(*methods, to object) delegate, forward_missing_to(delegate) forward_missing_to, getter(*names, &block) getter, getter!(*names) getter!, getter?(*names, &block) getter?, property(*names, &block) property, property!(*names) property!, property?(*names, &block) property?, setter(*names) setter

Constructor Detail

def self.new(options : Array(String)) #

[View source]

Class Method Detail

def self.parse_with_crystal_opts(options, & : OptionParser -> ) #

Constructs an OptionParser from the given block and runs it twice, first time with CRYSTAL_OPTS, second time with the given options.

Only flags are accepted in the first run; positional arguments, invalid options (where they might be treated as normal arguments), and -- are all disallowed. The option parser should not define any subcommands.


[View source]
def self.run(options = ARGV) #

[View source]

Instance Method Detail

def find_sources(paths : Array(String), stdin : IO = STDIN, & : Compiler::Source -> ) : Nil #

[View source]
def report_warnings #

[View source]
def run #

[View source]
def warnings_fail_on_exit? #

[View source]