snibbets 2.0.28 → 2.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f9f01ad7e1ae9656d572bbd502f4b0dc1fa7d344509a6a93f07b765d515ddca
-  data.tar.gz: 0bc11012e818d56256550af0b3df3fe952307d2f86b8e7da9d91a8a80dfbafee
+  metadata.gz: a633139ac4f908c760dc709e91937cfeb6d77c8a3a2aebdfc0e9acec1760a25b
+  data.tar.gz: efc77b72771c37c1cda78a6fb66d4af532b9b2c31648e6b7fce4854a2310204e
 SHA512:
-  metadata.gz: a8926027efe84785a45414761eab33b66474a819ed394e52e1f638c95e5ae7a3aad857df95728640f3ccf68ad0d471b93039b694bfa0d72886b682afad13c3c5
-  data.tar.gz: bfc6c99b3178fb1f7cb8dc3b7aad350cca53e6f560ab19357924291346e6bc74583c9755a945363122105840ef66abee960a8aa9ca75547f23b239be088761b1
+  metadata.gz: af5ac5a46200ee38bc3fc20daed4bfdc2ca47841cc665883ac7837629436fe42e77a0b953f1d5c3615d0622f2a08e2672771876eb89a86e93afb66d8e89d265d
+  data.tar.gz: 89292879a4cd79acb7b30a24a7ed760557b6b26493a3311abbc42eeef097348d36b0b7c2b69475e5aa0d0729d493885647673675cf46b435fabfa7a4d0661fcb

data/CHANGELOG.md

@@ -1,75 +1,43 @@
-### 2.0.28
+### 2.0.30
 
-2023-04-18 09:18
+2023-04-19 06:44
 
 #### NEW
 
-- `--nvultra` will open the selected snippet in nvUltra
+- Added `--notes` option and accompanying `all_notes` config option to allow display of all notes instead of just code blocks in each snippet
 
 #### IMPROVED
 
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
+- Previously if multiple snippets were output, titles of snippets would go to STDERR so they weren't copied. Now they go to STDOUT as well.
 
-#### FIXED
+### 2.0.29
 
-- Code indentation with `--paste`
-- Nil error when highlighting without extension
-- When detecting indented code blocks, require a blank line (or start of file) before them, to avoid picking up lines within indented lists
+2023-04-18 10:45
 
-### 2.0.27
+#### IMPROVED
 
-2023-04-17 15:54
+- Better removal of extra leading/trailing newlines
 
-#### NEW
+#### FIXED
 
-- `--nvultra` will open the selected snippet in nvUltra
+- Selecting 'All snippets' could return blank results in some cases
 
-#### IMPROVED
+### 2.0.28
 
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
+2023-04-18 09:18
 
 #### FIXED
 
-- Code indentation with `--paste`
-- Nil error when highlighting without extension
+- When detecting indented code blocks, require a blank line (or start of file) before them, to avoid picking up lines within indented lists
 
 ### 2.0.26
 
 2023-04-16 11:18
 
-#### NEW
-
-- `--nvultra` will open the selected snippet in nvUltra
-
-#### IMPROVED
-
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
-
 #### FIXED
 
-- Code indentation with `--paste`
 - Nil error when highlighting without extension
 
-### 2.0.25
-
-2023-04-16 11:09
-
-#### NEW
-
-- `--nvultra` will open the selected snippet in nvUltra
-
-#### IMPROVED
-
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
-
-#### FIXED
-
-- Code indentation with `--paste`
-
 ### 2.0.24
 
 2023-04-16 10:49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snibbets (2.0.28)
+    snibbets (2.0.30)
       mdless (~> 1.0, >= 1.0.32)
       tty-reader (~> 0.9, >= 0.9.0)
       tty-which (~> 0.5, >= 0.5.0)

data/README.md

@@ -102,6 +102,8 @@ Set the `source` key to the folder where you keep your Markdown snippets. Option
 
 The `all` setting determines how Snibbets handles files containing multiple snippets. If `all` is true, then it will always display every snippet in the selected file. If false, it will offer a menu and let you choose which snippet to display. You can use `--all` on the command line to just enable this once.
 
+By default, Snibbets displays only the code from each snippet (and optionally block quotes, see below). If you set `all_notes` to true, then the full content of each snippet containing a code block will be returned, allowing you to see additional notes on the command line. This can be toggled at runtime with `--notes` or `--no-notes`.
+
 The `copy` setting determines whether the output is copied to the clipboard in addition to being displayed on STDOUT. This is the equivalent of running `snibbets QUERY | pbcopy` (macOS) or `snibbets QUERY | xclip` (Linux). This can be enabled for just one run with `--copy` on the command line. Setting it to true in the config will copy to the clipboard every time a snippet is displayed. On Mac this will work automatically, on Windows/Linux you may need to [install `xclip` or `xsel`][xclip].
 
 [xclip]: https://ostechnix.com/access-clipboard-contents-using-xclip-and-xsel-in-linux/
