snibbets 2.0.30 → 2.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a633139ac4f908c760dc709e91937cfeb6d77c8a3a2aebdfc0e9acec1760a25b
-  data.tar.gz: efc77b72771c37c1cda78a6fb66d4af532b9b2c31648e6b7fce4854a2310204e
+  metadata.gz: 67e546441d5515f0c3d14e754843bfc3eed76a5129bff75b810c173d3e0161a8
+  data.tar.gz: 1e98fc1fb3326dd21dfb1ccecbf4c4b44b6a0f26df8053fc998fc80dc57428cd
 SHA512:
-  metadata.gz: af5ac5a46200ee38bc3fc20daed4bfdc2ca47841cc665883ac7837629436fe42e77a0b953f1d5c3615d0622f2a08e2672771876eb89a86e93afb66d8e89d265d
-  data.tar.gz: 89292879a4cd79acb7b30a24a7ed760557b6b26493a3311abbc42eeef097348d36b0b7c2b69475e5aa0d0729d493885647673675cf46b435fabfa7a4d0661fcb
+  metadata.gz: 32936396eb50e8b9186f15f12333c7603134fe5861d80c070bb0e96ef4e1d8b248103d46b4cba3cd97d8036e9bd0c82b4dc707911434b9fd7ea97282114e77ca
+  data.tar.gz: 0d22c987dc50165333bfd5d016f3c1d67bd64d842a968c35ec53a5cd2c5e94e95536fee25e54d3c32ba710a6189a84c573d49587baeb34f610f7f3ba6c552b73

data/.devcontainer/Dockerfile

@@ -0,0 +1,11 @@
+ARG VARIANT="3"
+
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:${VARIANT}
+
+USER vscode
+WORKDIR /home/vscode
+
+RUN mkdir -p .config/git \
+ && echo ".vscode/*" >> .config/git/ignore \
+ && echo "*.code-workspace" >> .config/git/ignore \
+ && echo ".history/" >> .config/git/ignore

data/.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+  "name": "Ruby",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "3"
+    }
+  },
+  "extensions": [
+    "rebornix.Ruby",
+    "ms-vsliveshare.vsliveshare",
+    "EditorConfig.EditorConfig",
+    "esbenp.prettier-vscode"
+  ],
+  "postCreateCommand": "bundle install",
+  "remoteUser": "vscode"
+}

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

data/.irbrc

@@ -0,0 +1,2 @@
+require_relative 'lib/snibbets'
+include Snibbets

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--pattern "{spec,lib}/**/*_spec.rb"

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 2.0.31
+
+2023-04-20 10:20
+
+#### IMPROVED
+
+- Syntax highlight blocks individually, so multiple languages can exist within one snippet
+- If outputting notes, wrap code in backticks to differentiate
+
+#### FIXED
+
+- Handle cases where snippet contains `\k<name>` and breaks regex replacement even with Regexp.escape
+- Remove fences from single snippet when not syntax highlighting
+
 ### 2.0.30
 
 2023-04-19 06:44

data/Gemfile.lock

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

data/README.md

