mdless 2.0.8 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef90f38be64fdcd4e3666782b957ac2a27ec4346103fa79a1760626977051a8f
-  data.tar.gz: 856113d17ab7217c28de2f2c2405acd185e99cdc4ca0370fbb73053371babab1
+  metadata.gz: 468f95eded917152908f139d4298880ebcdbe2d38fcf577486847ec182202d0b
+  data.tar.gz: bb363add08669734e7cfa045250e64697890a502d601bce436c1e1b84d528e19
 SHA512:
-  metadata.gz: f291d6eef35c904afc13adecc673db8736b002e556fc55f311cae6721685868f709cc285cf2a2906657933a05f385ce5168190e8672f16a672b8dd41f3bb7d1c
-  data.tar.gz: 75c67e0498a10ff7c26d2b9f9d43808174826807369650b33918ba0b63342cfaf1ae359530f957db2b9c403026918783d3411a291f92b732e6a2921efccd15b0
+  metadata.gz: 52d6fefb531c0737a8a7016eea8edd00c4ed3dbc42d529bd8792d93de1135747fcdb1d3376937f2884a6f7710bf63f279e6defdd0f88e09930b9aa097e9d9d51
+  data.tar.gz: 1d770f5851603051274e5e188b4bc1e75c93188c3d64d415496687e53bd93fc0a88301fb16a3789f022495348e97488f448fbaa48cc5f2a5dab133d10f14faed

data/README.md

@@ -94,6 +94,21 @@ Font and color settings are set using a string of color names and modifiers. A t
 
 Some extra (non-color) settings are available for certain keys, e.g. `pad_char` to define the right padding character used on level 1 and 2 headlines. Note that you can change the [Pygments](http://pygments.org/) theme used for syntax highlighting with the code_block.pygments_theme setting. For a list of available styles (assuming you have Pygments installed), use `pygmentize -L styles`.
 
+The display of characters around emphasis and code spans can be configured. By default, the surrounding character for bold is `**`, italic is `_`, and code span is \`. You can leave these keys empty to not display characters at all. For triple-emphasized text, the text will be surrounded by italic and bold characters, in that order.
+
+```yaml
+emphasis:
+  bold: b
+  bold_character: "**"
+  italic: u i
+  italic_character: ""
+  bold-italic: b u i
+code_span:
+  marker: b white
+  color: b white on_intense_black
+  character: ""
+```
+
 *Note:* the ANSI escape codes are reset every time the color changes, so, for example, if you have a key that defines underlines for the url in a link, the underline will automatically be removed when it gets to a bracket. This also means that if you define a background color, you'll need to define it again on all the keys that it should affect.
 
 Base colors:

data/lib/mdless/colors.rb

@@ -1,5 +1,6 @@
 module CLIMarkdown
   module Colors
+    ESCAPE_REGEX = /(?<=\[)(?:(?:(?:[349]|10)[0-9]|[0-9])?;?)+(?=m)/.freeze
 
     COLORS = {
             :reset => 0,     # synonym for :clear
@@ -57,6 +58,118 @@ module CLIMarkdown
       self.gsub(/\e\[[\d;]+m/,'')
     end
 
+    # Get the calculated ANSI color at the end of the
+    # string
+    #
+    # @return     ANSI escape sequence to match color
+    #
+    def last_color_code
+      m = scan(ESCAPE_REGEX)
+
+      em = ['0']
+      fg = nil
+      bg = nil
+      rgbf = nil
+      rgbb = nil
+
+      m.each do |c|
+        case c
+        when '0'
+          em = ['0']
+          fg, bg, rgbf, rgbb = nil
+        when /^[34]8/
+          case c
+          when /^3/
+            fg = nil
+            rgbf = c
+          when /^4/
+            bg = nil
+            rgbb = c
+          end
+        else
+          c.split(/;/).each do |i|
+            x = i.to_i
+            if x <= 9
+              em << x
+            elsif x >= 30 && x <= 39
+              rgbf = nil
+              fg = x
+            elsif x >= 40 && x <= 49
+              rgbb = nil
+              bg = x
+            elsif x >= 90 && x <= 97
+              rgbf = nil
+              fg = x
+            elsif x >= 100 && x <= 107
+              rgbb = nil
+              bg = x
+            end
+          end
+        end
+      end
+
+      escape = "\e[#{em.join(';')}m"
+      escape += "\e[#{rgbb}m" if rgbb
+      escape += "\e[#{rgbf}m" if rgbf
+      escape + "\e[#{[fg, bg].delete_if(&:nil?).join(';')}m"
+    end
+
+    # Get the calculated ANSI color at the end of the
+    # string
+    #
+    # @return     ANSI escape sequence to match color
+    #
+    def last_color_code
+      m = scan(ESCAPE_REGEX)
+
+      em = ['0']
+      fg = nil
+      bg = nil
+      rgbf = nil
+      rgbb = nil
+
+      m.each do |c|
+        case c
+        when '0'
+          em = ['0']
+          fg, bg, rgbf, rgbb = nil
+        when /^[34]8/
+          case c
+          when /^3/
+            fg = nil
+            rgbf = c
+          when /^4/
+            bg = nil
+            rgbb = c
+          end
+        else
+          c.split(/;/).each do |i|
+            x = i.to_i
+            if x <= 9
+              em << x
+            elsif x >= 30 && x <= 39
+              rgbf = nil
+              fg = x
+            elsif x >= 40 && x <= 49
+              rgbb = nil
+              bg = x
+            elsif x >= 90 && x <= 97
+              rgbf = nil
+              fg = x
+            elsif x >= 100 && x <= 107
+              rgbb = nil
+              bg = x
+            end
+          end
+        end
+      end
+
+      escape = "\e[#{em.join(';')}m"
+      escape += "\e[#{rgbb}m" if rgbb
+      escape += "\e[#{rgbf}m" if rgbf
+      escape + "\e[#{[fg, bg].delete_if(&:nil?).join(';')}m"
+    end
+
     def blackout(bgcolor)
       key = bgcolor.to_sym
       bg = COLORS.key?(key) ? COLORS[key] : 40

data/lib/mdless/console.rb

@@ -7,11 +7,21 @@ module Redcarpet
 
       @@listitemid = 0
       @@listid = 0
+      @@elementid = 0
       @@footnotes = []
       @@headers = []
       @@links = []
       @@footer_links = []
 
+      def pre_element
+        @@elementid += 1
+        "<<pre#{@@elementid}>>"
+      end
+
+      def post_element
+        "<<post#{@@elementid}>>"
+      end
+
       def xc
         x + color('text')
       end
@@ -268,42 +278,72 @@ module Redcarpet
 
       def autolink(link, _)
         [
+          pre_element,
           color('link brackets'),
           '<',
           color('link url'),
           link,
           color('link brackets'),
           '>',
-          xc
+          xc,
+          post_element
         ].join('')
       end
 
       def codespan(code)
         [
+          pre_element,
           color('code_span marker'),
-          '`',
+          @theme['code_span']['character'],
           color('code_span color'),
           code,
           color('code_span marker'),
-          '`',
-          xc
+          @theme['code_span']['character'],
+          xc,
+          post_element
         ].join('')
       end
 
       def double_emphasis(text)
