Module: Cline::Utils::Logger

Included in:
Cli, Os::Linux
Defined in:
lib/cline/utils/logger.rb

Overview

Mixin adding some debug logging capabilities

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.sanitize_pty_output(pty_output, colored: false) ⇒ String

Sanitize some PTY output:

  • Remove ANSI escape codes.
  • Remove CSI escape codes.
  • Remove OSC escape codes.

Parameters:

  • pty_output (String) —

    PTY output string

  • colored (Boolean) (defaults to: false) —

    Do we keep colored output?

Returns:

  • (String) —

    Resulting sanitized string



17
18
19
20
 
# File 'lib/cline/utils/logger.rb', line 17

def sanitize_pty_output(pty_output, colored: false)
  pty_output = Strings::ANSI.sanitize(pty_output) unless colored
  pty_output.gsub(/\e\][^\a]*\a/, '')
end

Instance Method Details

#log_debug(msg = nil) { ... } ⇒ Object

Log a message if debug was activated

Parameters

Parameters:

  • msg (String, nil) (defaults to: nil) —

    Message to be displayed, or nil if the message is given lazily through a code block

Yields:

  • Code returning a String for lazy evaluation

    • Return [String] Debug message


29
30
31
32
33
34
 
# File 'lib/cline/utils/logger.rb', line 29

def log_debug(msg = nil)
  return unless Cline.config.debug

  msg = yield if block_given?
  puts "[CLINE DEBUG] - #{msg}"
end