Class: FastlaneCore::Shell

Inherits:
Interface show all
Defined in:
lib/fastlane_core/ui/implementations/shell.rb

Overview

Shell is the terminal output of things For documentation for each of the methods open ‘interface.rb`

Messaging: show text to the user collapse

Errors: Inputs collapse

Instance Method Summary collapse

Methods inherited from Interface

#crash!, #not_implemented, #to_s, #user_error!

Instance Method Details

#command(message) ⇒ Object 



52
53
54
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 52

def command(message)
  log.info("$ #{message}".cyan.underline)
end

#command_output(message) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 56

def command_output(message)
  actual = (message.split("\r").last || "") # as clearing the line will remove the `>` and the time stamp
  actual.split("\n").each do |msg|
    prefix = msg.include?("▸") ? "" : "▸ "
    log.info(prefix + "" + msg.magenta)
  end
end

#confirm(message) ⇒ Object 



91
92
93
94
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 91

def confirm(message)
  verify_interactive!(message)
  agree("#{message} (y/n)", true)
end

#deprecated(message) ⇒ Object 



48
49
50
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 48

def deprecated(message)
  log.error(message.to_s.bold.blue)
end

#error(message) ⇒ Object 



32
33
34
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 32

def error(message)
  log.error(message.to_s.red)
end

#header(message) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 68

def header(message)
  i = message.length + 8
  success("-" * i)
  success("--- " + message + " ---")
  success("-" * i)
end

#important(message) ⇒ Object 



36
37
38
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 36

def important(message)
  log.warn(message.to_s.yellow)
end

#input(message) ⇒ Object 



86
87
88
89
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 86

def input(message)
  verify_interactive!(message)
  ask(message)
end

#interactive? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
82
83
84
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 79

def interactive?
  interactive = true
  interactive = false if $stdout.isatty == false
  interactive = false if Helper.ci?
  return interactive
end

#log ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 5

def log
  return @log if @log

  $stdout.sync = true

  if Helper.is_test?
    @log ||= Logger.new(nil) # don't show any logs when running tests
  else
    @log ||= Logger.new($stdout)
  end

  @log.formatter = proc do |severity, datetime, progname, msg|
    string = "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N')}]: " if $verbose
    string = "[#{datetime.strftime('%H:%M:%S')}]: " unless $verbose

    string += "#{msg}\n"

    string
  end

  @log
end

#message(message) ⇒ Object 



44
45
46
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 44

def message(message)
  log.info(message.to_s)
end

#password(message) ⇒ Object 



103
104
105
106
107
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 103

def password(message)
  verify_interactive!(message)

  ask(message.yellow) { |q| q.echo = "*" }
end

#select(message, options) ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 96

def select(message, options)
  verify_interactive!(message)

  important(message)
  choose(*options)
end

#success(message) ⇒ Object 



40
41
42
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 40

def success(message)
  log.info(message.to_s.green)
end

#verbose(message) ⇒ Object 



64
65
66
 
# File 'lib/fastlane_core/ui/implementations/shell.rb', line 64

def verbose(message)
  log.debug(message.to_s) if $verbose
end