@@ -157,13 +159,14 @@ Snibbet's implementation of Skylighting has limited but better-looking themes, a
 ### Usage
 
 ```
-Snibbets v2.0.28
+Snibbets v2.0.30
 
 Usage: snibbets [options] query
     -a, --all                        If a file contains multiple snippets, output all of them (no menu)
     -c, --[no-]copy                  Copy the output to the clibpoard (also displays on STDOUT)
     -e, --edit                       Open the selected snippet in your configured editor
     -n, --[no-]name-only             Only search file names, not content
+        --[no-]notes                 Display the full content of the snippet
     -o, --output FORMAT              Output format (json|launchbar|*raw)
     -p, --paste, --new               Interactively create a new snippet from clipboard contents (Mac only)
     -q, --quiet                      Skip menus and display first match

data/bin/snibbets

@@ -46,6 +46,10 @@ module Snibbets
           options[:name_only] = v
         end
 
+        opts.on('--[no-]notes', 'Display the full content of the snippet') do |v|
+          options[:all_notes] = v
+        end
+
         opts.on('-o', '--output FORMAT', 'Output format (json|launchbar|*raw)') do |outformat|
           valid = %w[json launchbar lb raw]
           if outformat.downcase =~ /(launchbar|lb)/

data/lib/snibbets/array.rb

@@ -17,7 +17,7 @@ module Snibbets
 
       in_leader = true
       each do |line|
-        if (line =~ /^\s*$/ || line.empty?) && in_leader
+        if (line.strip.empty?) && in_leader
           next
         else
           in_leader = false

data/lib/snibbets/config.rb

@@ -14,6 +14,7 @@ module Snibbets
 
     DEFAULT_OPTIONS = {
       all: false,
+      all_notes: false,
       copy: false,
       editor: nil,
       extension: 'md',

data/lib/snibbets/menu.rb

@@ -14,9 +14,7 @@ module Snibbets
       def remove_items_without_query(filename, res, query)
         q = find_query_in_options(filename, res, query).split(/ /)
         res.delete_if do |opt|
-          q.none? do |word|
-            "#{filename} #{opt['title']}" =~ /#{word}/i
-          end
+          q.none? { |word| "#{filename} #{opt['title']}" =~ /#{word}/i }
         end
         res
       end
@@ -28,16 +26,14 @@ module Snibbets
         end
 
         if res.count.zero?
-          warn 'No matches found'
+          warn 'No matches found' if Snibbets.options[:interactive]
           Process.exit 1
         end
 
         options = res.map { |m| m['title'] }
 
         puts title
-        args = [
-          "--height=#{options.count}"
-        ]
+        args = ["--height=#{options.count}"]
         selection = `echo #{Shellwords.escape(options.join("\n"))} | #{executable} filter #{args.join(' ')}`.strip
         Process.exit 1 if selection.empty?
 
@@ -82,7 +78,7 @@ module Snibbets
         end
 
         if res.count.zero?
-          warn 'No matches found'
+          warn 'No matches found' if Snibbets.options[:interactive]
           Process.exit 1
         end
 

data/lib/snibbets/os.rb

@@ -31,12 +31,12 @@ module Snibbets
         os = RbConfig::CONFIG['target_os']
         case os
         when /darwin.*/i
-          `pbpaste -pboard general -Prefer txt`
+          `pbpaste -pboard general -Prefer txt`.strip_newlines
         else
           if TTY::Which.exist?('xclip')
-            `xclip -o -sel c`
+            `xclip -o -sel c`.strip_newlines
           elsif TTY::Which.exist('xsel')
-            `xsel -ob`
+            `xsel -ob`.strip_newlines
           else
             puts 'Paste not supported on this system, please install xclip or xsel.'
           end

data/lib/snibbets/string.rb

@@ -16,6 +16,10 @@ module Snibbets
       replace remove_spotlight_tags
     end
 
+    def strip_empty
+      split(/\n/).strip_empty.join("\n")
+    end
+
     def remove_meta
       input = dup
       lines = input.split(/\n/)
@@ -57,7 +61,7 @@ module Snibbets
 
       # if it's a fenced code block, just discard the fence and everything
       # outside it
