snibbets 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4064d03cc2613a15f154682bd809dbcced9923cc3ce0577f17e2ae5ca1fa8f
-  data.tar.gz: 818f92d5da7a115f280a701f71fe176ad3b3e119435e252c146ec084803521a5
+  metadata.gz: e89ca24c47d946572565c20c19ab3c14c80b60d88874d871a74975478efd8a34
+  data.tar.gz: 66996bcf10f8f7d6bd0d879f150f94fe1c6b07b812f5aad27797a96ed9aa1cbd
 SHA512:
-  metadata.gz: 5cc558d53cadcf0a09bec9e22f0f67386dcfb786945df71b64ee282397f433e19bd990f20d668535768cd2669401a1f81a90cf806be0f19a6637afb67cba3643
-  data.tar.gz: 81a674e80b35ce53dc7fdb0f5aaf5399ed0dae920f0b0c415b4dedd4d1a15c69b1ead39091f3784ffa61d44acd8244f686be511c3ca8f463bb1f34997f7f36a6
+  metadata.gz: 676d63c79f5278dc7ca5edd8dcf68a0136b2ef26864c087b35c8fb595cf8b0150218691569a1d28b3d92ca4eecc581549cefb6c4b67d52fed00c164c1130c91b
+  data.tar.gz: dd83ac848efd7510c0aff692b802662610c6df5a8e245292478e8f39a2677ff8a11c747ac384f4a9c3a6544c6658b397207f5ef234dd470e58a095567a2eb7ee

data/CHANGELOG.md.orig

@@ -1,3 +1,22 @@
+### 2.0.17
+
+2023-04-16 06:31
+
+#### NEW
+
+- Languages specified in the opening fence of a code block are passed to the syntax highlighter (only affects Skylighting)
+
+#### IMPROVED
+
+- Add all available themes for Skylighting
+- Allow a custom theme path to be provided for Skylighting by including a path in `highlight_theme` config
+- Handle syntax highlighter errors, returning plain code if command fails
+
+#### FIXED
+
+- Disable syntax highlighting when command is being piped or redirected
+- Don't syntax highlight clipboard code when using `--copy`
+
 ### 2.0.16
 
 2023-04-15 22:15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snibbets (2.0.16)
+    snibbets (2.0.17)
       tty-which (~> 0.5, >= 0.5.0)
 
 GEM

data/README.md

@@ -108,16 +108,6 @@ The `copy` setting determines whether the output is copied to the clipboard in a
 
 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. You can also set `highlighter` to `pygments` or `skylight` to force using one highlighter over the other. 
-
-You can also define a color theme with `highlight_theme`. If you're using Pygments, run `pygmentize -L styles` to see available options. If you're using Skylighting, the only currently-available options are:
-
-- breeze-dark
-- monokai
-- nord
-- solarized-dark
-- solarized-light
-
 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. 
@@ -126,10 +116,46 @@ 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 `skyligting` 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. This is used with Skylighting, but Pygments will always use it's own lexer detection. When defining multiple snippets in one file that are of different languages, this method will ensure that each one is properly 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 pygmentize`) 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.16
+Snibbets v2.0.17
 
 Usage: snibbets [options] query
     -a, --all                        If a file contains multiple snippets, output all of them (no menu)
@@ -142,7 +168,7 @@ Usage: snibbets [options] query
     -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)
+        --[no-]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
@@ -179,7 +205,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. 
 
@@ -187,4 +213,4 @@ 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. -->

data/bin/snibbets

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W1
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
@@ -6,17 +6,11 @@ require 'snibbets'
 
 module Snibbets
   class << self
-    attr_reader :arguments, :query
+    attr_reader :query
 
     def run
-      options = Snibbets.config.options
-
-      @arguments = {
-        save_config: false,
-        edit_config: false,
-        edit_snippet: false,
-        paste_snippet: false
-      }
+      options = Snibbets.options
+      arguments = Snibbets.arguments
 
       optparse = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename(__FILE__)} [options] query"
@@ -30,7 +24,7 @@ module Snibbets
         end
 
         opts.on('-e', '--edit', 'Open the selected snippet in your configured editor') do