-        "#{color('emphasis bold')}#{text}#{xc}"
+        [
+          pre_element,
+          color('emphasis bold'),
+          @theme['emphasis']['bold_character'],
+          text,
+          @theme['emphasis']['bold_character'],
+          xc,
+          post_element
+        ].join
       end
 
       def emphasis(text)
-        "#{color('emphasis italic')}#{text}#{xc}"
+        [
+          pre_element,
+          color('emphasis italic'),
+          @theme['emphasis']['italic_character'],
+          text,
+          @theme['emphasis']['italic_character'],
+          xc,
+          post_element
+        ].join
       end
 
       def triple_emphasis(text)
-        "#{color('emphasis bold-italic')}#{text}#{xc}"
+        [
+          pre_element,
+          color('emphasis bold-italic'),
+          @theme['emphasis']['italic_character'],
+          @theme['emphasis']['bold_character'],
+          text,
+          @theme['emphasis']['bold_character'],
+          @theme['emphasis']['italic_character'],
+          xc,
+          post_element
+        ].join
       end
 
       def highlight(text)
-        "#{color('highlight')}#{text}#{xc}"
+        "#{pre_element}#{color('highlight')}#{text}#{xc}#{post_element}"
       end
 
       def color_image_tag(link, title, alt_text)
@@ -321,80 +361,12 @@ module Redcarpet
           title.nil? ? '' : %( "#{title}"),
           color('image brackets'),
           ')',
-          xc
+          xc,
         ].join
       end
 
       def image(link, title, alt_text)
