mdless 1.0.19 → 1.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177d5a80ad079db4b2ee9598a9cd723ca275a2b81ad7e933558cc57268a2a7bb
-  data.tar.gz: 8bd13a6eaea6098de22d044a0221fe4f80b95ed6876f6796021812e976dec751
+  metadata.gz: a674236c5a4e7f4ab6690f8a4fd47d0626c245d17adecd2836280fdb6f7ae7b7
+  data.tar.gz: c42b395d103fadafab8dbc67df72c7521a1f58ae81dbb56769eef4dbed5a0da8
 SHA512:
-  metadata.gz: c9f4f5e25bf137670ce14151334faa970fe4125ee39d4d243fc2498c2df57a77ef0f254b7adeeda3eaf8eabc18cf082e1513f177e10a3627aa824141e8e7af7c
-  data.tar.gz: f1c59f8420703918c2c398e595f87dc51c27f29c9b8ed5f6fa69a4889ec094eb6ef4c183525c5386fd4783efdf37f66b776b7c78a444f36969fe24c795ac0103
+  metadata.gz: 8ed88f16f9407ba091a19aecee96cbce02d179ea6b657106792ad64e25899b746c6dbfd9d59a5911a9bf576a4c64758ebbe4030d1f03b2016496db5c5a417376
+  data.tar.gz: 275b4d1b53eb22e7ef1d74285bc2b8ddd687e1af1e92fac1ae4f49ca0f8c49d1c7681df9e1f92a6496e83e2b0274e469a88cffd0e0fe97d961a57f966aef60d3

data/README.md

@@ -1,4 +1,3 @@
-
 # mdless
 
 `mdless` is a utility that provides a formatted and highlighted view of Markdown files in Terminal.
@@ -27,6 +26,14 @@ I often use iTerm2 in visor mode, so `qlmanage -p` is annoying. I still wanted a
 
     gem install mdless
 
+### Dependencies
+
+Some OSs are missing `tput`, which is necessary for mdless.
+
+    apt update
+    apt install ruby ncurses-utils
+    gem install mdless
+
 ## Usage 
 
 `mdless [options] path` or `cat [path] | mdless`

data/lib/mdless/colors.rb

@@ -71,7 +71,7 @@ module CLIMarkdown
       self.uncolor.size
     end
 
-    def wrap(width=78)
+    def wrap(width=78,foreground=:x)
 
       if self.uncolor =~ /(^([%~] |\s*>)| +[=\-]{5,})/
         return self
