mdless 2.0.17 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d80ed856b198db9752c7ac96f964b2b2e05f7706288aef8fbf901417952a967
-  data.tar.gz: ad820a3d6a885fc2f50decf0b6f52444d267ca84f9b3bbf5f3945cce8413df15
+  metadata.gz: c8cad0405ab64bec59625210dfbf2708d23609ccc5f682b1a7c26d435ffb3d49
+  data.tar.gz: 747d4a04599b35b21a1a83c2607145cac4c0c5748acf6d0bde8ec024bcb7fd69
 SHA512:
-  metadata.gz: 60dcb01d030a0115bb49616dd507c53a2b605dc8f0d28a194092150489c36adfb33450b7ba3c87f54b4048bc6b5114cfce2b914c240e129a2cbf36f4d76ec420
-  data.tar.gz: b67938b0f651c324845d107074f04a647d8b46c60ee09386be627a1ad2d5ff50b08f31ef9a12984a6a209aeaa7d632cb47313c425c01a47f49b6b72b7a1f6022
+  metadata.gz: aacd16705ef1fa770536f10b3642fa536a6db9418248c760e9c47dce8ffbfca9fb55401d7f0507ae82bf6805080f530777d640eebb41dc513772c2c98b5c1e66
+  data.tar.gz: 69243a2f1968d871b222740ea9f3a8dd8f76895be6c49e8fb59db20f2ef85c78046b880eab0e95f4a6e1a6b377954904b15670d4f7ed1397cfa821da7a70f857

data/README.md