-        if (exec_available('imgcat') || exec_available('chafa')) && @options[:local_images]
-          if exec_available('imgcat')
-            @log.info('Using imgcat for image rendering')
-          elsif exec_available('chafa')
-            @log.info('Using chafa for image rendering')
-          end
-          img_path = link
-          if img_path =~ /^http/ && @options[:remote_images]
-            if exec_available('imgcat')
-              @log.info('Using imgcat for image rendering')
-              begin
-                res, s = Open3.capture2(%(curl -sS "#{img_path}" 2> /dev/null | imgcat))
-
-                if s.success?
-                  pre = !alt_text.nil? ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
-                  post = !title.nil? ? "\n    #{c(%i[b blue])}-- #{title} --" : ''
-                  result = pre + res + post
-                end
-              rescue StandardError => e
-                @log.error(e)
-              end
-            elsif exec_available('chafa')
-              @log.info('Using chafa for image rendering')
-              term = ''
-              term = ENV['TERM_PROGRAM'] =~ /iterm/i ? '-f iterm' : term
-              term = ENV['TERM_PROGRAM'] =~ /kitty/i ? '-f kitty' : term
-              FileUtils.rm_r '.mdless_tmp', force: true if File.directory?('.mdless_tmp')
-              Dir.mkdir('.mdless_tmp')
-              Dir.chdir('.mdless_tmp')
-              `curl -SsO #{img_path} 2> /dev/null`
-              tmp_img = File.basename(img_path)
-              img = `chafa #{term} "#{tmp_img}"`
-              pre = alt_text ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
-              post = title ? "\n    #{c(%i[b blue])}-- #{tail} --" : ''
-              result = pre + img + post
-              Dir.chdir('..')
-              FileUtils.rm_r '.mdless_tmp', force: true
-            else
-              @log.warn('No viewer for remote images')
-            end
-          else
-            if img_path =~ %r{^[~/]}
-              img_path = File.expand_path(img_path)
-            elsif @file
-              base = File.expand_path(File.dirname(@file))
-              img_path = File.join(base, img_path)
-            end
-            if File.exist?(img_path)
-              pre = !alt_text.nil? ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
-              post = !title.nil? ? "\n    #{c(%i[b blue])}-- #{title} --" : ''
-              if exec_available('imgcat')
-                img = `imgcat -p "#{img_path}"`
-                @log.info("Rendering image with `imgcat -p #{img_path}`")
-              elsif exec_available('chafa')
-                term = ''
-                term = ENV['TERM_PROGRAM'] =~ /iterm/i ? '-f iterm' : term
-                term = ENV['TERM_PROGRAM'] =~ /kitty/i ? '-f kitty' : term
-                @log.info("Rendering image with `chafa #{term} #{img_path}`")
-                img = `chafa #{term} "#{img_path}"`
-              end
-              result = pre + img + post
-            end
-          end
-        end
-        if result.nil?
-          color_image_tag(link, title, alt_text)
-        else
-          result + xc
-        end
+        "<<img>>#{link}||#{title}||#{alt_text}<</img>>"
       end
 
       def linebreak
@@ -403,6 +375,7 @@ module Redcarpet
 
       def color_link(link, title, content)
         [
+          pre_element,
           color('link brackets'),
           '[',
           color('link text'),
@@ -414,12 +387,14 @@ module Redcarpet
           title.nil? ? '' : %( "#{title}"),
           color('link brackets'),
           ')',
-          xc
+          xc,
+          post_element
         ].join
       end
 
       def color_link_reference(link, idx, content)
         [
+          pre_element,
           color('link brackets'),
           '[',
           color('link text'),
@@ -430,7 +405,8 @@ module Redcarpet
           idx,
           color('link brackets'),
           ']',
-          xc
+          xc,
+          post_element
         ].join
       end
 
@@ -463,19 +439,19 @@ module Redcarpet
       end
 
       def color_tags(html)
-        html.gsub(%r{(<\S+( .*?)?/?>)}, "#{color('html brackets')}\\1#{xc}")
+        html.gsub(%r{(<\S+( [^>]+)?>)}, "#{color('html brackets')}\\1#{xc}")
       end
 
       def raw_html(raw_html)
-        "#{color('html color')}#{color_tags(raw_html)}#{xc}"
+        "#{pre_element}#{color('html color')}#{color_tags(raw_html)}#{xc}#{post_element}"
       end
 
       def strikethrough(text)
-        "#{color('strikethrough')}#{text}#{xc}"
+        "#{pre_element}#{color('strikethrough')}#{text}#{xc}#{post_element}"
       end
 
       def superscript(text)
-        "#{color('super')}^#{text}#{xc}"
+        "#{pre_element}#{color('super')}^#{text}#{xc}#{post_element}"
       end
 
       def footnotes(text)