-          @arguments[:edit_snippet] = true
+          arguments[:edit_snippet] = true
         end
 
         opts.on('-n', '--[no-]name-only', 'Only search file names, not content') do |v|
@@ -48,7 +42,7 @@ module Snibbets
         end
 
         opts.on('-p', '--paste', '--new', 'Interactively create a new snippet from clipboard contents (Mac only)') do
-          @arguments[:paste_snippet] = true
+          arguments[:paste_snippet] = true
         end
 
         opts.on('-q', '--quiet', 'Skip menus and display first match') do
@@ -61,19 +55,19 @@ module Snibbets
         end
 
         opts.on('--configure', 'Open the configuration file in your default editor') do
-          @arguments[:edit_config] = true
+          arguments[:edit_config] = true
         end
 
         opts.on('--[no-]blockquotes', 'Include block quotes in output') do |v|
           options[:include_blockquotes] = v
         end
 
-        opts.on('--highlight', 'Use pygments or skylighting to syntax highlight (if installed)') do
-          options[:highlight] = true
+        opts.on('--[no-]highlight', 'Use pygments or skylighting to syntax highlight (if installed)') do |v|
+          options[:highlight] = v
         end
 
         opts.on('--save', 'Save the current command line options to the YAML configuration') do
-          @arguments[:save_config] = true
+          arguments[:save_config] = true
         end
 
         opts.on('-h', '--help', 'Display this screen') do
@@ -91,13 +85,13 @@ module Snibbets
 
       optparse.parse!
 
-      if @arguments[:save_config]
+      if arguments[:save_config]
         config = Snibbets::Config.new
         config.write_config
         puts "Configuration saved to #{config.config_file}"
       end
 
-      if @arguments[:edit_config]
+      if arguments[:edit_config]
         config = Snibbets::Config.new
         config.write_config
         open_snippet_in_editor(config.config_file)
@@ -110,7 +104,7 @@ module Snibbets
         Process.exit 1
       end
 
-      if @arguments[:paste_snippet]
+      if arguments[:paste_snippet]
         Snibbets.new_snippet_from_clipboard
         Process.exit 0
       end
@@ -130,7 +124,7 @@ module Snibbets
       @query = CGI.unescape(@query)
 
       if @query.strip.empty?
-        if @arguments[:save_config]
+        if arguments[:save_config]
           Process.exit 0
         else
           puts 'No search query'

data/lib/snibbets/config.rb

@@ -2,7 +2,14 @@
 
 module Snibbets
   class Config