@@ -31,12 +31,6 @@ If you run into errors, try `gem install --user-install mdless`, or `sudo gem in
 
 ### Dependencies
 
-Some OSs are missing `tput`, which is necessary for mdless.
-
-    apt update
-    apt install ruby ncurses-utils
-    gem install mdless
-
 To render images, you need `imgcat` or `chafa` installed (`brew install chafa`).
 
 For syntax highlighting, the `pygmentize` command must be available, part of the [Pygments](http://pygments.org/) package (`brew install pygments`).

data/lib/mdless/array.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ::Array
+  def longest_element
+    group_by(&:size).max.last[0]
+  end
+
+  def longest_elements
+    group_by(&:size).max.last
+  end
+end

data/lib/mdless/colors.rb

@@ -55,7 +55,11 @@ module CLIMarkdown
           }
 
     def uncolor
-      self.gsub(/\e\[[\d;]+m/,'')
+      self.unpad.gsub(/\e\[[\d;]+m/,'')
+    end
+
+    def unpad
+      self.gsub(/\u00A0/, ' ')
     end
 
     # Get the calculated ANSI color at the end of the

data/lib/mdless/console.rb

@@ -58,20 +58,36 @@ module Redcarpet
         end
       end
 
-      def valid_lexer?(language)
-        lexers = %w(Clipper XBase Cucumber cucumber Gherkin gherkin RobotFramework robotframework abap ada ada95ada2005 ahk antlr-as antlr-actionscript antlr-cpp antlr-csharp antlr-c# antlr-java antlr-objc antlr-perl antlr-python antlr-ruby antlr-rb antlr apacheconf aconf apache applescript as actionscript as3 actionscript3 aspectj aspx-cs aspx-vb asy asymptote autoit Autoit awk gawk mawk nawk basemake bash sh ksh bat bbcode befunge blitzmax bmax boo brainfuck bf bro bugs winbugs openbugs c-objdump c ca65 cbmbas ceylon cfengine3 cf3 cfm cfs cheetah spitfire clojure clj cmake cobol cobolfree coffee-script coffeescript common-lisp cl console control coq cpp c++ cpp-objdump c++-objdumb cxx-objdump croc csharp c# css+django css+jinja css+erb css+ruby css+genshitext css+genshi css+lasso css+mako css+myghty css+php css+smarty css cuda cu cython pyx d-objdump d dart delphi pas pascal objectpascal dg diff udiff django jinja dpatch dtd duel Duel Engine Duel View JBST jbst JsonML+BST dylan-console dylan-repl dylan-lid lid dylan ec ecl elixir ex exs erb erl erlang evoque factor fan fancy fy felix flx fortran fsharp gas genshi kid xml+genshi xml+kid genshitext glsl gnuplot go gooddata-cl gosu groff nroff man groovy gst haml HAML haskell hs haxeml hxml html+cheetah html+spitfire html+django html+jinja html+evoque html+genshi html+kid html+lasso html+mako html+myghty html+php html+smarty html+velocity html http hx haXe hybris hy idl iex ini cfg io ioke ik irc jade JADE jags java jlcon js+cheetah javascript+cheetah js+spitfire javascript+spitfire js+django javascript+django js+jinja javascript+jinja js+erb javascript+erb js+ruby javascript+ruby js+genshitext js+genshi javascript+genshitext javascript+genshi js+lasso javascript+lasso js+mako javascript+mako js+myghty javascript+myghty js+php javascript+php js+smarty javascript+smarty js javascript json jsp julia jl kconfig menuconfig linux-config kernel-config koka kotlin lasso lassoscript lhs literate-haskell lighty lighttpd live-script livescript llvm logos logtalk lua make makefile mf bsdmake mako maql mason matlab matlabsession minid modelica modula2 m2 monkey moocode moon moonscript mscgen msc mupad mxml myghty mysql nasm nemerle newlisp newspeak nginx nimrod nim nsis nsi nsh numpy objdump objective-c++ objectivec++ obj-c++ objc++ objective-c objectivec obj-c objc objective-j objectivej obj-j objj ocaml octave ooc opa openedge abl progress perl pl php php3 php4 php5 plpgsql postgresql postgres postscript pot po pov powershell posh ps1 prolog properties protobuf psql postgresql-console postgres-console puppet py3tb pycon pypylog pypy pytb python py sage python3 py3 qml Qt Meta Language Qt modeling Language racket rkt ragel-c ragel-cpp ragel-d ragel-em ragel-java ragel-objc ragel-ruby ragel-rb ragel raw rb ruby duby rbcon irb rconsole rout rd rebol redcode registry rhtml html+erb html+ruby rst rest restructuredtext rust sass SASS scala scaml SCAML scheme scm scilab scss shell-session smali smalltalk squeak smarty sml snobol sourceslist sources.list sp spec splus s r sql sqlite3 squidconf squid.conf squid ssp stan systemverilog sv tcl tcsh csh tea tex latex text trac-wiki moin treetop ts urbiscript vala vapi vb.net vbnet velocity verilog v vgl vhdl vim xml+cheetah xml+spitfire xml+django xml+jinja xml+erb xml+ruby xml+evoque xml+lasso xml+mako xml+myghty xml+php xml+smarty xml+velocity xml xquery xqy xq xql xqm xslt xtend yaml)
-        lexers.include? language.strip
+      def code_bg(input, width)
+        input.split(/\n/).map do |line|
+          tail = line.uncolor.length < width ? "\u00A0" * (width - line.uncolor.length) : ''
+          "#{x}#{line}#{tail}#{x}"
+        end.join("\n")
       end
 
       def hilite_code(code_block, language)
-        @log.error('Syntax highlighting requested by pygmentize is not available') if @options[:syntax_higlight] && !exec_available('pygmentize')
+        if @options[:syntax_higlight] && !exec_available('pygmentize')
+          @log.error('Syntax highlighting requested by pygmentize is not available')
+          @options[:syntax_higlight] = false
+        end
+
+        longest_line = code_block.uncolor.split(/\n/).longest_element.length + 4
+        longest_line = longest_line > @cols ? @cols : longest_line
 
-        if @options[:syntax_higlight] && exec_available('pygmentize')
-          lexer = language && valid_lexer?(language) ? "-l #{language}" : '-g'
+        if @options[:syntax_higlight]
+          pyg = TTY::Which.which('pygmentize')
+          lexer = language&.valid_lexer? ? "-l #{language}" : '-g'
           begin
+            pygments_theme = @options[:pygments_theme] || @theme['code_block']['pygments_theme']
+
+            unless pygments_theme.valid_pygments_theme?
+              @log.error("Invalid Pygments theme #{pygments_theme}, defaulting to 'default' for highlighting")
+              pygments_theme = 'default'
+            end
+
             cmd = [
-              'pygmentize -f terminal256',
-              "-O style=#{@theme['code_block']['pygments_theme']}",
+              "#{pyg} -f terminal256",
+              "-O style=#{pygments_theme}",
               lexer,
               '2> /dev/null'
             ].join(' ')
@@ -102,17 +118,23 @@ module Redcarpet
           end.join("\n").blackout(@theme['code_block']['bg']) + "#{xc}\n"
         end
 
+        top_border = if language.nil? || language.empty?
+                       '-' * longest_line
+                     else
+                       "--[ #{language} ]#{'-' * (longest_line - 6 - language.length)}"
+                     end
+
         [
           xc,
           color('code_block border'),
-          '-' * 20,
+          top_border,
           xc,
           "\n",
           color('code_block color'),
-          hilite.chomp,
+          code_bg(hilite.chomp, longest_line),
           "\n",
           color('code_block border'),
-          '-' * 20,
+          '-' * longest_line,
           xc
         ].join
       end
@@ -505,7 +527,9 @@ module Redcarpet
 
         lines = input.split(/\n/)
         line1 = lines.shift
-        body = lines.map { |l| "#{'  ' * (indent + 1)}#{l}" }.join("\n")
+        pre = '  ' * (indent + 1)
+        cols = @cols - pre.length
+        body = lines.map { |l| "#{pre}#{l}" }.join("\n")
         "#{line1}\n#{body}"
       end
 
@@ -628,6 +652,8 @@ module Redcarpet
 
       def color_meta(text)
         input = text.dup
+        input.clean_empty_lines!
+
         first_line = input.split("\n").first
         if first_line =~ /(?i-m)^---[ \t]*?$/
           @log.info('Found YAML')
@@ -637,7 +663,7 @@ module Redcarpet
             m = Regexp.last_match
             @log.info('Processing YAML Header')
             lines = m[0].split(/\n/)
-            longest = lines.inject { |memo, word| memo.length > word.length ? memo : word }.length
+            longest = lines.longest_element.length
             longest = longest < @cols ? longest + 1 : @cols
             lines.map do |line|
               if line =~ /^[-.]{3}\s*$/
@@ -674,29 +700,8 @@ module Redcarpet
       end
 
       def preprocess(input)
-        in_yaml = false
-
-        if @options[:taskpaper] == :auto
-          @options[:taskpaper] = if @file =~ /\.taskpaper/
-                                   @log.info('TaskPaper extension detected')
-                                   true
-                                 elsif CLIMarkdown::TaskPaper.is_taskpaper?(input)
-                                   @log.info('TaskPaper document detected')
-                                   true
-                                 else
-                                   false
-                                 end
-        end
-
         input = color_meta(input)
 
-        if @options[:taskpaper]
-          input = CLIMarkdown::TaskPaper.highlight(input, @theme)
-          input = highlight_tags(input)
-          return input
-        end
-
-
         ## Replace setex headers with ATX
         input.gsub!(/^([^\n]+)\n={2,}\s*$/m, "# \\1\n")
         input.gsub!(/^([^\n]+?)\n-{2,}\s*$/m, "## \\1\n")

data/lib/mdless/converter.rb

@@ -12,6 +12,12 @@ module CLIMarkdown
       "#{CLIMarkdown::EXECUTABLE_NAME} #{CLIMarkdown::VERSION}"
     end
 
+    def default(option, default)
+      if @options[option].nil?
+        @options[option] = default
+      end
+    end
+
     def initialize(args)
       @log = Logger.new($stderr)
       @log.level = Logger::WARN
@@ -23,7 +29,7 @@ module CLIMarkdown
       optparse = OptionParser.new do |opts|
         opts.banner = "#{version} by Brett Terpstra\n\n> Usage: #{CLIMarkdown::EXECUTABLE_NAME} [options] [path]\n\n"
 
-        @options[:color] ||= true
+        default(:color, true)
         opts.on('-c', '--[no-]color', 'Colorize output (default on)') do |c|
           @options[:color] = c
         end
@@ -42,8 +48,8 @@ module CLIMarkdown
           exit
         end
 
-        @options[:local_images] ||= false
-        @options[:remote_images] ||= false
+        default(:local_images, false)
+        default(:remote_images, false)
         opts.on('-i', '--images=TYPE',
                 'Include [local|remote (both)|none] images in output (requires chafa or imgcat, default none).') do |type|
           if exec_available('imgcat') || exec_available('chafa')
@@ -71,33 +77,34 @@ module CLIMarkdown
           end
         end
 
-        @options[:list] ||= false
+
+        default(:list, false)
         opts.on('-l', '--list', 'List headers in document and exit') do
           @options[:list] = true
         end
 
-        @options[:pager] ||= true
+        default(:pager, true)
         opts.on('-p', '--[no-]pager', 'Formatted output to pager (default on)') do |p|
           @options[:pager] = p
         end
 
-        @options[:pager] ||= true
+        default(:pager, true)
         opts.on('-P', 'Disable pager (same as --no-pager)') do
           @options[:pager] = false
         end
 
-        @options[:section] ||= nil
+        default(:section, nil)
         opts.on('-s', '--section=NUMBER[,NUMBER]',
                 'Output only a headline-based section of the input (numeric from --list)') do |section|
           @options[:section] = section.split(/ *, */).map(&:strip).map(&:to_i)
         end
 
-        @options[:theme] ||= 'default'
+        default(:theme, 'default')
         opts.on('-t', '--theme=THEME_NAME', 'Specify an alternate color theme to load') do |theme|
           @options[:theme] = theme
         end
 
-        @options[:at_tags] ||= false
+        default(:at_tags, false)
         opts.on('-@', '--at_tags', 'Highlight @tags and values in the document') do
           @options[:at_tags] = true
         end
@@ -107,28 +114,35 @@ module CLIMarkdown
           exit
         end
 
-        @options[:width] = `tput cols`.strip.to_i
+        default(:width, TTY::Screen.cols)
         opts.on('-w', '--width=COLUMNS', 'Column width to format for (default: terminal width)') do |columns|
           @options[:width] = columns.to_i
         end
+        cols = TTY::Screen.cols
+        @options[:width] = cols if @options[:width] > cols
 
-        @options[:inline_footnotes] ||= false
+        default(:autolink, true)
+        opts.on('--[no-]autolink', 'Convert bare URLs and emails to <links>') do |p|
+          @options[:autolink] = p
+        end
+
+        default(:inline_footnotes, false)
         opts.on('--[no-]inline_footnotes',
                 'Display footnotes immediately after the paragraph that references them') do |p|
           @options[:inline_footnotes] = p
         end
 
-        @options[:intra_emphasis] ||= true
+        default(:intra_emphasis, true)
         opts.on('--[no-]intra-emphasis', 'Parse emphasis inside of words (e.g. Mark_down_)') do |opt|
           @options[:intra_emphasis] = opt
         end
 
-        @options[:lax_spacing] ||= true
+        default(:lax_spacing, true)
         opts.on('--[no-]lax-spacing', 'Allow lax spacing') do |opt|
           @options[:lax_spacing] = opt
         end
 
-        @options[:links] ||= :inline
+        default(:links, :inline)
         opts.on('--links=FORMAT',
                 'Link style ([inline, reference, paragraph], default inline,
                 "paragraph" will position reference links after each paragraph)') do |fmt|
@@ -142,7 +156,7 @@ module CLIMarkdown
                              end
         end
 
-        @options[:syntax_higlight] ||= false
+        default(:syntax_higlight, false)
         opts.on('--[no-]syntax', 'Syntax highlight code blocks') do |p|
           @options[:syntax_higlight] = p
         end
@@ -170,12 +184,12 @@ module CLIMarkdown
                                  end
         end
 
-        @options[:update_config] ||= false
+        default(:update_config, false)
         opts.on('--update_config', 'Update the configuration file with new keys and current command line options') do
           @options[:update_config] = true
         end
 
-        @options[:wiki_links] ||= false
+        default(:wiki_links, false)
         opts.on('--[no-]wiki-links', 'Highlight [[wiki links]]') do |opt|
           @options[:wiki_links] = opt
         end
@@ -202,6 +216,7 @@ module CLIMarkdown
 
       @theme = load_theme(@options[:theme])
       @cols = @options[:width] - 2
+
       @output = ''
       @headers = []
       @setheaders = []
@@ -218,7 +233,7 @@ module CLIMarkdown
 
       markdown = Redcarpet::Markdown.new(renderer,
                                          no_intra_emphasis: !@options[:intra_emphasis],
-                                         autolink: true,
+                                         autolink: @options[:autolink],
                                          fenced_code_blocks: true,
                                          footnotes: true,
                                          hard_wrap: false,
@@ -264,6 +279,7 @@ module CLIMarkdown
             end
 
             if @options[:taskpaper]
+              input = input.color_meta(@theme, @log, @cols)
               input = CLIMarkdown::TaskPaper.highlight(input, @theme)
               @output = input.highlight_tags(@theme, @log)
             else

data/lib/mdless/string.rb

@@ -4,6 +4,14 @@
 class ::String
   include CLIMarkdown::Colors
 
+  def clean_empty_lines
+    gsub(/^[ \t]+$/, '')
+  end
+
+  def clean_empty_lines!
+    replace clean_empty_lines
+  end
+
   def color(key, theme, log)
     val = nil
     keys = key.split(/[ ,>]/)
@@ -30,6 +38,59 @@ class ::String
     end
   end
 
+  def color_meta(theme, log, cols)
+    @theme = theme
+    @log = log
+    @cols = cols
+    input = dup
+    input.clean_empty_lines!
+
+    in_yaml = false
+    first_line = input.split("\n").first
+    if first_line =~ /(?i-m)^---[ \t]*?$/
+      @log.info('Found YAML')
+      # YAML
+      in_yaml = true
+      input.sub!(/(?i-m)^---[ \t]*\n([\s\S]*?)\n[-.]{3}[ \t]*\n/m) do
+        m = Regexp.last_match
+        @log.info('Processing YAML Header')
+        lines = m[0].split(/\n/)
+        longest = lines.inject { |memo, word| memo.length > word.length ? memo : word }.length
+        longest = longest < @cols ? longest + 1 : @cols
+        lines.map do |line|
+          if line =~ /^[-.]{3}\s*$/
+            line = "#{color('metadata marker', @theme, @log)}#{'%' * longest}"
+          else
+            line.sub!(/^(.*?:)[ \t]+(\S)/, '\1 \2')
+            line = "#{color('metadata color', @theme, @log)}#{line}"
+          end
+
+          line += "\u00A0" * (longest - line.uncolor.strip.length) + xc
+          line
+        end.join("\n") + "#{xc}\n"
+      end
+    end
+
+    if !in_yaml && first_line =~ /(?i-m)^[\w ]+:\s+\S+/
+      @log.info('Found MMD Headers')
+      input.sub!(/(?i-m)^([\S ]+:[\s\S]*?)+(?=\n\n)/) do |mmd|
+        lines = mmd.split(/\n/)
+        return mmd if lines.count > 20
+
+        longest = lines.inject { |memo, word| memo.length > word.length ? memo : word }.length
+        longest = longest < @cols ? longest + 1 : @cols
+        lines.map do |line|
+          line.sub!(/^(.*?:)[ \t]+(\S)/, '\1 \2')
+          line = "#{color('metadata color', @theme, @log)}#{line}"
+          line += "\u00A0" * (longest - line.uncolor.strip.length)
+          line + xc
+        end.join("\n") + "#{"\u00A0" * longest}#{xc}\n"
+      end
+    end
+
+    input
+  end
+
   def highlight_tags(theme, log)
     tag_color = color('at_tags tag', theme, log)
     value_color = color('at_tags value', theme, log)
@@ -58,4 +119,23 @@ class ::String
   def scrub!
     replace scrub
   end
+
+  def valid_pygments_theme?
+    return false unless TTY::Which.exist?('pygmentize')
+    pyg = TTY::Which.which('pygmentize')
+    res = `#{pyg} -L styles`
+    styles = res.scan(/\* ([\w-]+):/).map { |l| l[0] }
+    styles.include?(self)
+  end
+
+  def valid_lexer?
+    return false unless TTY::Which.exist?('pygmentize')
+    pyg = TTY::Which.which('pygmentize')
+    res = `#{pyg} -L lexers`
+    lexers = res.scan(/\* ([\w-]+(?:, [\w-]+)*):/).map { |l| l[0] }
+    lexers_a = []
+    lexers.each { |l| lexers_a.concat(l.split(/, /)) }
+
+    lexers_a.include?(self.downcase)
+  end
 end

data/lib/mdless/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CLIMarkdown
-  VERSION = '2.0.17'
+  VERSION = '2.0.18'
 end

data/lib/mdless.rb

@@ -4,11 +4,13 @@ require 'open3'
 require 'fileutils'
 require 'logger'
 require 'tty-which'
+require 'tty-screen'
 require 'mdless/version.rb'
 require 'mdless/colors'
 require 'mdless/tables'
 require 'mdless/hash'
 require 'mdless/string'
+require 'mdless/array'
 require 'mdless/taskpaper'
 require 'mdless/theme'
 require 'redcarpet'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 2.0.17
+  version: 2.0.18
 platform: ruby
 authors:
 - Brett Terpstra
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +92,7 @@ files:
 - README.md
 - bin/mdless
 - lib/mdless.rb
+- lib/mdless/array.rb
 - lib/mdless/colors.rb
 - lib/mdless/console.rb
 - lib/mdless/converter.rb