@@ -513,9 +489,11 @@ module Redcarpet
 
       def footnote_ref(text)
         [
+          pre_element,
           color('footnote title'),
           "[^#{text}]",
-          xc
+          xc,
+          post_element
         ].join('')
       end
 
@@ -722,7 +700,117 @@ module Redcarpet
         end
       end
 
+      def fix_colors(input)
+        input.gsub(/<<pre(?<id>\d+)>>(?<content>.*?)<<post\k<id>>>/m) do
+          m = Regexp.last_match
+          pre = m.pre_match
+          last_color = pre.last_color_code
+          "#{fix_colors(m['content'])}#{last_color}"
+        end.gsub(/<<(pre|post)\d+>>/, '')
+      end
+
+      def render_images(input)
+        input.gsub(%r{<<img>>(.*?)<</img>>}) do
+          link, title, alt_text = Regexp.last_match(1).split(/\|\|/)
+
+          if (exec_available('imgcat') || exec_available('chafa')) && @options[:local_images]
+            if exec_available('imgcat')
+              @log.info('Using imgcat for image rendering')
+            elsif exec_available('chafa')
+              @log.info('Using chafa for image rendering')
+            end
+            img_path = link
+            if img_path =~ /^http/ && @options[:remote_images]
+              if exec_available('imgcat')
+                @log.info('Using imgcat for image rendering')
+                begin
+                  res, s = Open3.capture2(%(curl -sS "#{img_path}" 2> /dev/null | imgcat))
+
+                  if s.success?
+                    pre = !alt_text.nil? ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
+                    post = !title.nil? ? "\n    #{c(%i[b blue])}-- #{title} --" : ''
+                    result = pre + res + post
+                  end
+                rescue StandardError => e
+                  @log.error(e)
+                end
+              elsif exec_available('chafa')
+                @log.info('Using chafa for image rendering')
+                term = '-f sixels'
+                term = ENV['TERMINAL_PROGRAM'] =~ /iterm/i ? '-f iterm' : term
+                term = ENV['TERMINAL_PROGRAM'] =~ /kitty/i ? '-f kitty' : term
+                FileUtils.rm_r '.mdless_tmp', force: true if File.directory?('.mdless_tmp')
+                Dir.mkdir('.mdless_tmp')
+                Dir.chdir('.mdless_tmp')
+                `curl -SsO #{img_path} 2> /dev/null`
+                tmp_img = File.basename(img_path)
+                img = `chafa #{term} "#{tmp_img}"`
+                pre = alt_text ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
+                post = title ? "\n    #{c(%i[b blue])}-- #{tail} --" : ''
+                result = pre + img + post
+                Dir.chdir('..')
+                FileUtils.rm_r '.mdless_tmp', force: true
+              else
+                @log.warn('No viewer for remote images')
+              end
+            else
+              if img_path =~ %r{^[~/]}
+                img_path = File.expand_path(img_path)
+              elsif @file
+                base = File.expand_path(File.dirname(@file))
+                img_path = File.join(base, img_path)
+              end
+              if File.exist?(img_path)
+                pre = !alt_text.nil? ? "    #{c(%i[d blue])}[#{alt_text.strip}]\n" : ''
+                post = !title.nil? ? "\n    #{c(%i[b blue])}-- #{title} --" : ''
+                if exec_available('imgcat')
+                  img = `imgcat "#{img_path}"`
+                elsif exec_available('chafa')
+                  term = '-f sixels'
+                  term = ENV['TERMINAL_PROGRAM'] =~ /iterm/i ? '-f iterm' : term
+                  term = ENV['TERMINAL_PROGRAM'] =~ /kitty/i ? '-f kitty' : term
+                  img = `chafa #{term} "#{img_path}"`
+                end
+                result = pre + img + post
+              end
+            end
+          end
+          if result.nil?
+            color_image_tag(link, title, alt_text)
+          else
+            "#{pre_element}#{result}#{xc}#{post_element}"
+          end
+        end
+      end
+
+      def fix_equations(input)
+        input.gsub(/((\\\\\[|\$\$)(.*?)(\\\\\]|\$\$)|(\\\\\(|\$)(.*?)(\\\\\)|\$))/) do
+          m = Regexp.last_match
+          if m[2]
+            brackets = [m[2], m[4]]
+            equat = m[3]
+          else
+            brackets = [m[5], m[7]]
+            equat = m[6]
+          end
+          [
+            pre_element,
+            color('math brackets'),
+            brackets[0],
+            xc,
+            color('math equation'),
+            equat,
+            color('math brackets'),
+            brackets[1],
+            xc,
+            post_element
+          ].join
+        end
+      end
+
       def postprocess(input)