-    attr_accessor :options, :test_editor, :config_dir, :config_file
+    attr_accessor :options, :arguments, :test_editor, :config_dir, :config_file
+
+    DEFAULT_ARGUMENTS = {
+      save_config: false,
+      edit_config: false,
+      edit_snippet: false,
+      paste_snippet: false
+    }.freeze
 
     DEFAULT_OPTIONS = {
       all: false,
@@ -28,6 +35,7 @@ module Snibbets
       @options = DEFAULT_OPTIONS.merge(custom_config)
       @options[:editor] ||= best_editor
       @options[:menus] ||= best_menu
+      @arguments = DEFAULT_ARGUMENTS.dup
       @test_editor = nil
 
       write_config unless @options.equal?(custom_config)

data/lib/snibbets/highlight.rb

@@ -1,16 +1,34 @@
 module Snibbets
   module Highlight
     class << self
+      def run_command_with_input(*cmd, input: nil, fallback: nil)
+        stdout, _stderr, status = Open3.capture3(*cmd, stdin_data: input)
+        if status.success?
+          stdout
+        elsif fallback.nil?
+          input
+        else
+          run_command_with_input(fallback, input: input, fallback: nil)
+        end
+      end
+
       def highlight_pygments(executable, code, syntax, theme)
-        puts [syntax, theme]
-        # syntax = syntax.nil? || syntax.empty? ? '-g' : "-l #{syntax}"
+        syntax = syntax.nil? || syntax.empty? ? '-g' : "-l #{syntax}"
         theme = theme.nil? || theme.empty? ? '' : ",style=#{theme}"
-        `echo #{Shellwords.escape(code)} | #{executable} -O full#{theme} -g` # #{theme}
+        command = "#{executable} -O full#{theme} #{syntax}"
+        fallback = "#{executable} -O full#{theme} -g"
+        run_command_with_input(command, input: code, fallback: fallback)
       end
 
       def highlight_skylight(executable, code, syntax, theme)
-        theme ||= 'monokai'
-        theme_file = File.join(__dir__, '..', "#{theme}.theme")
+        theme ||= 'nord'
+        theme_file = if theme =~ %r{^[/~].*?(\.theme)?$}
+                       theme = theme.sub(/(\.theme)?$/, '.theme')
+                       File.expand_path(theme)
+                     else
+                       theme = theme.sub(/\.theme$/, '')
+                       File.join(__dir__, '..', 'themes', "#{theme}.theme")
+                     end
 
         theme = if File.exist?(theme_file)
                   "-t #{theme_file} "
@@ -19,23 +37,28 @@ module Snibbets
                 end
         return code if syntax.nil? || syntax.empty?
 
-        `echo #{Shellwords.escape(code)} | #{executable} #{theme}--syntax #{syntax}`
+        run_command_with_input("#{executable} #{theme}--syntax #{syntax}", input: code)
+        # `echo #{Shellwords.escape(code)} | #{executable} #{theme}--syntax #{syntax}`
       end
 
-      def highlight(code, filename, theme = nil)
-        theme ||= Snibbets.options[:highlight_theme]
-        syntax = Lexers.syntax_from_extension(filename)
+      def highlight(code, filename, syntax, theme = nil)
+        return code unless $stdout.isatty
+
+        theme ||= Snibbets.options[:highlight_theme] || 'monokai'
+        syntax ||= Lexers.syntax_from_extension(filename)
+
+        return code if ['text'].include?(syntax)
 
         skylight = TTY::Which.which('skylighting')
         pygments = TTY::Which.which('pygmentize')
 
-        if Snibbets.options[:highlighter] =~ /^s/ && skylight
+        if Snibbets.options[:highlighter] =~ /^s/ && !skylight.nil?
           return highlight_skylight(skylight, code, syntax, theme)
-        elsif Snibbets.options[:highlighter] =~ /^p/ && !pygments.empty?
+        elsif Snibbets.options[:highlighter] =~ /^p/ && !pygments.nil?
           return highlight_pygments(pygments, code, syntax, theme)
-        elsif !skylight.empty?
+        elsif !skylight.nil?
           return highlight_skylight(skylight, code, syntax, theme)
-        elsif !pygments.empty?
+        elsif !pygments.nil?
           return highlight_pygments(pygments, code, syntax, theme)
         end
 

data/lib/snibbets/string.rb

@@ -117,9 +117,11 @@ module Snibbets
         end
       end
 
-      sans_blocks = sans_blocks.gsub(/^(`{3,})(\w+)?\s*\n(.*?)\n\1/m) do
+      sans_blocks = sans_blocks.gsub(/^(`{3,})(\s*\w+)?\s*\n(.*?)\n\1/m) do
         counter += 1
-        code_blocks["block#{counter}"] = Regexp.last_match(3)
+        lang = Regexp.last_match(2)
+        lang = "<lang:#{lang.strip}>\n" if lang
+        code_blocks["block#{counter}"] = "#{lang}#{Regexp.last_match(3)}"
         "<block#{counter}>\n"
       end
 
@@ -153,13 +155,20 @@ module Snibbets
         title = lines.count > 1 ? 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
+
         code = block.clean_code
 
         next unless code && !code.empty?
 
         sections << {
           'title' => title,
-          'code' => code
+          'code' => code,
+          'language' => lang
         }
       end
 

data/lib/snibbets/version.rb

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

data/lib/snibbets.rb

@@ -8,6 +8,7 @@ require 'shellwords'
 require 'yaml'
 require 'fileutils'
 require 'tty-which'
+require 'open3'
 require_relative 'snibbets/version'
 require_relative 'snibbets/config'
 require_relative 'snibbets/which'
@@ -29,6 +30,10 @@ module Snibbets
     def options
       @options = config.options
     end
+
+    def arguments
+      @arguments = config.arguments
+    end
   end
 end
 
@@ -234,7 +239,7 @@ module Snibbets
           input = IO.read(filepath)
         end
 
-        if @arguments[:edit_snippet]
+        if Snibbets.arguments[:edit_snippet]
           open_snippet_in_editor(filepath)
           Process.exit 0
         end
@@ -246,30 +251,30 @@ module Snibbets
           Process.exit 0
         elsif snippets.length == 1 || !Snibbets.options[:interactive]
           if Snibbets.options[:output] == 'json'
-            print(snippets.to_json)
+            print(snippets.to_json, filepath)
           else
             snippets.each do |snip|
               header = File.basename(filepath, '.md')
               warn header
               warn '-' * header.length
               code = snip['code']
-              code = Highlight.highlight(code, filepath) if Snibbets.options[:highlight]
-              print(code)
+              lang = snip['language']
+              print(code, filepath, lang)
             end
           end
         elsif snippets.length > 1
           if Snibbets.options[:all]
             if Snibbets.options[:output] == 'json'
-              print(snippets.to_json)
+              print(snippets.to_json, filepath)
             else
-              output = []
+
               snippets.each do |snippet|
-                output << snippet['title']
-                output << '-' * snippet['title'].length
-                output << snippet['code']
-                output << "\n"
+                lang = snippet['language']
+                warn "# #{snippet['title']}"
+                # warn "# #{'-' * snippet['title'].length}"
+                print(snippet['code'], filepath, lang)
+                puts
               end
-              print(output.join("\n"))
             end
           else
             snippets.push({ 'title' => 'All snippets', 'code' => '' })
@@ -277,39 +282,44 @@ module Snibbets
             answer = Menu.menu(snippets, filename: File.basename(filepath, '.md'), title: 'Select snippet', query: @query)
 
             if answer['title'] == 'All snippets'
-              snippets.delete_if { |s| s['title'] == 'All snippets'}
+              snippets.delete_if { |s| s['title'] == 'All snippets' }
               if Snibbets.options[:output] == 'json'
-                print(snippets.to_json)
+                print(snippets.to_json, filepath)
               else
                 header = File.basename(filepath, '.md')
                 warn header
                 warn '=' * header.length
-                output = []
+
                 snippets.each do |snippet|
-                  output << snippet['title']
-                  output << '-' * snippet['title'].length
-                  output << snippet['code']
-                  output << "\n"
+                  lang = snippet['language']
+                  warn "# #{snippet['title']}"
+                  # warn "# #{'-' * snippet['title'].length}"
+                  print(snippet['code'], filepath, lang)
+                  puts
                 end
-                print(output.join("\n"))
+
               end
             elsif Snibbets.options[:output] == 'json'
-              print(answer.to_json)
+              print(answer.to_json, filepath)
             else
               header = "#{File.basename(filepath, '.md')}: #{answer['title']}"
               warn header
               warn '-' * header.length
               code = answer['code']
-              code = Highlight.highlight(code, filepath) if Snibbets.options[:highlight]
-              print(code)
+              lang = answer['language']
+              print(code, filepath, lang)
             end
           end
         end
       end
     end
 
-    def print(output)
-      $stdout.puts(output)
+    def print(output, filepath, syntax = nil)
+      if Snibbets.options[:highlight] && Snibbets.options[:output] == 'raw'
+        $stdout.puts(Highlight.highlight(output, filepath, syntax))
+      else
+        $stdout.puts(output)
+      end
       if Snibbets.options[:copy]
         OS.copy(output)
         $stderr.puts "Copied to clipboard"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snibbets
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors:
 - Brett Terpstra
@@ -210,9 +210,6 @@ files:
 - Rakefile
 - bin/snibbets
 - buildnotes.md
-- lib/breeze-dark.theme
-- lib/monokai.theme
-- lib/nord.theme
 - lib/snibbets.rb
 - lib/snibbets/array.rb
 - lib/snibbets/config.rb
@@ -225,8 +222,6 @@ files:
 - lib/snibbets/string.rb
 - lib/snibbets/version.rb
 - lib/snibbets/which.rb
-- lib/solarized-dark.theme
-- lib/solarized-light.theme
 - snibbets.gemspec
 homepage: https://github.com/ttscoff/snibbets
 licenses: