mdless 2.0.12 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c79d8ac3d3e9579dd89e46ba18e9e0e91eba3c4c47d3af390c897ebe1067ac6d
-  data.tar.gz: 27c2b032b65a05d9c8109e41b4a50e8906335d008335752d69c395eb79832bb1
+  metadata.gz: 863102e504ba07c2ab9b018687d50053ca3395206666d1abffcf79997023db9e
+  data.tar.gz: bbba927ea37503308dac7356cb2d72e84e4cf53c5cf28f3f2b210c68b745cbf1
 SHA512:
-  metadata.gz: a3289ed0b1bf504f5bb3c044e123184ba0f96fdd14498d1f94d3a1b51dd13dd20a0a97dee523ed63fa0abe3c34cb7aeebc50b0fbddc57d69bdbba01c57bc73f6
-  data.tar.gz: b11921b4b2bc1af7ecf58c075f6af118bd2378ad7d7a7385923b2ace54077d1224ecf64cc99cdbba2b1017c1e54d67eb33a006bf3068a9dca155c5efd14e947c
+  metadata.gz: 92d0edc1d4722074e897981138c585a02fb9c287c8e8fc270885cc19b6274a2490bcd69b92c198c9876d4c4c1bf9b0ec0226c0e97660791fbfdf6c8e85f5592b
+  data.tar.gz: d738066449abc9ee9a8d0331b6ef64db675686cc53c9d0bbf3fa320a63a70c9f33312e0a6fe6c7055caffca7ba13deefcce10ee57f7e3fd7e291a8447e9674fd

data/README.md

@@ -58,15 +58,16 @@ The pager used is determined by system configuration in this order of preference
     -c, --[no-]color                 Colorize output (default on)
     -d, --debug LEVEL                Level of debug messages to output (1-4, 4 to see all messages)
     -h, --help                       Display this screen
-    -i, --images=TYPE                Include [local|remote (both)] images in output (requires chafa or imgcat, default NONE).
+    -i, --images=TYPE                Include [local|remote (both)|none] images in output (requires chafa or imgcat, default none).
     -I, --all-images                 Include local and remote images in output (requires imgcat or chafa)
         --syntax                     Syntax highlight code blocks
-        --links=FORMAT               Link style ([inline, reference], default inline) [NOT CURRENTLY IMPLEMENTED]
+        --links=FORMAT               Link style ([inline, reference, paragraph], default inline, "paragraph" will position reference links after each paragraph)
     -l, --list                       List headers in document and exit
     -p, --[no-]pager                 Formatted output to pager (default on)
     -P                               Disable pager (same as --no-pager)
     -s, --section=NUMBER[,NUMBER]    Output only a headline-based section of the input (numeric from --list)
     -t, --theme=THEME_NAME           Specify an alternate color theme to load
+    -@, --at_tags                    Highlight @tags and values in the document
     -v, --version                    Display version number
     -w, --width=COLUMNS              Column width to format for (default: terminal width)
         --[no-]inline_footnotes      Display footnotes immediately after the paragraph that references them

data/lib/mdless/colors.rb

@@ -114,62 +114,6 @@ module CLIMarkdown
       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

@@ -3,6 +3,7 @@ module Redcarpet
     class Console < Base
       include CLIMarkdown::Colors
       include CLIMarkdown::Theme
+
       attr_writer :theme, :cols, :log, :options, :file
 
       @@listitemid = 0
@@ -550,8 +551,8 @@ module Redcarpet
         @@headers
       end
 
-      def preprocess(input)
-        in_yaml = false
+      def color_meta(text)
+        input = text.dup
         first_line = input.split("\n").first
         if first_line =~ /(?i-m)^---[ \t]*?$/
           @log.info('Found YAML')
@@ -592,12 +593,38 @@ module Redcarpet
               line + xc
             end.join("\n") + "#{"\u00A0" * longest}#{xc}\n"
           end
+        end
 
+        input
+      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={3,}\s*$/m, "# \\1\n")
-        input.gsub!(/^([^\n]+?)\n-{3,}\s*$/m, "## \\1\n")
+        input.gsub!(/^([^\n]+)\n={2,}\s*$/m, "# \\1\n")
+        input.gsub!(/^([^\n]+?)\n-{2,}\s*$/m, "## \\1\n")
 
         @@headers = get_headers(input)
 
@@ -808,9 +835,49 @@ module Redcarpet
         end
       end
 