+        input.scrub!
+
         if @options[:inline_footnotes]
           input = insert_footnotes(input)
         else
@@ -736,25 +824,15 @@ module Redcarpet
         # escaped characters
         input.gsub!(/\\(\S)/, '\1')
         # equations
-        input.gsub!(/((\\\\\[|\$\$)(.*?)(\\\\\]|\$\$)|(\\\\\(|\$)(.*?)(\\\\\)|\$))/) do
-          m = Regexp.last_match
-          if m[2]
-            brackets = [m[2], m[4]]
-            equat = m[3]
-          else
-            brackets = [m[5], m[7]]
-            equat = m[6]
-          end
-          "#{c(%i[b black])}#{brackets[0]}#{xc}#{c(%i[b blue])}#{equat}#{c(%i[b black])}#{brackets[1]}" + xc
-        end
+        input = fix_equations(input)
         # misc html
-        input.gsub!(%r{<br */?>}, "\n")
+        input.gsub!(%r{<br */?>}, "#{pre_element}\n#{post_element}")
         # format links
-        if @options[:links] == :reference || @options[:links] == :paragraph
-          input = reference_links(input)
-        end
+        input = reference_links(input) if @options[:links] == :reference || @options[:links] == :paragraph
         # lists
-        fix_lists(input, 0)
+        input = fix_lists(input, 0)
+        input = render_images(input) if @options[:local_images]
+        fix_colors(input)
       end
     end
   end

data/lib/mdless/converter.rb

@@ -14,7 +14,7 @@ module CLIMarkdown
 
     def initialize(args)
       @log = Logger.new($stderr)
-      @log.level = Logger::ERROR
+      @log.level = Logger::WARN
 
       @options = {}
       config = File.expand_path('~/.config/mdless/config.yml')

data/lib/mdless/string.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# String helpers
+class ::String
+  def scrub
+    encode('utf-16', invalid: :replace).encode('utf-8')
+  end
+
+  def scrub!
+    replace scrub
+  end
+end

data/lib/mdless/theme.rb

@@ -1,6 +1,5 @@
 module CLIMarkdown
   module Theme
-
     THEME_DEFAULTS = {
       'metadata' => {
         'border' => 'd blue on_black',
@@ -9,9 +8,12 @@ module CLIMarkdown
       },
       'emphasis' => {
         'bold' => 'b',
+        'bold_character' => '**',
         'italic' => 'u i',
+        'italic_character' => '_',
         'bold-italic' => 'b u i'
       },
+      'highlight' => 'b black on_yellow',
       'h1' => {
         'color' => 'b intense_black on_white',
         'pad' => 'd black on_white',
@@ -58,7 +60,8 @@ module CLIMarkdown
       },
       'code_span' => {
         'marker' => 'b white',
-        'color' => 'b white on_intense_black'
+        'color' => 'b white on_intense_black',
+        'character' => '`'
       },
       'code_block' => {
         'marker' => 'intense_black',
@@ -69,6 +72,13 @@ module CLIMarkdown
         'eol' => 'intense_black on_black',
         'pygments_theme' => 'monokai'
       },
+      'blockquote' => {
+        'marker' => {
+          'character' => '>',
+          'color' => 'yellow'
+        },
+        'color' => 'b white'
+      },
       'dd' => {
         'term' => 'black on_white',
         'marker' => 'd red',
@@ -88,6 +98,10 @@ module CLIMarkdown
         'brackets' => 'd yellow on_black',
         'color' => 'yellow on_black'
       },
+      'math' => {
+        'brackets' => 'b black',
+        'equation' => 'b blue'
+      },
       'super' => 'b green',
       'text' => 'white'
     }

data/lib/mdless/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CLIMarkdown
-  VERSION = '2.0.8'
+  VERSION = '2.0.10'
 end

data/lib/mdless.rb

@@ -8,6 +8,7 @@ require 'mdless/version.rb'
 require 'mdless/colors'
 require 'mdless/tables'
 require 'mdless/hash'
+require 'mdless/string'
 require 'mdless/theme'
 require 'redcarpet'
 require 'mdless/console'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.10
 platform: ruby
 authors:
 - Brett Terpstra
@@ -82,6 +82,7 @@ files:
 - lib/mdless/console.rb
 - lib/mdless/converter.rb
 - lib/mdless/hash.rb
+- lib/mdless/string.rb
 - lib/mdless/tables.rb
 - lib/mdless/theme.rb
 - lib/mdless/version.rb
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A pager like less, but for Markdown files