@@ -87,7 +87,7 @@ module CLIMarkdown
       input.split(/\s+/).each do |word|
         last_ansi = line.scan(/\e\[[\d;]+m/)[-1] || ''
         if visible_width + word.size_clean >= width
-          lines << line + xc
+          lines << line + xc(foreground)
           visible_width = word.size_clean
           line = last_ansi + word
         elsif line.empty?
@@ -98,18 +98,11 @@ module CLIMarkdown
           line << " " << last_ansi + word
         end
        end
-       lines << line + self.match(/\s*$/)[0] + xc if line
+       lines << line + self.match(/\s*$/)[0] + xc(foreground) if line
       return lines.join("\n") # .gsub(/\- (\S)/,'-\1')
     end
 
-    def xc(count=0)
-      c([:x,:white])
-    end
-
     def c(args)
-
-
-
       out = []
 
       args.each {|arg|
@@ -124,6 +117,12 @@ module CLIMarkdown
         ''
       end
     end
+
+    private
+
+    def xc(foreground=:x)
+      c([foreground])
+    end
   end
 end
 

data/lib/mdless/converter.rb

@@ -105,7 +105,12 @@ module CLIMarkdown
         end
       end
 
-      optparse.parse!
+      begin
+        optparse.parse!
+      rescue OptionParser::ParseError => pe
+        $stderr.puts "error: #{pe.message}"
+        exit 1
+      end
 
       @theme = load_theme(@options[:theme])
       @cols = @options[:width]
@@ -164,7 +169,7 @@ module CLIMarkdown
       if @theme.key?(keys[0])
         val = @theme[keys.shift]
       else
-        @log.error("Invalid theme key: #{key}")
+        @log.error("Invalid theme key: #{key}") unless keys[0] =~ /^text/
         return c([:reset])
       end
       keys.each {|k|
@@ -355,7 +360,7 @@ module CLIMarkdown
       end
     end
 
-    def find_color(line,nullable=false)
+    def find_color(line, nullable = false)
       return line if line.nil?
       colors = line.scan(/\e\[[\d;]+m/)
       if colors && colors.size > 0
@@ -468,13 +473,14 @@ module CLIMarkdown
         color('code_block border'),
         '--[ ',
         color('code_block title'),
-        leader,
+        leader.chomp,
         color('code_block border'),
         ' ]',
-        '-'*(@cols-new_indent-leader.size+1),
+        '-'*(@cols-new_indent-leader.size-2),
         xc,
         "\n",
-        hilite,
+        hilite.chomp,
+        "\n",
         " "*(new_indent),
         color('code_block border'),
         '-'*(@cols-new_indent),
@@ -576,6 +582,44 @@ module CLIMarkdown
       #   match = Regexp.last_match
       #   "#" * (match[1].length - h_adjust)
       # end
+      #
+      # Headlines
+      @headers.each {|h|
+        input.sub!(/^#{Regexp.escape(h[2])}/m) do |m|
+          pad = ''
+          ansi = ''
+          case h[0].length
+          when 1
+            ansi = color('h1 color')
+            pad = color('h1 pad')
+            char = @theme['h1']['pad_char'] || "="
+            pad += h[1].length + 2 > @cols ? char*h[1].length : char*(@cols - (h[1].length + 1))
+          when 2
+            ansi = color('h2 color')
+            pad = color('h2 pad')
+            char = @theme['h2']['pad_char'] || "-"
+            pad += h[1].length + 2 > @cols ? char*h[1].length : char*(@cols - (h[1].length + 1))
+          when 3
+            ansi = color('h3 color')
+          when 4
+            ansi = color('h4 color')
+          when 5
+            ansi = color('h5 color')
+          else
+            ansi = color('h6 color')
+          end
+
+          # If we're in iTerm and not paginating, add
+          # iTerm Marks for navigation on h1-3
+          if h[0].length < 4 &&
+            ENV['TERM_PROGRAM'] =~ /^iterm/i &&
+            @options[:pager] == false
+            ansi = "\e]1337;SetMark\a" + ansi
+          end
+
+          "\n#{xc}#{ansi}#{h[1]} #{pad}#{xc}\n"
+        end
+      }
 
       # code block parsing
       input.gsub!(/(?i-m)(^[ \t]*[`~]{3,})([\s\S]*?)\n([\s\S]*?)\1/m) do
@@ -632,11 +676,41 @@ module CLIMarkdown
           #   previous_indent = indent
           # end
         else
+          # list items
+          # TODO: Fix ordered list numbering, pad numbers based on total number of list items
+          line.gsub!(/^(\s*)([*\-+]|\d+\.) /) do |m|
+            match = Regexp.last_match
+            last = find_color(match.pre_match)
+            mcolor = match[2] =~ /^\d+\./ ? 'list number' : 'list bullet'
+            indent = match[1] || ''
+            [
+              indent,
+              color(mcolor),
+              match[2], " ",
+              color('list color')
+            ].join
+          end
+
+          # definition lists
+          line.gsub!(/^(:\s*)(.*?)/) do |m|
+            match = Regexp.last_match
+            [
+              color('dd marker'),
+              match[1],
+              " ",
+              color('dd color'),
+              match[2],
+              xc
+            ].join
+          end
+
           # place footnotes under paragraphs that reference them
           if line =~ /\[(?:\e\[[\d;]+m)*\^(?:\e\[[\d;]+m)*(\S+)(?:\e\[[\d;]+m)*\]/
-            key = $1.uncolor
+            match = Regexp.last_match
+            key = match[1].uncolor
             if @footnotes.key? key
-              line += "\n\n#{c(%i[b black on_black])}[#{c(%i[b cyan on_black])}^#{c(%i[x yellow on_black])}#{key}#{c(%i[b black on_black])}]: #{c(%i[u white on_black])}#{@footnotes[key]}#{xc}"
+              line = "#{xc}#{line}"
+              line += "\n\n#{color('footnote brackets')}[#{color('footnote caret')}^#{color('footnote title')}#{key}#{color('footnote brackets')}]: #{color('footnote note')}#{@footnotes[key]}#{xc}"
               @footnotes.delete(key)
             end
           end
@@ -650,7 +724,7 @@ module CLIMarkdown
               counter -= 1
               find_color(lines[counter])
             end
-            "#{c(%i[b black])}[#{c(%i[b yellow])}^#{c(%i[x yellow])}#{match[1]}#{c(%i[b black])}]" + (last ? last : xc)
+            "#{color('footnote brackets')}[#{color('footnote caret')}^#{color('footnote title')}#{match[1]}#{color('footnote brackets')}]" + (last ? last : xc)
           end
 
           # blockquotes
@@ -666,7 +740,6 @@ module CLIMarkdown
           end
 
           # make reference links inline
-
           line.gsub!(/(?<![\e*])\[(\b.*?\b)?\]\[(\b.+?\b)?\]/) do |m|
             match = Regexp.last_match
             title = match[2] || ''
@@ -690,23 +763,6 @@ module CLIMarkdown
             color_link(match.pre_match, match[1], match[2])
           end
 
-
-
-          # inline code
-          line.gsub!(/`(.*?)`/) do |m|
-            match = Regexp.last_match
-            last = find_color(match.pre_match, true)
-            [
-              color('code_span marker'),
-              '`',
-              color('code_span color'),
-              match[1],
-              color('code_span marker'),
-              '`',
-              last ? last : xc
-            ].join
-          end
-
           # horizontal rules
           line.gsub!(/^ {,3}([\-*] ?){3,}$/) do |m|
             color('hr color') + '_'*@cols + xc
@@ -741,7 +797,7 @@ module CLIMarkdown
           end
 
           # equations
-          line.gsub!(/((\\\\\[)(.*?)(\\\\\])|(\\\\\()(.*?)(\\\\\)))/) do |m|
+          line.gsub!(/((\\\\\[|\$\$)(.*?)(\\\\\]|\$\$)|(\\\\\(|\$)(.*?)(\\\\\)|\$))/) do |m|
             match = Regexp.last_match
             last = find_color(match.pre_match)
             if match[2]
@@ -754,34 +810,6 @@ module CLIMarkdown
             "#{c(%i[b black])}#{brackets[0]}#{xc}#{c(%i[b blue])}#{equat}#{c(%i[b black])}#{brackets[1]}" + (last ? last : xc)
           end
 
-          # list items
-          # TODO: Fix ordered list numbering, pad numbers based on total number of list items
-          line.gsub!(/^(\s*)([*\-+]|\d+\.) /) do |m|
-            match = Regexp.last_match
-            last = find_color(match.pre_match)
-            mcolor = match[2] =~ /^\d+\./ ? 'list number' : 'list bullet'
-            indent = match[1] || ''
-            [
-              indent,
-              color(mcolor),
-              match[2], " ",
-              color('list color')
-            ].join
-          end
-
-          # definition lists
-          line.gsub!(/^(:\s*)(.*?)/) do |m|
-            match = Regexp.last_match
-            [
-              color('dd marker'),
-              match[1],
-              " ",
-              color('dd color'),
-              match[2],
-              xc
-            ].join
-          end
-
           # misc html
           line.gsub!(/<br\/?>/, "\n")
           line.gsub!(/(?i-m)((<\/?)(\w+[\s\S]*?)(>))/) do |tag|
@@ -797,51 +825,33 @@ module CLIMarkdown
               last ? last : xc
             ].join
           end
+
+          # inline code spans
+          line.gsub!(/`(.*?)`/) do |m|
+            match = Regexp.last_match
+            last = find_color(match.pre_match, true)
+            [
+              color('code_span marker'),
+              '`',
+              color('code_span color'),
+              match[1],
+              color('code_span marker'),
+              '`',
+              last ? last : xc
+            ].join
+          end
         end
 
+        ## Should force a foreground color but doesn't...
+        # unless line =~ /^\s*\e\[[\d;]+m/
+        #   line.sub!(/^(\s*)/, "\\1#{color('text')}")
+        # end
+
         line
       end
 
       input = lines.join("\n")
 
-      # Headlines
-      @headers.each {|h|
-        input.sub!(/^#{Regexp.escape(h[2])}/m) do |m|
-          pad = ''
-          ansi = ''
-          case h[0].length
-          when 1
-            ansi = color('h1 color')
-            pad = color('h1 pad')
-            char = @theme['h1']['pad_char'] || "="
-            pad += h[1].length + 2 > @cols ? char*h[1].length : char*(@cols - (h[1].length + 1))
-          when 2
-            ansi = color('h2 color')
-            pad = color('h2 pad')
-            char = @theme['h2']['pad_char'] || "-"
-            pad += h[1].length + 2 > @cols ? char*h[1].length : char*(@cols - (h[1].length + 1))
-          when 3
-            ansi = color('h3 color')
-          when 4
-            ansi = color('h4 color')
-          when 5
-            ansi = color('h5 color')
-          else
-            ansi = color('h6 color')
-          end
-
-          # If we're in iTerm and not paginating, add
-          # iTerm Marks for navigation on h1-3
-          if h[0].length < 4 &&
-            ENV['TERM_PROGRAM'] =~ /^iterm/i &&
-            @options[:pager] == false
-            ansi = "\e]1337;SetMark\a" + ansi
-          end
-
-          "\n#{xc}#{ansi}#{h[1]} #{pad}#{xc}\n"
-        end
-      }
-
       # images
       input.gsub!(/^(.*?)!\[(.*)?\]\((.*?\.(?:png|gif|jpg))( +.*)?\)/) do |m|
         match = Regexp.last_match
@@ -980,7 +990,7 @@ module CLIMarkdown
 
     def printout
       out = @output.rstrip.split(/\n/).map {|p|
-        p.wrap(@cols)
+        p.wrap(@cols, color('text'))
       }.join("\n")
 
 
@@ -1034,14 +1044,18 @@ module CLIMarkdown
       when 'more'
         ' -r'
       when 'less'
-        ' -r'
+        ' -Xr'
       when 'bat'
-        ' -p'
+        ' -p --pager="less -Xr"'
       else
         ''
       end
 
       [pg, args]
     end
+
+    def xc
+      color('text')
+    end
   end
 end

data/lib/mdless/theme.rb

@@ -93,11 +93,11 @@ module CLIMarkdown
       new_theme = YAML.load(IO.read(theme_file))
       begin
         theme = THEME_DEFAULTS.deep_merge(new_theme)
-        # write merged theme back in case there are new keys since
-        # last updated
-        File.open(theme_file,'w') {|f|
-          f.puts theme.to_yaml
-        }
+        # # write merged theme back in case there are new keys since
+        # # last updated
+        # File.open(theme_file,'w') {|f|
+        #   f.puts theme.to_yaml
+        # }
       rescue
         @log.warn('Error merging user theme')
         theme = THEME_DEFAULTS

data/lib/mdless/version.rb

@@ -1,3 +1,3 @@
 module CLIMarkdown
-  VERSION = '1.0.19'
+  VERSION = '1.0.24'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.0.24
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,20 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.1
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A CLI that provides a formatted and highlighted view of Markdown files
   in a terminal
 email: me@brettterpstra.com
@@ -103,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: A pager like less, but for Markdown files