-      if block.fenced?
+      if block.fenced? && !Snibbets.options[:all_notes]
         code_blocks = block.scan(/(`{3,})(\w+)?\s*\n(.*?)\n\1/m)
         code_blocks.map! { |b| b[2].strip }
         return code_blocks.join("\n\n")
@@ -86,29 +90,16 @@ module Snibbets
 
       indent = code[0].match(/^( {4,}|\t+)(?=\S)/)
 
-      if indent
-        code.map! { |line| line.sub(/(?mi)^#{indent[1]}/, '') }.join("\n")
-      else
-        self
-      end
-    end
+      return self if indent.nil?
 
-    # Returns an array of snippets. Single snippets are returned without a
-    # title, multiple snippets get titles from header lines
-    def snippets
-      content = dup.remove_meta
-      # If there's only one snippet, just clean it and return
-      # return [{ 'title' => '', 'code' => content.clean_code.strip }] unless multiple?
+      code.map! { |line| line.sub(/(?mi)^#{indent[1]}/, '') }.join("\n")
+    end
 
-      # Split content by ATX headers. Everything on the line after the #
-      # becomes the title, code is gleaned from text between that and the
-      # next ATX header (or end)
-      sections = []
+    def replace_blocks
+      sans_blocks = dup
       counter = 0
       code_blocks = {}
 
-      sans_blocks = content.dup
-
       if Snibbets.options[:include_blockquotes]
         sans_blocks = sans_blocks.gsub(/(?mi)(^(>.*?)(\n|$))+/) do
           counter += 1
@@ -133,44 +124,76 @@ module Snibbets
         "<block#{counter}>\n"
       end
 
-      content = []
-      if sans_blocks =~ /<block\d+>/
-        sans_blocks.each_line do |line|
-          content << line if line =~ /^#/ || line =~ /<block\d+>/
-        end
+      [sans_blocks, code_blocks]
+    end
 
-        parts = content.join("\n").split(/^#+/)
-      else
-        parts = sans_blocks.gsub(/\n{2,}/, "\n\n").split(/^#+/)
+    def parse_lang_marker(block)
+      lang = nil
+      if block =~ /<lang:(.*?)>/
+        lang = Regexp.last_match(1)
+        block = block.gsub(/<lang:.*?>\n+/, '').strip_empty
       end
 
-      # parts.shift if parts.count > 1
+      [lang, block]
+    end
+
+    def restore_blocks(parts, code_blocks)
+      sections = []
 
       parts.each do |part|
         lines = part.split(/\n/).strip_empty
-        next if lines.blocks == 0
+        next if lines.blocks.zero?
 
         title = lines.count > 1 && lines[0] !~ /<block\d+>/ ? lines.shift.strip.sub(/[.:]$/, '') : 'Default snippet'
-        block = lines.join("\n").gsub(/<(block\d+)>/) { code_blocks[Regexp.last_match(1)] }
 
-        lang = nil
-        if block =~ /<lang:(.*?)>/
-          lang = Regexp.last_match(1)
-          block.gsub!(/<lang:.*?>\n/, '')
-        end
+        block = if Snibbets.options[:all_notes]
+                  lines.join("\n").gsub(/<(block\d+)>/) { "\n```\n#{code_blocks[Regexp.last_match(1)].strip_empty}\n```" }
+                else
+                  lines.join("\n").gsub(/<(block\d+)>/) { code_blocks[Regexp.last_match(1)].strip_empty }
+                end
+
+        # block = lines.join("\n").gsub(/<(block\d+)>/) { code_blocks[Regexp.last_match(1)] }
 
+        lang, block = parse_lang_marker(block)
         code = block.clean_code
 
         next unless code && !code.empty?
 
         sections << {
           'title' => title,
-          'code' => code,
+          'code' => code.strip_empty,
           'language' => lang
         }
       end
 
       sections
     end
+
+    # Returns an array of snippets. Single snippets are returned without a
+    # title, multiple snippets get titles from header lines
+    def snippets
+      content = dup.remove_meta
+      # If there's only one snippet, just clean it and return
+      # return [{ 'title' => '', 'code' => content.clean_code.strip }] unless multiple?
+
+      # Split content by ATX headers. Everything on the line after the #
+      # becomes the title, code is gleaned from text between that and the
+      # next ATX header (or end)
+      sans_blocks, code_blocks = content.replace_blocks
+
+      parts = if Snibbets.options[:all_notes]
+                sans_blocks.split(/^#+/)
+              elsif sans_blocks =~ /<block\d+>/
+                sans_blocks.split(/\n/).each_with_object([]) do |line, arr|
+                  arr << line if line =~ /^#/ || line =~ /<block\d+>/
+                end.join("\n").split(/^#+/)
+              else
+                sans_blocks.gsub(/\n{2,}/, "\n\n").split(/^#+/)
+              end
+
+      # parts.shift if parts.count > 1
+
+      restore_blocks(parts, code_blocks)
+    end
   end
 end

data/lib/snibbets/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snibbets
-  VERSION = '2.0.28'
+  VERSION = '2.0.30'
 end

data/lib/snibbets.rb

@@ -153,7 +153,7 @@ module Snibbets
     end
 
     def new_snippet_from_clipboard
-      return false unless $stdin.isatty
+      return false unless $stdout.isatty
 
       trap('SIGINT') do
         Howzit.console.info "\nCancelled"
@@ -248,7 +248,7 @@ module Snibbets
       else
         filepath = nil
         if results.empty?
-          warn 'No results'
+          warn 'No results' if Snibbets.options[:interactive]
           Process.exit 0
         elsif results.length == 1 || !Snibbets.options[:interactive]
           filepath = results[0]['path']
@@ -272,7 +272,7 @@ module Snibbets
         snippets = input.snippets
 
         if snippets.empty?
-          warn 'No snippets found'
+          warn 'No snippets found' if Snibbets.options[:interactive]
           Process.exit 0
         elsif snippets.length == 1 || !Snibbets.options[:interactive]
           if Snibbets.options[:output] == 'json'
@@ -280,8 +280,11 @@ module Snibbets
           else
             snippets.each do |snip|
               header = File.basename(filepath, '.md')
-              warn header
-              warn '-' * header.length
+              if $stdout.isatty
+                puts header
+                puts '-' * header.length
+                puts ''
+              end
               code = snip['code']
               lang = snip['language']
               print(code, filepath, lang)
@@ -289,52 +292,59 @@ module Snibbets
           end
         elsif snippets.length > 1
           if Snibbets.options[:all]
-            if Snibbets.options[:output] == 'json'
-              print(snippets.to_json, filepath)
-            else
-
-              snippets.each do |snippet|
-                lang = snippet['language']
-                warn "### #{snippet['title']} ###"
-                # warn "# #{'-' * snippet['title'].length}"
-                print(snippet['code'], filepath, lang)
-                puts
-              end
-            end
+            print_all(snippets, filepath)
           else
-            snippets.push({ 'title' => 'All snippets', 'code' => '' })
-
-            answer = Menu.menu(snippets, filename: File.basename(filepath, '.md'), title: 'Select snippet', query: @query)
+            select_snippet(snippets, filepath)
+          end
+        end
+      end
+    end
 
-            if answer['title'] == 'All snippets'
-              snippets.delete_if { |s| s['title'] == 'All snippets' }
-              if Snibbets.options[:output] == 'json'
-                print(snippets.to_json, filepath)
-              else
-                header = File.basename(filepath, '.md')
-                warn header
-                warn '=' * header.length
-
-                snippets.each do |snippet|
-                  lang = snippet['language']
-                  warn "### #{snippet['title']} ###"
-                  # warn "# #{'-' * snippet['title'].length}"
-                  print(snippet['code'], filepath, lang)
-                  puts
-                end
+    def select_snippet(snippets, filepath)
+      snippets.push({ 'title' => 'All snippets', 'code' => '' })
+      answer = Menu.menu(snippets.dup, filename: File.basename(filepath, '.md'), title: 'Select snippet', query: @query)
 
-              end
-            elsif Snibbets.options[:output] == 'json'
-              print(answer.to_json, filepath)
-            else
-              header = "#{File.basename(filepath, '.md')}: #{answer['title']}"
-              warn header
-              warn '-' * header.length
-              code = answer['code']
-              lang = answer['language']
-              print(code, filepath, lang)
-            end
+      if answer['title'] == 'All snippets'
+        snippets.delete_if { |s| s['title'] == 'All snippets' }
+        if Snibbets.options[:output] == 'json'
+          print(snippets.to_json, filepath)
+        else
+          if $stdout.isatty
+            header = File.basename(filepath, '.md')
+            warn header
+            warn '=' * header.length
+            warn ''
           end
+          print_all(snippets, filepath)
+        end
+      elsif Snibbets.options[:output] == 'json'
+        print(answer.to_json, filepath)
+      else
+        if $stdout.isatty
+          header = "#{File.basename(filepath, '.md')}: #{answer['title']}"
+          warn header
+          warn '-' * header.length
+          warn ''
+        end
+        code = answer['code']
+        lang = answer['language']
+        print(code, filepath, lang)
+      end
+    end
+
+    def print_all(snippets, filepath)
+      if Snibbets.options[:output] == 'json'
+        print(snippets.to_json, filepath)
+      else
+
+        snippets.each do |snippet|
+          lang = snippet['language']
+
+          puts "### #{snippet['title']} ###"
+          puts ''
+
+          print(snippet['code'], filepath, lang)
+          puts
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snibbets
 version: !ruby/object:Gem::Version
-  version: 2.0.28
+  version: 2.0.30
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler