Added Luka's console message colouring code

Data/Scripts/001_Technical/001_Debugging/002_DebugConsole.rb

@@ -44,27 +44,154 @@ module Kernel
     echo string
     echo "\r\n"
   end
-
-  def echoln_good(string)
-    echo "\e[32m"   # Green text
-    echo string
-    echo "\e[0m"   # Back to default text color
-    echo "\r\n"
-  end
-
-  def echoln_bad(string)
-    echo "\e[31m"   # Red text
-    echo string
-    echo "\e[0m"   # Back to default text color
-    echo "\r\n"
-  end
-
-  def echoln_warn(string)
-    echo "\e[33m"   # Brown/yellow text
-    echo string
-    echo "\e[0m"   # Back to default text color
-    echo "\r\n"
-  end
 end
 
 Console.setup_console
+
+#===============================================================================
+#  Console message formatting
+#===============================================================================
+module ConsoleRGB
+  # string colors
+  CMD_COLORS = {
+    default: '38', black: '30', red: '31', green: '32', brown: '33', blue: '34',
+    purple: '35', cyan: '36', gray: '37',
+    dark_gray: '1;30', light_red: '1;31', light_green: '1;32', yellow: '1;33',
+    light_blue: '1;34', light_purple: '1;35', light_cyan: '1;36', white: '1;37'
+  }
+  # background colors
+  CMD_BG_COLORS = {
+    default: '0', black: '40', red: '41', green: '42', brown: '43', blue: '44',
+    purple: '45', cyan: '46', gray: '47',
+    dark_gray: '100', light_red: '101', light_green: '102', yellow: '103',
+    light_blue: '104', light_purple: '105', light_cyan: '106', white: '107'
+  }
+  # font options
+  CMD_FONT_OPTIONS = {
+    bold: '1', dim: '2', italic: '3', underline: '4', reverse: '7', hidden: '8'
+  }
+  # syntax highlighting based on markup
+  CMD_SYNTAX_COLOR = {
+    '`' => :cyan, '"' => :purple, "'" => :purple, '$' => :green, '~' => :red
+  }
+  # syntax options based on markup
+  CMD_SYNTAX_OPTIONS = {
+    '*' => :bold, '|' => :italic, '__' => :underline
+  }
+
+  #-----------------------------------------------------------------------------
+  #  apply console coloring
+  #-----------------------------------------------------------------------------
+  def self.colors(string, text: :default, bg: :default, **options)
+    # get colors
+    code_text = CMD_COLORS[text]
+    code_bg   = CMD_BG_COLORS[bg]
+    # get options
+    option_pool = options.select { |key, val| CMD_FONT_OPTIONS.key?(key) && val }
+    font_options = option_pool.keys.map { |opt| CMD_FONT_OPTIONS[opt] }.join(';').squeeze
+    # return formatted string
+    return "\e[#{code_bg};#{font_options};#{code_text}m#{string}\e[0m".squeeze(';')
+  end
+
+  #-----------------------------------------------------------------------------
+  #  character markup to color mapping for console
+  #-----------------------------------------------------------------------------
+  # component level
+  def self.markup_component(string, options = {})
+    # syntax markup format options
+    [CMD_SYNTAX_COLOR, CMD_SYNTAX_OPTIONS].each_with_index do |hash, i|
+      hash.each do |key, value|
+        l = key.length
+        # ensure escape
+        key = key.chars.map { |c| "\\#{c}" }.join
+        # define regex
+        regex = "#{key}.*?#{key}"
+        # match markup
+        string.scan(/#{regex}/).each do |cpt|
+          options[i == 0 ? :text : value] = i == 0 ? value : true
+          options, string = self.markup_component(cpt[l...-l], options)
+        end
+      end
+    end
+    return options, string
+  end
+
+  # full string
+  def self.markup(string)
+    final_options = {}
+    (CMD_SYNTAX_COLOR.merge(CMD_SYNTAX_OPTIONS)).each_key do |key|
+      # ensure escape
+      key = key.chars.map { |c| "\\#{c}" }.join
+      # define regex
+      regex = "#{key}.*?#{key}"
+      string.scan(/#{regex}/).each do |cpt|
+        options, clean = self.markup_component(cpt)
+        if final_options[clean]
+          final_options[clean].deep_merge!(options)
+        else
+          final_options[clean] = options.clone
+        end
+        string.gsub!(cpt, clean)
+      end
+    end
+    # iterate through final options and apply them
+    final_options.each do |key, opt|
+      string.gsub!(key, self.colors(key, **opt))
+    end
+    return string
+  end
+
+  #-----------------------------------------------------------------------------
+  #  echo string into console (example short hand for common options)
+  #-----------------------------------------------------------------------------
+  # heading 1
+  def self.echo_h1(msg)
+    echoln ConsoleRGB.colors("*** #{msg} ***\r\n", text: :brown)
+  end
+
+  # heading 2
+  def self.echo_h2(msg, **options)
+    echoln ConsoleRGB.colors("#{msg}\r\n", **options)
+  end
+
+  # heading 3
+  def self.echo_h3(msg)
+    echoln ConsoleRGB.markup("#{msg}\r\n")
+  end
+
+  # list item
+  def self.echo_li(msg)
+    echo ConsoleRGB.colors("  -> ", text: :brown)
+    echo ConsoleRGB.markup(msg)
+  end
+
+  # list item (ends the line)
+  def self.echoln_li(msg)
+    self.echo_li(msg + "\r\n")
+  end
+
+  # paragraph with markup
+  def self.echo_p(msg)
+    echoln ConsoleRGB.markup(msg)
+  end
+
+  # warning message
+  def self.echo_warn(msg)
+    echoln ConsoleRGB.colors("WARNING: " + msg, text: :yellow)
+  end
+
+  # error message
+  def self.echo_error(msg)
+    echoln ConsoleRGB.colors("ERROR: " + msg, text: :light_red)
+  end
+
+  # status output
+  def self.echo_status(status)
+    echoln status ? ConsoleRGB.colors('OK', text: :green) : ConsoleRGB.colors('FAIL', text: :red)
+  end
+
+  # completion output
+  def self.echo_complete(status)
+    echoln status ? ConsoleRGB.colors('done', text: :green) : ConsoleRGB.colors('error', text: :red)
+  end
+end

Data/Scripts/001_Technical/001_Debugging/005_Deprecation.rb

@@ -8,15 +8,14 @@ module Deprecation
   # @param removal_version [String] version the method is removed in
   # @param alternative [String] preferred alternative method
   def warn_method(method_name, removal_version = nil, alternative = nil)
-    text = _INTL('WARN: usage of deprecated method "{1}" or its alias.', method_name)
+    text = _INTL('Usage of deprecated method "{1}" or its alias.', method_name)
     unless removal_version.nil?
-      text += _INTL("\nThe method is slated to be"\
-                    " removed in Essentials {1}.", removal_version)
+      text += "\r\n" + _INTL("The method is slated to be removed in Essentials {1}.", removal_version)
     end
     unless alternative.nil?
-      text += _INTL("\nUse \"{1}\" instead.", alternative)
+      text += "\r\n" + _INTL("Use \"{1}\" instead.", alternative)
     end
-    echoln text
+    ConsoleRGB.echo_warn text
   end
 end
 

Data/Scripts/001_Technical/002_RubyUtilities.rb

@@ -100,6 +100,36 @@ class Array
   end
 end
 
+#===============================================================================
+# class Hash
+#===============================================================================
+class Hash
+  def deep_merge(hash)
+    h = self.clone
+    # failsafe
+    return h if !hash.is_a?(Hash)
+    for key in hash.keys
+      if self[key].is_a?(Hash)
+        h.deep_merge!(hash[key])
+      else
+        h = hash[key]
+      end
+    end
+    return h
+  end
+
+  def deep_merge!(hash)
+    return if !hash.is_a?(Hash)
+    for key in hash.keys
+      if self[key].is_a?(Hash)
+        self[key].deep_merge!(hash[key])
+      else
+        self[key] = hash[key]
+      end
+    end
+  end
+end
+
 #===============================================================================
 # module Enumerable
 #===============================================================================

Data/Scripts/001_Technical/005_PluginManager.rb

@@ -352,7 +352,7 @@ module PluginManager
   def self.error(msg)
     Graphics.update
     t = Thread.new do
-      echoln "Plugin Error:\r\n#{msg}"
+      ConsoleRGB.echo_error "Plugin Error:\r\n#{msg}"
       p "Plugin Error: #{msg}"
       Thread.exit
     end
@@ -659,7 +659,7 @@ module PluginManager
   # Check if plugins need compiling
   #-----------------------------------------------------------------------------
   def self.compilePlugins(order, plugins)
-    echo "  -> Compiling plugin scripts..."
+    ConsoleRGB.echo_li "Compiling plugin scripts..."
     scripts = []
     # go through the entire order one by one
     for o in order
@@ -681,14 +681,13 @@ module PluginManager
     File.open("Data/PluginScripts.rxdata", 'wb') { |f| Marshal.dump(scripts, f) }
     # collect garbage
     GC.start
-    echoln_good "done"
+    ConsoleRGB.echo_complete(true)
   end
   #-----------------------------------------------------------------------------
   # Check if plugins need compiling
   #-----------------------------------------------------------------------------
   def self.runPlugins
-    echoln_warn "*** Checking plugins ***"
-    echoln ""
+    ConsoleRGB.echo_h1 "Checking plugins"
     # get the order of plugins to interpret
     order, plugins = self.getPluginOrder
     # compile if necessary
@@ -700,7 +699,7 @@ module PluginManager
       # get the required data
       name, meta, script = plugin
       if !meta[:essentials] || !meta[:essentials].include?(Essentials::VERSION)
-        echoln_warn "WARNING: Plugin '#{name}' may not be compatible with Essentials v#{Essentials::VERSION}. Trying to load anyway."
+        ConsoleRGB.echo_warn "Plugin '#{name}' may not be compatible with Essentials v#{Essentials::VERSION}. Trying to load anyway."
       end
       # register plugin
       self.register(meta)
@@ -716,7 +715,7 @@ module PluginManager
         # try to run the code
         begin
           eval(code, TOPLEVEL_BINDING, fname)
-          echoln "  -> Loaded plugin: \e[35m#{name}\e[0m" if !echoed_plugins.include?(name)
+          ConsoleRGB.echoln_li "Loaded plugin: '#{name}'" if !echoed_plugins.include?(name)
           echoed_plugins.push(name)
         rescue Exception   # format error message to display
           self.pluginErrorMsg(name, sname)
@@ -726,11 +725,9 @@ module PluginManager
     end
     if scripts.length > 0
       echoln ""
-      echoln_good "Successfully loaded #{scripts.length} plugin(s)"
-      echoln ""
+      ConsoleRGB.echo_h2("Successfully loaded #{scripts.length} plugin(s)", text: :green)
     else
-      echoln_good "No plugins found"
-      echoln ""
+      ConsoleRGB.echo_h2("No plugins found", text: :green)
     end
   end
   #-----------------------------------------------------------------------------