+      def highlight_tags(input)
+        tag_color = color('at_tags tag')
+        value_color = color('at_tags value')
+        input.gsub(/(?<pre>\s|m)(?<tag>@[^ \].?!,("']+)(?:(?<lparen>\()(?<value>.*?)(?<rparen>\)))?/) do
+          m = Regexp.last_match
+          last_color = m.pre_match.last_color_code
+          [
+            m['pre'],
+            tag_color,
+            m['tag'],
+            m['lparen'],
+            value_color,
+            m['value'],
+            tag_color,
+            m['rparen'],
+            xc,
+            last_color
+          ].join
+        end
+      end
+
+      def highlight_wiki_links(input)
+        input.gsub(/\[\[(.*?)\]\]/) do
+          content = Regexp.last_match(1)
+          [
+            pre_element,
+            color('link brackets'),
+            '[[',
+            color('link text'),
+            content,
+            color('link brackets'),
+            ']]',
+            xc,
+            post_element
+          ].join
+        end
+      end
+
       def postprocess(input)
         input.scrub!
 
+        input = highlight_wiki_links(input) if @options[:wiki_links]
+
         if @options[:inline_footnotes]
           input = insert_footnotes(input)
         else
@@ -832,6 +899,7 @@ module Redcarpet
         # lists
         input = fix_lists(input, 0)
         input = render_images(input) if @options[:local_images]
+        input = highlight_tags(input) if @options[:at_tags] || @options[:taskpaper]
         fix_colors(input)
       end
     end

data/lib/mdless/converter.rb

@@ -45,7 +45,7 @@ module CLIMarkdown
         @options[:local_images] ||= false
         @options[:remote_images] ||= false
         opts.on('-i', '--images=TYPE',
-                'Include [local|remote (both)] images in output (requires chafa or imgcat, default NONE).') do |type|
+                'Include [local|remote (both)|none] images in output (requires chafa or imgcat, default none).') do |type|
           if exec_available('imgcat') || exec_available('chafa')
             case type
             when /^(r|b|a)/i
@@ -75,6 +75,23 @@ module CLIMarkdown
           @options[:syntax_higlight] = p
         end
 
+        @options[: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[:taskpaper] ||= false
+        opts.on('--taskpaper=OPTION', 'Highlight TaskPaper format (true|false|auto)') do |tp|
+          @options[:taskpaper] = case tp
+                                 when /^[ty1]/
+                                   true
+                                 when /^a/
+                                   :auto
+                                 else
+                                   false
+                                 end
+        end
+
         @options[:links] ||= :inline
         opts.on('--links=FORMAT',
                 'Link style ([inline, reference, paragraph], default inline, "paragraph" will position reference links after each paragraph)') do |fmt|
@@ -88,6 +105,16 @@ module CLIMarkdown
                              end
         end
 
+        @options[:lax_spacing] ||= true
+        opts.on('--[no-]lax-spacing', 'Allow lax spacing') do |opt|
+          @options[:lax_spacing] = opt
+        end
+
+        @options[: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[:list] ||= false
         opts.on('-l', '--list', 'List headers in document and exit') do
           @options[:list] = true
@@ -98,6 +125,7 @@ module CLIMarkdown
           @options[:pager] = p
         end
 
+        @options[:pager] ||= true
         opts.on('-P', 'Disable pager (same as --no-pager)') do
           @options[:pager] = false
         end
@@ -113,6 +141,16 @@ module CLIMarkdown
           @options[:theme] = theme
         end
 
+        @options[:at_tags] ||= false
+        opts.on('-@', '--at_tags', 'Highlight @tags and values in the document') do
+          @options[:at_tags] = true
+        end
+
+        @options[:wiki_links] ||= false
+        opts.on('--[no-]wiki-links', 'Highlight [[wiki links]]') do |opt|
+          @options[:wiki_links] = opt
+        end
+
         opts.on('-v', '--version', 'Display version number') do
           puts version
           exit
@@ -137,12 +175,13 @@ module CLIMarkdown
         exit 1
       end
 
-      unless File.exist?(config)
+      if !File.exist?(config) || @options[:update_config]
         FileUtils.mkdir_p(File.dirname(config))
         File.open(config, 'w') do |f|
           opts = @options.dup
           opts.delete(:list)
           opts.delete(:section)
+          opts.delete(:update_config)
           f.puts YAML.dump(opts)
           warn "Config file saved to #{config}"
         end
@@ -165,12 +204,13 @@ module CLIMarkdown
       renderer.options = @options
 
       markdown = Redcarpet::Markdown.new(renderer,
+                                         no_intra_emphasis: !@options[:intra_emphasis],
                                          autolink: true,
                                          fenced_code_blocks: true,
                                          footnotes: true,
                                          hard_wrap: false,
                                          highlight: true,
-                                         lax_spacing: true,
+                                         lax_spacing: @options[:lax_spacing],
                                          quote: false,
                                          space_after_headers: false,
                                          strikethrough: true,
@@ -189,6 +229,9 @@ module CLIMarkdown
           rescue StandardError
             input = IO.read(file)
           end
+          raise 'Nil input' if input.nil?
+
+          input.scrub!
           input.gsub!(/\r?\n/, "\n")
           if @options[:list]
             puts list_headers(input)
@@ -200,11 +243,7 @@ module CLIMarkdown
         printout
       elsif !$stdin.isatty
         @file = nil
-        begin
-          input = $stdin.read.force_encoding('utf-8')
-        rescue StandardError
-          input = $stdin.read
-        end
+        input = $stdin.read.scrub
         input.gsub!(/\r?\n/, "\n")
         if @options[:list]
           puts list_headers(input)

data/lib/mdless/taskpaper.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module CLIMarkdown
+  module TaskPaper
+    TASK_RX = /^(?<indent>(?:    |\t)*?)(?<marker>-)(?<task>\s+\S.*?)$/
+    PROJECT_RX = /^(?<indent>(?:    |\t)*?)(?<project>[^- \t].*?:)(?<tags> @\S+)*$/
+    NOTE_RX = /^(?<indent>(?:    |\t)+)(?<note>(?<!- ).*?(?!:))$/
+
+    class << self
+      include CLIMarkdown::Colors
+      attr_writer :theme
+
+      def color(key)
+        val = nil
+        keys = key.split(/[ ,>]/)
+        if @theme.key?(keys[0])
+          val = @theme[keys.shift]
+        else
+          @log.error("Invalid theme key: #{key}") unless keys[0] =~ /^text/
+          return c([:reset])
+        end
+        keys.each do |k|
+          if val.key?(k)
+            val = val[k]
+          else
+            @log.error("Invalid theme key: #{k}")
+            return c([:reset])
+          end
+        end
+        if val.is_a? String
+          val = "x #{val}"
+          res = val.split(/ /).map(&:to_sym)
+          c(res)
+        else
+          c([:reset])
+        end
+      end
+
+      def is_taskpaper?(input)
+        projects = input.split(PROJECT_RX)
+        tasks = 0
+        if projects.count > 1
+          projects.each do |proj|
+            tasks += proj.scan(TASK_RX).count
+          end
+        end
+
+        tasks >= 6
+      end
+
+      def highlight(input, theme)
+        @theme = theme
+        mc = color('taskpaper marker')
+        tc = color('taskpaper task')
+        pc = color('taskpaper project')
+        nc = color('taskpaper note')
+
+        input.gsub!(PROJECT_RX) do
+          m = Regexp.last_match
+          "#{m['indent']}#{pc}#{m['project']}#{m['tags']}"
+        end
+
+        input.gsub!(TASK_RX) do
+          m = Regexp.last_match
+          "#{m['indent']}#{mc}- #{tc}#{m['task']}"
+        end
+
+        input.gsub!(NOTE_RX) do
+          m = Regexp.last_match
+          "#{m['indent']}#{nc}#{m['note']}"
+        end
+
+        input
+      end
+    end
+  end
+end

data/lib/mdless/theme.rb

@@ -103,7 +103,17 @@ module CLIMarkdown
         'equation' => 'b blue'
       },
       'super' => 'b green',
-      'text' => 'white'
+      'text' => 'white',
+      'at_tags' => {
+        'tag' => 'magenta',
+        'value' => 'b white'
+      },
+      'taskpaper' => {
+        'marker' => 'b white',
+        'project' => 'b green',
+        'task' => 'white',
+        'note' => 'd white'
+      }
     }
 
     def load_theme_file(theme_file)

data/lib/mdless/version.rb

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

data/lib/mdless.rb

@@ -9,6 +9,7 @@ require 'mdless/colors'
 require 'mdless/tables'
 require 'mdless/hash'
 require 'mdless/string'
+require 'mdless/taskpaper'
 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.12
+  version: 2.0.15
 platform: ruby
 authors:
 - Brett Terpstra
@@ -84,6 +84,7 @@ files:
 - lib/mdless/hash.rb
 - lib/mdless/string.rb
 - lib/mdless/tables.rb
+- lib/mdless/taskpaper.rb
 - lib/mdless/theme.rb
 - lib/mdless/version.rb
 homepage: http://brettterpstra.com/project/mdless/
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: A pager like less, but for Markdown files