@@ -159,7 +159,7 @@ Snibbet's implementation of Skylighting has limited but better-looking themes, a
 ### Usage
 
 ```
-Snibbets v2.0.30
+Snibbets v2.0.31
 
 Usage: snibbets [options] query
     -a, --all                        If a file contains multiple snippets, output all of them (no menu)

data/Snibbets.lbaction/Contents/Info.plist

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleIdentifier</key>
+	<string>com.brettterpstra.LaunchBar.action.Snibbets</string>
+	<key>CFBundleName</key>
+	<string>Snibbets</string>
+	<key>LBAbbreviation</key>
+	<string>snib</string>
+	<key>LBDebugLogEnabled</key>
+	<true/>
+	<key>LBDescription</key>
+	<dict>
+		<key>LBAuthor</key>
+		<string>Brett Terpstra</string>
+		<key>LBEmail</key>
+		<string>me@brettterpstra.com</string>
+		<key>LBSummary</key>
+		<string>Search a folder of plain text code snippets and paste results</string>
+		<key>LBTwitter</key>
+		<string>@ttscoff</string>
+		<key>LBWebsiteURL</key>
+		<string></string>
+	</dict>
+	<key>LBScripts</key>
+	<dict>
+		<key>LBDefaultScript</key>
+		<dict>
+			<key>LBAcceptedArgumentTypes</key>
+			<array>
+				<string>string</string>
+			</array>
+			<key>LBKeepWindowActive</key>
+			<true/>
+			<key>LBResultType</key>
+			<string>unknown</string>
+			<key>LBReturnsResult</key>
+			<true/>
+			<key>LBScriptName</key>
+			<string>default.js</string>
+		</dict>
+	</dict>
+	<key>LBTextInputTitle</key>
+	<string>Search snippets</string>
+	<key>NSHumanReadableCopyright</key>
+	<string>Brett Terpstra 2019</string>
+</dict>
+</plist>

data/Snibbets.lbaction/Contents/Scripts/default.js

@@ -0,0 +1,52 @@
+// LaunchBar Action Script
+
+function run() {
+	settingsItem = {
+		'title' : 'Choose Snippets Folder',
+		'action' : 'setFolder',
+		'label' : 'Choose',
+		'subtitle' : ''
+	}
+	if (Action.preferences.snippetsFolder) {
+		settingsItem.subtitle = Action.preferences.snippetsFolder;
+	}
+	return [settingsItem];
+}
+
+function runWithString(string) {
+	var folder = Action.preferences.snippetsFolder;
+	var result = LaunchBar.execute('/usr/bin/env', 'ruby' , 'snibbets.rb', '-o', 'launchbar', '-s', encodeURI(folder), encodeURI(string));
+	if (result)
+    	return JSON.parse(result);
+    else
+    	return {'title': 'No matches'}
+}
+
+function copyIt(item) {
+	LaunchBar.setClipboardString(item);
+	LaunchBar.openCommandURL('hide'); // for some reason LaunchBar.hide() doesn't execute, but this does. Sometimes.
+	LaunchBar.hide();
+}
+
+function pasteIt(item) {
+	LaunchBar.paste(item.code);
+	LaunchBar.openCommandURL('hide');
+	LaunchBar.hide();
+}
+
+function setFolder(item) {
+  LaunchBar.displayInLargeType({
+      title: 'Choosing folder'
+  });
+  var defaultFolder = LaunchBar.homeDirectory;
+  if (Action.preferences.snippetsFolder) {
+  	defaultFolder = Action.preferences.snippetsFolder;
+  }
+  var k = LaunchBar.executeAppleScript(
+   'set _default to POSIX file "' + defaultFolder + '" as alias \n' +
+   'set _folder to choose folder with prompt "Select Snippets Folder" default location _default \n' +
+   ' return POSIX path of _folder');
+  if (k && k.length > 0) {
+    Action.preferences.snippetsFolder = k.trim();
+  }
+}

data/Snibbets.lbaction/Contents/Scripts/snibbets.rb

@@ -0,0 +1,420 @@
+#!/usr/bin/env ruby
+# Snibbets 2.0.0
+
+require 'optparse'
+require 'readline'
+require 'json'
+require 'cgi'
+require 'shellwords'
+
+$search_path = File.expand_path("~/Desktop/Code/Snippets")
+
+class String
+  # Are there multiple snippets (indicated by ATX headers)
+  def multiple?
+    return self.scan(/^#+/).length > 1
+  end
+
+  # Is the snippet in this block fenced?
+  def fenced?
+    count = self.scan(/^```/).length
+    return count > 1 && count.even?
+  end
+
+  def rx
+    return ".*" + self.gsub(/\s+/,'.*') + ".*"
+  end
+
+  # remove outside comments, fences, and indentation
+  def clean_code
+    block = self
+
+    # if it's a fenced code block, just discard the fence and everything
+    # outside it
+    if block.fenced?
+      return block.gsub(/(?:^|.*?\n)(`{3,})(\w+)?(.*?)\n\1.*/m) {|m| $3.strip }
+    end
+
+    # assume it's indented code, discard non-indented lines and outdent
+    # the rest
+    indent = nil
+    inblock = false
+    code = []
+    block.split(/\n/).each {|line|
+      if line =~ /^\s*$/ && inblock
+        code.push(line)
+      elsif line =~ /^( {4,}|\t+)/
+        inblock = true
+        indent ||= Regexp.new("^#{$1}")
+        code.push(line.sub(indent,''))
+      else
+        inblock = false
+      end
+    }
+    code.join("\n")
+  end
+
+  # Returns an array of snippets. Single snippets are returned without a
+  # title, multiple snippets get titles from header lines
+  def snippets
+    content = self.dup
+    # If there's only one snippet, just clean it and return
+    unless self.multiple?
+      return [{"title" => "", "code" => content.clean_code.strip}]
+    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 = []
+    parts = content.split(/^#+/)
+    parts.shift
+
+    parts.each do |p|
+      lines = p.split(/\n/)
+      title = lines.shift.strip.sub(/[.:]$/, '')
+      block = lines.join("\n")
+      code = block.clean_code
+      next unless code && !code.empty?
+
+      sections << {
+        'title' => title,
+        'code' => code.strip
+      }
+    end
+    return sections
+  end
+end
+
+def gum_menu(executable, res, title)
+  options = res.map { |m| m['title'] }
+  puts title
+  selection = `echo #{Shellwords.escape(options.join("\n"))} | #{executable} choose --limit 1`.strip
+  Process.exit 1 if selection.empty?
+
+  res.select { |m| m['title'] =~ /#{selection}/ }[0]
+end
+
+def fzf_menu(executable, res, title)
+  options = res.map { |m| m['title'] }
+  args = [
+    "--height=#{options.count + 2}",
+    %(--prompt="#{title} > "),
+    '-1'
+  ]
+  selection = `echo #{Shellwords.escape(options.join("\n"))} | #{executable} #{args.join(' ')}`.strip
+  Process.exit 1 if selection.empty?
+
+  res.select { |m| m['title'] =~ /#{selection}/ }[0]
+end
+
+def menu(res, title = 'Select one')
+  fzf = `which fzf`.strip
+  return fzf_menu(fzf, res, title) unless fzf.empty?
+
+  gum = `which gum`.strip
+  return gum_menu(gum, res, title) unless gum.empty?
+
+  console_menu(res, title)
+end
+
+# Generate a numbered menu, items passed must have a title property
+def console_menu(res, title)
+  stty_save = `stty -g`.chomp
+
+  trap('INT') do
+    system('stty', stty_save)
+    Process.exit 1
+  end
+
+  # Generate a numbered menu, items passed must have a title property('INT') { system('stty', stty_save); exit }
+  counter = 1
+  $stderr.puts
+  res.each do |m|
+    $stderr.printf("%<counter>2d) %<title>s\n", counter: counter, title: m['title'])
+    counter += 1
+  end
+  $stderr.puts
+
+  begin
+    $stderr.printf(title.sub(/:?$/, ': '), res.length)
+    while (line = Readline.readline('', true))
+      unless line =~ /^[0-9]/
+        system('stty', stty_save) # Restore
+        exit
+      end
+      line = line.to_i
+      return res[line - 1] if line.positive? && line <= res.length
+
+      warn 'Out of range'
+      menu(res, title)
+    end
+  rescue Interrupt
+    system('stty', stty_save)
+    exit
+  end
+end
+
+# Search the snippets directory for query using find and grep
+def search(query, folder, try = 0)
+  # First try only search by filenames
+  # Second try search with grep
+  # Third try search with Spotlight name only
+  # Fourth try search with Spotlight all contents
+  cmd = case try
+        when 0
+          %(find "#{folder}" -iregex '#{query.rx}')
+        when 1
+          %(grep -iEl '#{query.rx}' "#{folder}/"*.md)
+        when 2
+          %(mdfind -onlyin "#{folder}" -name '#{query}' 2>/dev/null)
+        when 3
+          %(mdfind -onlyin "#{folder}" '#{query}' 2>/dev/null)
+        end
+
+  matches = `#{cmd}`.strip
+
+  results = []
+
+  if !matches.empty?
+    lines = matches.split(/\n/)
+    lines.each do |l|
+      results << {
+        'title' => File.basename(l, '.*'),
+        'path' => l
+      }
+    end
+    results
+  else
+    return [] if try > 2
+
+    # if no results on the first try, try again searching all text
+    search(query, folder, try + 1)
+  end
+end
+
+def highlight_pygments(executable, code, syntax, theme)
+  syntax = syntax.empty? ? '-g' : "-l #{syntax}"
+  `echo #{Shellwords.escape(code)} | #{executable} #{syntax}`
+end
+
+def highlight_skylight(executable, code, syntax, theme)
+  return code if syntax.empty?
+
+  `echo #{Shellwords.escape(code)} | #{executable} --syntax #{syntax}`
+end
+
+def highlight(code, filename, theme = 'monokai')
+  syntax = syntax_from_extension(filename)
+
+  skylight = `which skylighting`.strip
+  return highlight_skylight(skylight, code, syntax, theme) unless skylight.empty?
+
+  pygments = `which pygmentize`.strip
+  return highlight_pygments(pygments, code, syntax, theme) unless pygments.empty?
+
+  code
+end
+
+def ext_to_lang(ext)
+  case ext
+  when /^(as|applescript|scpt)$/
+    'applescript'
+  when /^m$/
+    'objective-c'
+  when /^(pl|perl)$/
+    'perl'
+  when /^py$/
+    'python'
+  when /^(js|jq(uery)?|jxa)$/
+    'javascript'
+  when /^rb$/
+    'ruby'
+  when /^cc$/
+    'c'
+  when /^(ba|fi|z|c)?sh$/
+    'bash'
+  when /^pl$/
+    'perl'
+  else
+    if %w[awk sed css sass scss less cpp php c sh swift html erb json xpath sql htaccess].include?(ext)
+      ext
+    else
+      ''
+    end
+  end
+end
+
+def syntax_from_extension(filename)
+  ext_to_lang(filename.split(/\./)[1])
+end
+
+options = {
+    interactive: true,
+    launchbar: false,
+    output: 'raw',
+    source: $search_path,
+    highlight: false,
+    all: false
+  }
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] query"
+
+  opts.on('-q', '--quiet', 'Skip menus and display first match') do
+    options[:interactive] = false
+    options[:launchbar] = false
+  end
+
+  opts.on('-a', '--all', 'If a file contains multiple snippets, output all of them (no menu)') do
+    options[:all] = true
+  end
+
+  opts.on('-o', '--output FORMAT', 'Output format (launchbar or raw)') do |outformat|
+    valid = %w[json launchbar lb raw]
+    if outformat.downcase =~ /(launchbar|lb)/
+      options[:launchbar] = true
+      options[:interactive] = false
+    elsif valid.include?(outformat.downcase)
+      options[:output] = outformat.downcase
+    end
+  end
+
+  opts.on('-s', '--source FOLDER', 'Snippets folder to search') do |folder|
+    options[:source] = File.expand_path(folder)
+  end
+
+  opts.on('--highlight', 'Use pygments or skylighting to syntax highlight (if installed)') do
+    options[:highlight] = true
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts optparse
+    Process.exit 0
+  end
+end
+
+optparse.parse!
+
+query = ''
+
+if options[:launchbar]
+  query = if $stdin.stat.size.positive?
+            $stdin.read.force_encoding('utf-8')
+          else
+            ARGV.join(' ')
+          end
+elsif ARGV.length
+  query = ARGV.join(' ')
+end
+
+query = CGI.unescape(query)
+
+if query.strip.empty?
+  puts 'No search query'
+  puts optparse
+  Process.exit 1
+end
+
+results = search(query, options[:source], 0)
+
+if options[:launchbar]
+  output = []
+
+  if results.empty?
+    out = {
+      'title' => 'No matching snippets found'
+    }.to_json
+    puts out
+    Process.exit
+  end
+
+  results.each do |result|
+    input = IO.read(result['path'])
+    snippets = input.snippets
+    next if snippets.empty?
+
+    children = []
+
+    if snippets.length == 1
+      output << {
+        'title' => result['title'],
+        'path' => result['path'],
+        'action' => 'copyIt',
+        'actionArgument' => snippets[0]['code'],
+        'label' => 'Copy'
+      }
+      next
+    end
+
+    snippets.each { |s|
+      children << {
+        'title' => s['title'],
+        'path' => result['path'],
+        'action' => 'copyIt',
+        'actionArgument' => s['code'],
+        'label' => 'Copy'
+      }
+    }
+
+    output << {
+      'title' => result['title'],
+      'path' => result['path'],
+      'children' => children
+    }
+  end
+
+  puts output.to_json
+else
+  filepath = nil
+  if results.empty?
+    warn 'No results'
+    Process.exit 0
+  elsif results.length == 1 || !options[:interactive]
+    filepath = results[0]['path']
+    input = IO.read(filepath)
+  else
+    answer = menu(results, 'Select a file')
+    filepath = answer['path']
+    input = IO.read(filepath)
+  end
+
+  snippets = input.snippets
+
+  if snippets.empty?
+    warn 'No snippets found'
+    Process.exit 0
+  elsif snippets.length == 1 || !options[:interactive]
+    if options[:output] == 'json'
+      $stdout.puts snippets.to_json
+    else
+      snippets.each do |snip|
+        code = snip['code']
+        code = highlight(code, filepath) if options[:highlight]
+        $stdout.puts code
+      end
+    end
+  elsif snippets.length > 1
+    if options[:all]
+      if options[:output] == 'json'
+        $stdout.puts snippets.to_json
+      else
+        snippets.each do |snippet|
+          $stdout.puts snippet['title']
+          $stdout.puts '------'
+          $stdout.puts snippet['code']
+          $stdout.puts
+        end
+      end
+    else
+      answer = menu(snippets, 'Select snippet')
+      if options[:output] == 'json'
+        $stdout.puts answer.to_json
+      else
+        code = answer['code']
+        code = highlight(code, filepath) if options[:highlight]
+        $stdout.puts code
+      end
+    end
+  end
+end

data/lib/snibbets/array.rb

@@ -4,6 +4,10 @@ module Snibbets
       select { |el| el =~ /^<block\d+>$/ }.count
     end
 
+    def notes
+      select { |el| el !~ /^<block\d+>$/ && el !~ /^```/ && !el.strip.empty? }.count
+    end
+
     def strip_empty
       remove_leading_empty_elements.remove_trailing_empty_elements
     end

data/lib/snibbets/highlight.rb

@@ -41,8 +41,24 @@ module Snibbets
         # `echo #{Shellwords.escape(code)} | #{executable} #{theme}--syntax #{syntax}`
       end
 
+      def highlight_fences(code, filename, syntax)
+        content = code.dup
+
+        content.fences.each do |f|
+          rx = Regexp.new(Regexp.escape(f[:code]))
+          highlighted = highlight(f[:code].gsub(/\\k</, '\k\<'), filename, f[:lang] || syntax).strip
+          code.sub!(/#{rx}/, highlighted)
+        end
+
+        Snibbets.options[:all_notes] ? code.gsub(/k\\</, 'k<') : code.gsub(/k\\</, 'k<').clean_code
+      end
+
       def highlight(code, filename, syntax, theme = nil)
-        return code unless $stdout.isatty
+        unless $stdout.isatty
+          return Snibbets.options[:all_notes] && code.replace_blocks[0].notes? ? code : code.clean_code
+        end
+
+        return highlight_fences(code, filename, syntax) if code.fenced?
 
         theme ||= Snibbets.options[:highlight_theme] || 'monokai'
         syntax ||= Lexers.syntax_from_extension(filename)

data/lib/snibbets/string.rb

@@ -47,6 +47,28 @@ module Snibbets
       count > 1 && count.even?
     end
 
+    def blocks
+      replace_blocks[1].count
+    end
+
+    def blocks?
+      blocks.positive?
+    end
+
+    def notes?
+      replace_blocks[0].split("\n").notes.positive?
+    end
+
+    # Return array of fenced code blocks
+    def fences
+      return [] unless fenced?
+
+      rx = /(?mi)^(?<fence>`{3,})(?<lang> *\S+)? *\n(?<code>[\s\S]*?)\n\k<fence> *(?=\n|\Z)/
+      matches = []
+      scan(rx) { matches << Regexp.last_match }
+      matches.each_with_object([]) { |m, fenced| fenced.push({ code: m['code'], lang: m['lang'] }) }
+    end
+
     def indented?
       self =~ /^( {4,}|\t+)/
     end
@@ -61,7 +83,7 @@ module Snibbets
 
       # if it's a fenced code block, just discard the fence and everything
       # outside it
-      if block.fenced? && !Snibbets.options[:all_notes]
+      if block.fenced?
         code_blocks = block.scan(/(`{3,})(\w+)?\s*\n(.*?)\n\1/m)
         code_blocks.map! { |b| b[2].strip }
         return code_blocks.join("\n\n")
@@ -142,23 +164,29 @@ module Snibbets
 
       parts.each do |part|
         lines = part.split(/\n/).strip_empty
-        next if lines.blocks.zero?
 
-        title = lines.count > 1 && lines[0] !~ /<block\d+>/ ? lines.shift.strip.sub(/[.:]$/, '') : 'Default snippet'
+        notes = part.notes?
 
-        block = if Snibbets.options[:all_notes]
-                  lines.join("\n").gsub(/<(block\d+)>/) { "\n```\n#{code_blocks[Regexp.last_match(1)].strip_empty}\n```" }
+        next if lines.blocks.zero? && !notes
+
+        title = if lines.count > 1 && lines[0] !~ /<block\d+>/ && lines[0] =~ /^ +/
+                  lines.shift.strip.sub(/[.:]$/, '')
                 else
-                  lines.join("\n").gsub(/<(block\d+)>/) { code_blocks[Regexp.last_match(1)].strip_empty }
+                  'Default snippet'
                 end
 
-        # block = lines.join("\n").gsub(/<(block\d+)>/) { code_blocks[Regexp.last_match(1)] }
+        block = lines.join("\n").gsub(/<(block\d+)>/) do
+          code = code_blocks[Regexp.last_match(1)].strip_empty
+          lang, code = parse_lang_marker(code)
+          "\n```#{lang}\n#{code.strip}\n```"
+        end
 
-        lang, block = parse_lang_marker(block)
-        code = block.clean_code
+        lang, code = parse_lang_marker(block)
 
         next unless code && !code.empty?
 
+        # code = code.clean_code unless notes || code.fences.count > 1
+
         sections << {
           'title' => title,
           'code' => code.strip_empty,

data/lib/snibbets/todo_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# RSpec.describe Snibbets::Todo do
+#   subject(:todo) { Snibbets::Todo.new }
+
+#   describe ".todo" do
+#     it "returns todo" do
+#       expect(todo.todo).to be "TODO"
+#     end
+#   end
+# end

data/lib/snibbets/version.rb

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

data/lib/snibbets.rb

@@ -116,7 +116,6 @@ module Snibbets
       notebook = Snibbets.options[:source].gsub(/ /, '%20')
       note = ERB::Util.url_encode(File.basename(filepath, '.md'))
       url = "x-nvultra://open?notebook=#{notebook}&note=#{note}"
-      puts url
       `open '#{url}'`
     end
 
@@ -353,7 +352,7 @@ module Snibbets
       if Snibbets.options[:highlight] && Snibbets.options[:output] == 'raw'
         $stdout.puts(Highlight.highlight(output, filepath, syntax))
       else
-        $stdout.puts(output)
+        $stdout.puts(Snibbets.options[:all_notes] ? output : output.clean_code)
       end
       if Snibbets.options[:copy]
         OS.copy(output)

data/scripts/fixreadme.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+current_ver = `rake cver`
+src = 'src/_README.md'
+dest = 'README.md'
+
+readme = IO.read(src).force_encoding('ASCII-8BIT').encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
+
+content = readme.match(/(?<=\<!--README-->)(.*?)(?=\<!--END README-->)/m)[0]
+
+content.gsub!(/<!--VER-->(.*?)<!--END VER-->/, current_ver)
+content.gsub!(/<!--GITHUB-->(.*?)<!--END GITHUB-->/m, '\1')
+content.gsub!(/<!--JEKYLL(.*?)-->/m, '')
+
+content.gsub!(/^@cli\((.*?)\)/) do
+  cmd = Regexp.last_match(1)
+  `#{cmd}`.strip.gsub(/\n{2,}/, "\n\n")
+end
+
+File.open(dest, 'w') { |f| f.puts(content) }
+
+Process.exit 0

data/snibbets.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.bindir = "bin"
   spec.executables << 'snibbets'
 
-  spec.files = Dir["lib/**/*.rb"].reject { |f| f.end_with?("_spec.rb") }
-  spec.files += Dir["lib/themes/*.theme"]
-  spec.files += Dir["[A-Z]*"]
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.strip =~ %r{^((test|spec|features)/|\.git|buildnotes|.*\.taskpaper)} }
+  end
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "awesome_print", "~> 1.9"

data/{README.md.orig → src/_README.md}

@@ -1,22 +1,20 @@
+# Snibbets
 
-
+<!--README-->
+<!--GITHUB-->
 [![RubyGems.org](https://img.shields.io/gem/v/snibbets)](https://rubygems.org/gems/snibbets)
-<<<<<<< HEAD
-[![GitHub Actions](https://github.com/ttscoff/snibbets/actions/workflows/check.yml/badge.svg)](https://github.com/ttscoff/snibbets/actions/workflows/check.yml)
-=======
 <!-- [![GitHub Actions](https://github.com/ttscoff/snibbets/actions/workflows/check.yml/badge.svg)](https://github.com/ttscoff/snibbets/actions/workflows/check.yml) -->
->>>>>>> develop
-
+<!--END GITHUB-->
 A tool for accessing code snippets contained in a folder of plain text Markdown files.
 
 Snibbets allows me to keep code snippets in raw files, not relying on a dedicated code snippet app. I can collect and edit my snippets using a text editor, nvALT (nvUltra), or simply by saving snippets from my clipboard to a text file using *NIX redirection on the command line. I can add descriptive names and extended descriptions/notes to code snippets using standard Markdown.
 
 What Snibbets does is simply allow a quick search for a specific snippet that I can either output to the terminal, pipe to my clipboard, or access via LaunchBar (via the included LaunchBar Action). It's basically a wrapper for `find` and `grep` with the ability to separate code blocks from other text in my Markdown files.
 
-
+<!--GITHUB-->
 ![Snibbets in action](https://cdn3.brettterpstra.com/uploads/2023/04/snibbets2.gif)
-
-
+<!--END GITHUB-->
+<!--JEKYLL{% gif /uploads/2023/04/snibbets2.gif %}-->
 
 ## Collecting Snippets
 
@@ -28,7 +26,7 @@ The name of the file should be the description of the snippet, at least in the c
 
 You can combine multiple snippets in a file, though. For example, I have a file called 'Ruby hash snippets.rb.md'. That file contains an array of useful snippets, and each one has a descriptive title in an h3 header above it. Those (ATX) headers are used to split the file, and when you search from the command line, you'll get a menu of all of the snippets in the selected file. (And if you have [fzf](https://github.com/junegunn/fzf) or [gum](https://github.com/charmbracelet/gum) installed, you can quickly filter through with fuzzy searching and find exactly what you need.)
 
-If a file contains multiple snippets, they should be separated by ATX-style headers (one or more `#`) describing the snippets. Additional  descriptions can be included outside of the code block. For example:
+If a file contains multiple snippets, they should be separated by ATX-style headers (one or more `#`) describing the snippets. Additional descriptions and notes can be included outside of the code block. Notes are not output on the console, only the code is displayed. If you want a note to be included in console output, make it a blockquote by preceding it with `>`. 
 
 A file titled `unix find.bash.md`:
 
@@ -49,22 +47,22 @@ A file titled `unix find.bash.md`:
 
         find /dir/dir -type f -mtime +540 -mtime -720 -printf \"%p\",\"%s\",\"%AD\",|"%TD\"\\n > /dir/dir/output.csv
 
-You can include MultiMarkdown metadata in your snippets, either in a YAML block or just at the top of the file with raw key/value pairs. I mostly use this for adding tags, which are then synced to macOS tags when I save. It makes it easy to search for snippets in [nvUltra](https://nvultra.com/), and also allows you to do searches like `snibbets tag:javascript url parser` in Snibbets.
+You can include MultiMarkdown metadata in your snippets, either in a YAML block or just at the top of the file with raw key/value pairs. I mostly use this for adding tags, which are then synced to macOS tags when I save. It makes it easy to search for snippets in [nvUltra](https://nvultra.com/), and also allows you to do searches like `snibbets tag:javascript url parser` with Snibbets.
 
 ## CLI
 
 ### Dependencies
 
-Snibbets requires Ruby 3.0+. On recent versions of macOS, this is not included by default. You can install it via the Command Line Tools from Apple. On macOS and most other systems, you can use something like [Homebrew], [rbenv], [rvm], or [asdf] to install Ruby 3.
+Snibbets requires Ruby 3.0+. On recent versions of macOS, this is not included by default. You can install it via the Command Line Tools from Apple. On macOS and most other systems, you can also use something like [Homebrew], [rbenv], [rvm], or [asdf] to install Ruby 3.
 
 If available, menus are generated by [fzf] or [gum]. If neither are available, a basic Readline menu system will be displayed, so neither are required, just nice to have as they provide fuzzy filtering, scrolling, and type-ahead completion.
 
-[homebrew]: https://brew.sh/ "Homebrew???The Missing Package Manager for macOS (or Linux)"
+[homebrew]: https://brew.sh/ "Homebrew—The Missing Package Manager for macOS (or Linux)"
 [rbenv]: https://github.com/rbenv/rbenv "rbenv/rbenv:Manage your app's Ruby environment"
 [rvm]: https://rvm.io/ "Ruby Version Manager"
 [asdf]: https://asdf-vm.com/ "ASDF environment manager"
 [fzf]: https://github.com/junegunn/fzf "junegunn/fzf:A command-line fuzzy finder"
-[gum]: https://github.com/charmbracelet/gum "charmbracelet/gum:A tool for glamorous shell scripts ????"
+[gum]: https://github.com/charmbracelet/gum "charmbracelet/gum:A tool for glamorous shell scripts 🎀"
 
 ### Installation
 
@@ -106,14 +104,14 @@ 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/
 
 The `editor` setting is used to open the config file, and to open snippets for editing when using the `--edit` flag. This setting can be any command line utility (`code`, `subl`, `vim`, `nano`, etc.), or on macOS it can be an application name (`BBEdit`, `VS Code`, etc.) or a bundle identifier (`com.sublimetext.4`, `com.microsoft.VSCode`, etc.). If no editor is set, then the file will be opened by whatever the system default is (using `open` on macOS, `start` on Windows, or `xdg-open`on Linux).
 
-The `highlight` key turns on syntax highlighting. This requires that either `pygmentize` or `skyligting` is available on your system (both available via package managers like Homebrew). This feature is still in development and results may be mixed.
-
 The `include_blockquotes` setting determines whether blockquotes are included in the output. By default, Snibbets removes everything other than code blocks (indented or fenced) from the output it displays. But if you want to include a note that you'll see on the command line, you can put it in a block quote by preceding each line you want to preserve with a right angle bracket (`>`).
 
 The `interactive` setting determines whether menus will be displayed. This should generally be true, but if you want silent operation that just displays the best match automatically, set it to false. 
@@ -122,26 +120,48 @@ The `menus` setting will determine what method is used for displaying interactiv
 
 The `name_only` key will permanently set Snibbets to only search for snippets by their filename rather than examining their contents. You can enable this at runtime using `--name-only` in the command.
 
+#### Syntax Highlighting
+
+The `highlight` key turns on syntax highlighting. This requires that either `pygmentize` or `skylighting` is available on your system (both available via package managers like Homebrew). This feature is still in development and results may be mixed. You can also set `highlighter` to `pygments` or `skylight` to force using one highlighter over the other. 
+
+Highlighting using Skylighting requires that your snippets be named with extra extensions defining the lexer to use. The last extension before `.md` (or whatever your snippet extension is set to) should be the one that the highlighter will recognize as a valid lexer, e.g. `my code.jquery.js.md`. 
+
+You can also define languages in your fenced code blocks by putting the lexer name right after the opening fence. When defining multiple snippets in one file that are of different languages, this method will ensure that each one is properly highlighted. 
+
+If you don't use either extensions or fenced code labels with Skylighting, code won't get highlighted.
+
+To define a snippet as python code, for example:
+
+    ```python
+    class EmlServer(SMTPServer):
+        no = 0
+        def process_message(self, peer, mailfrom, rcpttos, data):
+            filename = '%s-%d.eml' % (datetime.now().strftime('%Y%m%d%H%M%S'),
+                    self.no)
+            f = open(filename, 'w')
+    ```
+
+You can also define a color scheme with `highlight_theme`. If you're using Pygments, run `pygmentize -L styles` to see available options. If you're using Skylighting, you can reference any theme in the [KDE repository]. Skylighting themes are included in Snibbets and can be referenced by their filename without `.theme`, or you can install your own themes and reference them with a full path. (I recommend `nord` when using Sylighting.)
+
+[KDE repository]: https://github.com/KDE/syntax-highlighting/tree/master/data/themes
+
+You can turn highlighting on or off for a single run using `--highlight` or `--no-highlight`. Syntax highlighting definitely affects copyable output, so it's automatically disabled when piping/redirecting output. When using `--copy`, the code sent to the clipboard is not highlighted.
+
+##### Installing a Syntax Highlighter
+
+Snibbet's implementation of Skylighting has limited but better-looking themes, and has some lexers that Pygments lacks. However, Pygments has _more_ lexers and a wider array of themes. It also can determine the target syntax automatically better than Skylighting (which requires the syntax to be specified -- it's pulled from the extensions of your snippets), which is why Pygments is the default if it's installed and you don't configure it otherwise.
+
+- Install [Skylighting] with [Homebrew] (`brew install skylighting`) or [apt-get].
+- Install [Pygments] using [Homebrew] (`brew install pygments`) or `pip install pygments`.
+
+[Skylighting]: https://github.com/jgm/skylighting
+[apt-get]: https://installati.one/install-skylighting-ubuntu-22-04/
+[Pygments]: https://pygments.org/
+
 ### Usage
 
 ```
-Snibbets v2.0.14
-
-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
-    -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
-    -s, --source FOLDER              Snippets folder to search
-        --configure                  Open the configuration file in your default editor
-        --[no-]blockquotes           Include block quotes in output
-        --highlight                  Use pygments or skylighting to syntax highlight (if installed)
-        --save                       Save the current command line options to the YAML configuration
-    -h, --help                       Display this screen
-    -v, --version                    Display version information
+@cli(bundle exec bin/snibbets -h)
 ```
 
 If your Snippets folder is set in the config, simply running `snibbets [search query]` will perform the search and output the code blocks, presenting a menu if more than one match is found or the target file contains more than one snippet. Selected contents are output raw to STDOUT.
@@ -175,7 +195,7 @@ Any time you specify things like a source folder with the `--source` flag, or tu
 
 _I'm currently reworking the LaunchBar action, and it doesn't function very well at this time. I'll update when I have a chance._
 
-### Installation
+<!-- ### Installation
 
 The LaunchBar action can be installed simply by double clicking the `.lbaction` file in Finder. The CLI is not required for the LaunchBar action to function. 
 
@@ -183,4 +203,5 @@ Once installed, run the action (type `snib` and hit return on the result) to sel
 
 ### Usage
 
-Type `snib` to bring the Action up, then hit Space to enter your query text. Matching files will be presented. If the selected file contains more than one snippet, a list of snippets (based on ATX headers in the file) will be presented as a child menu. Selecting a snippet and hitting return will copy the associated code block to the clipboard.
+Type `snib` to bring the Action up, then hit Space to enter your query text. Matching files will be presented. If the selected file contains more than one snippet, a list of snippets (based on ATX headers in the file) will be presented as a child menu. Selecting a snippet and hitting return will copy the associated code block to the clipboard. -->
+<!--END README-->

data/yard_templates/default/method_details/setup.rb

@@ -0,0 +1,3 @@
+def source
+  return
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snibbets
 version: !ruby/object:Gem::Version
-  version: 2.0.30
+  version: 2.0.31
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -238,17 +238,23 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".editorconfig"
+- ".irbrc"
+- ".rspec"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- Gemfile.lock.orig
 - LICENSE.txt
 - README.md
-- README.md.orig
 - README.rdoc
 - Rakefile
+- Snibbets.lbaction/Contents/Info.plist
+- Snibbets.lbaction/Contents/Scripts/default.js
+- Snibbets.lbaction/Contents/Scripts/snibbets.rb
 - bin/snibbets
-- buildnotes.md
 - lib/snibbets.rb
 - lib/snibbets/array.rb
 - lib/snibbets/config.rb
@@ -259,6 +265,7 @@ files:
 - lib/snibbets/menu.rb
 - lib/snibbets/os.rb
 - lib/snibbets/string.rb
+- lib/snibbets/todo_spec.rb
 - lib/snibbets/version.rb
 - lib/snibbets/which.rb
 - lib/themes/atom-one-dark.theme
@@ -287,8 +294,10 @@ files:
 - lib/themes/solarized-dark.theme
 - lib/themes/solarized-light.theme
 - lib/themes/vim-dark.theme
+- scripts/fixreadme.rb
 - snibbets.gemspec
-- snibbets.taskpaper
+- src/_README.md
+- yard_templates/default/method_details/setup.rb
 homepage: https://github.com/ttscoff/snibbets
 licenses:
 - MIT

data/Gemfile.lock.orig

@@ -1,107 +0,0 @@
-PATH
-  remote: .
-  specs:
-    snibbets (2.0.10)
-      tty-which (~> 0.5, >= 0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    awesome_print (1.9.2)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    gem-release (2.2.2)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    multi_json (1.15.0)
-    parallel (1.22.1)
-    parse_gemspec (1.0.0)
-    parse_gemspec-cli (1.0.0)
-      multi_json
-      parse_gemspec
-      thor
-    parser (3.2.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-<<<<<<< HEAD
-    rdoc (6.3.1)
-=======
-    rdoc (6.3.3)
->>>>>>> af6f234 (Update rdoc)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.16.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.1)
-      ansi
-      simplecov
-      terminal-table
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    standard (1.26.0)
-      language_server-protocol (~> 3.17.0.2)
-      rubocop (~> 1.48.1)
-      rubocop-performance (~> 1.16.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    tty-which (0.5.0)
-    unicode-display_width (2.4.2)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  arm64-darwin-20
-  x86_64-linux
-
-DEPENDENCIES
-  awesome_print (~> 1.9)
-  bundler (~> 2.0)
-  gem-release (~> 2.2)
-  parse_gemspec-cli (~> 1.0)
-  rake (~> 13.0)
-  rdoc (~> 6.3.1)
-  rspec (~> 3.0)
-  simplecov (~> 0.21)
-  simplecov-console (~> 0.9)
-  snibbets!
-  standard (~> 1.3)
-  yard (~> 0.9, >= 0.9.26)
-
-BUNDLED WITH
-   2.2.29

data/buildnotes.md

@@ -1,47 +0,0 @@
-template: gem, git, gli, project
-executable: na
-readme: src/_README.md
-changelog: CHANGELOG.md
-project: snibbets
-
-# Snibbets
-
-A plain text snippet manager
-
-## Develop
-
-@run(subl .)
-
-## Dummy
-
-@run(bundle exec bin/snibbets $@)
-
-## Deploy
-
-You no longer need to manually bump the version, it will be incremented when this task runs.
-
-```run Update Changelog
-#!/bin/bash
-
-changelog -u
-```
-
-@include(project:Update GitHub README)
-
-```run Update README
-#!/bin/bash
-
-changelog | git commit -a -F -
-git pull
-git push
-```
-
-@include(gem:Release Gem) Release Gem
-@include(project:Update Blog Project) Update Blog Project
-@run(rake bump[patch]) Bump Version
-
-@run(git commit -am 'Version bump')
-
-@after
-Don't forget to publish the website!
-@end

data/snibbets.taskpaper

@@ -1,14 +0,0 @@
-Inbox:
-	- handle multiple code blocks within a section separately for highlighting @maybe @na
-		If a header contains multiple snippets, create an array with a language specifier for each snippet, and then pass the array to the print function to handle individually highlighting each code block. Have a special language specifier for blockquote notes to avoid highlighting them at all.
-		Could possibly just highlight each block as its found, and save an original copy in memory for uncolored output, or just write a decoloring method. Skip highlighting if it's not enabled, but decolor ouput sent to non-tty or --copy.
-snibbets:
-	Feature Requests:
-	Ideas:
-	Bugs:
-Archive:
-Search Definitions:
-	Top Priority @search(@priority = 5 and not @done)
-	High Priority @search(@priority > 3 and not @done)
-	Maybe @search(@maybe)
-	Next @search(@na and not @done and not project = "Archive")