snibbets 2.0.21 → 2.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8faa764639ff4c20cf7527936e4b4f8c5338bebda2a1711150bf395ea9731bf
-  data.tar.gz: 50dca9964625bc96e539818cf650d295f568b0870742d156bd3036f2d9847738
+  metadata.gz: f4b84e73a8183169220197b680d511137b7aa5e191f22df4a4d8bc30217b9835
+  data.tar.gz: 6add8e505ca052e703c79aa43f99b2b58a1f05d71d850cda998681a58ac8f01a
 SHA512:
-  metadata.gz: b0c1a0ad3b519d054af3874aaf3a9f7a2b89bc2b3c287f6b8a21eae5344ee3eb29f6699d63da2ad2489ad5e0b0c5708f3c931328fd432e98fe6ec175a68d6742
-  data.tar.gz: '0099e0d3d525d033d8ea70187979df6849e67cbfe632cd1967154c9b6ba50212255ffb9daf2a5e4549538b256e627d9c384cfc139fe6e0e9137201839af93cec'
+  metadata.gz: dd8b8a316b2fd98445a3d7e387ed54218af99788c40aa0cf73b8bc149339bdc525b7e8cdb47da4cf211d642e65dfa591aabfb2e2ea49fe82650e58ad157f7099
+  data.tar.gz: 760f09adcce3a26ebb9093f019413e0b6ac14cc020f4cd8c4fbe4aff348bd75651b0c4170eabfd7b64445b47136181f56d9a0d0a38e9af6e60c399a16291b7a1

data/CHANGELOG.md

@@ -1,3 +1,151 @@
+### 2.0.23
+
+2023-04-16 10:33
+
+#### 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.22
+
+2023-04-16 09:33
+
+#### IMPROVED
+
+- Use Readline for entering info with `--paste`, allows for better editing experience
+
+#### FIXED
+
+- Code indentation with `--paste`
+
+### 2.0.21
+
+2023-04-16 09:04
+
+#### IMPROVED
+
+- Use leading and trailing hashes to make snippet titles more obvious when outputting All Snippets
+
+### 2.0.20
+
+2023-04-16 08:31
+
+#### FIXED
+
+- Fail to include skylighting themes in gem bundle
+- Failure to recognize fenced code blocks with language specifiers containing hyphens
+
+### 2.0.19
+
+2023-04-16 08:05
+
+#### FIXED
+
+- A fenced code block following a line containing only 4+ spaces or tabs would get parsed as an indented code block
+- Last fenced code block in a snippet might not be recognized
+
+### 2.0.18
+
+2023-04-16 06:57
+
+#### FIXED
+
+- If an invalid language (without a lexer) is supplied when using `--paste`, just use the input as the extension and tag
+
+### 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
+
+#### FIXED
+
+- Remove debugging output
+
+### 2.0.15
+
+2023-04-15 22:11
+
+#### NEW
+
+- Additional themes for skylighting: nord, monokai, solarized-light/dark
+
+#### FIXED
+
+- Bad path to highlighter themes for skylighting
+
+### 2.0.14
+
+2023-04-15 21:21
+
+#### IMPROVED
+
+- Better default themes for highlighters
+
+#### FIXED
+
+- Error with lexers_db when using higlighting
+
+### 2.0.13
+
+2023-04-15 19:57
+
+#### NEW
+
+- Option to include blockquotes (>) in output
+
+### 2.0.12
+
+2023-04-15 19:28
+
+#### FIXED
+
+- Lowered minimum ruby version to allow Ruby 2.6
+- Failure to recognize snippet if title is on first line of file
+- Errantly discarding first snippet in file with multiple snippets
+
+### 2.0.11
+
+2023-04-15 19:06
+
+#### FIXED
+
+- Overactive stripping of newlines within code blocks
+- Syntax definition determination when adding new snippets
+
+### 2.0.10
+
+2023-04-15 16:28
+
+#### FIXED
+
+- Update dependencies for security
+- Incorporate fixes from @robjwells addressing #3 and #4
+- Incorporate fixes from @robjwells addressing #3 and #4
+- Best menu CLI determination missing modules
+
 ### 2.0.9
 
 2023-04-15 15:44
@@ -34,6 +182,6 @@
 
 - Refactor script as modules and classes
 
-## 2.0.2
+### 2.0.2
 
 Initial release as a gem

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    snibbets (2.0.21)
+    snibbets (2.0.23)
+      mdless (~> 1.0, >= 1.0.32)
+      tty-reader (~> 0.9, >= 0.9.0)
       tty-which (~> 0.5, >= 0.5.0)
 
 GEM
@@ -15,6 +17,7 @@ GEM
     gem-release (2.2.2)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    mdless (1.0.32)
     multi_json (1.15.0)
     parallel (1.22.1)
     parse_gemspec (1.0.0)
@@ -75,8 +78,15 @@ GEM
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
+    tty-cursor (0.7.1)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
     tty-which (0.5.0)
     unicode-display_width (2.4.2)
+    wisper (2.0.1)
     yard (0.9.34)
 
 PLATFORMS

data/README.md

@@ -24,7 +24,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`:
 
@@ -45,13 +45,13 @@ 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.
 
@@ -155,7 +155,7 @@ Snibbet's implementation of Skylighting has limited but better-looking themes, a
 ### Usage
 
 ```
-Snibbets v2.0.21
+Snibbets v2.0.23
 
 Usage: snibbets [options] query
     -a, --all                        If a file contains multiple snippets, output all of them (no menu)
@@ -172,6 +172,7 @@ Usage: snibbets [options] query
         --save                       Save the current command line options to the YAML configuration
     -h, --help                       Display this screen
     -v, --version                    Display version information
+        --changes                    Display the changelog (release notes)
 ```
 
 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.

data/bin/snibbets

@@ -8,6 +8,21 @@ module Snibbets
   class << self
     attr_reader :query
 
+    def display_changelog
+      changelog = File.expand_path(File.join(__dir__, '..', 'CHANGELOG.md'))
+      pagers = [
+        'mdless',
+        'mdcat -p',
+        'bat',
+        ENV['PAGER'],
+        'less -FXr',
+        ENV['GIT_PAGER'],
+        'more -r'
+      ]
+      pager = pagers.find { |cmd| TTY::Which.exist?(cmd.split.first) }
+      system %(#{TTY::Which.which(pager)} "#{changelog}")
+    end
+
     def run
       options = Snibbets.options
       arguments = Snibbets.arguments
@@ -81,6 +96,11 @@ module Snibbets
           puts "Snibbets v#{VERSION}"
           Process.exit 0
         end
+
+        opts.on('--changes', 'Display the changelog (release notes)') do
+          display_changelog
+          Process.exit 0
+        end
       end
 
       optparse.parse!

data/buildnotes.md

@@ -8,7 +8,11 @@ project: snibbets
 
 A plain text snippet manager
 
-## Test
+## Develop
+
+@run(subl .)
+
+## Dummy
 
 @run(bundle exec bin/snibbets $@)
 
@@ -35,7 +39,3 @@ git push
 @after
 Don't forget to publish the website!
 @end
-
-## Plans
-
-

data/lib/snibbets/version.rb

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

data/lib/snibbets.rb

@@ -8,6 +8,7 @@ require 'shellwords'
 require 'yaml'
 require 'fileutils'
 require 'tty-which'
+require 'tty-reader'
 require 'open3'
 require_relative 'snibbets/version'
 require_relative 'snibbets/config'
@@ -143,36 +144,43 @@ module Snibbets
     end
 
     def new_snippet_from_clipboard
+      return false unless $stdin.isatty
+
       trap('SIGINT') do
         Howzit.console.info "\nCancelled"
         exit!
       end
 
       pb = OS.paste.outdent
+      reader = TTY::Reader.new
 
-      printf 'What does this snippet do? '
-      input = $stdin.gets.chomp
+      # printf 'What does this snippet do? '
+      input = reader.read_line('What does this snippet do? ').strip
+      # input = $stdin.gets.chomp
       title = input unless input.empty?
 
-      printf 'What language(s) does it use (separate with spaces, full names or file extensions will work)? '
-      input = $stdin.gets.chomp
+      # printf 'What language(s) does it use (separate with spaces, full names or file extensions will work)? '
+      input = reader.read_line('What language(s) does it use (separate with spaces, full names or file extensions will work)? ').strip
+      # input = $stdin.gets.chomp
       langs = input.split(/ +/).map(&:strip) unless input.empty?
       exts = langs.map { |lang| Lexers.lang_to_ext(lang) }.delete_if(&:nil?)
       tags = langs.map { |lang| Lexers.ext_to_lang(lang) }.concat(langs).delete_if(&:nil?).sort.uniq
 
       exts = langs if exts.empty?
 
-      filename = "#{title}.#{exts.join('.')}.#{Snibbets.options[:extension]}"
-
-      File.open(File.join(File.expand_path(Snibbets.options[:source]), filename), 'w') do |f|
+      filename = "#{title}#{exts.map { |x| ".#{x}"}.join('')}.#{Snibbets.options[:extension]}"
+      filepath = File.join(File.expand_path(Snibbets.options[:source]), filename)
+      File.open(filepath, 'w') do |f|
         f.puts "tags: #{tags.join(', ')}
 
-    ```
-    #{pb}
-    ```"
+```
+#{pb}
+```"
       end
 
       puts "New snippet written to #{filename}."
+
+      open_snippet_in_editor(filepath) if Snibbets.arguments[:edit_snippet]
     end
 
     def handle_launchbar(results)

data/snibbets.gemspec

@@ -43,4 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov-console", "~> 0.9"
   spec.add_development_dependency "standard", "~> 1.3"
   spec.add_runtime_dependency 'tty-which', '~> 0.5', '>= 0.5.0'
+  spec.add_runtime_dependency('tty-reader', '~> 0.9', '>= 0.9.0')
+  spec.add_runtime_dependency('mdless', '~> 1.0', '>= 1.0.32')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snibbets
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.0.23
 platform: ruby
 authors:
 - Brett Terpstra
@@ -190,6 +190,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: tty-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: mdless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.32
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.32
 description: A plain text code snippet manager
 email: me@brettterpstra.com
 executables:
@@ -199,7 +239,6 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
-- CHANGELOG.md.orig
 - Gemfile
 - Gemfile.lock
 - Gemfile.lock.orig

data/CHANGELOG.md.orig

@@ -1,168 +0,0 @@
-### 2.0.21
-
-2023-04-16 09:04
-
-#### IMPROVED
-
-- Use leading and trailing hashes to make snippet titles more obvious when outputting All Snippets
-
-### 2.0.20
-
-2023-04-16 08:31
-
-#### FIXED
-
-- Fail to include skylighting themes in gem bundle
-- Failure to recognize fenced code blocks with language specifiers containing hyphens
-
-### 2.0.19
-
-2023-04-16 08:05
-
-#### FIXED
-
-- A fenced code block following a line containing only 4+ spaces or tabs would get parsed as an indented code block
-- Last fenced code block in a snippet might not be recognized
-
-### 2.0.18
-
-2023-04-16 06:57
-
-#### FIXED
-
-- If an invalid language (without a lexer) is supplied when using `--paste`, just use the input as the extension and tag
-
-### 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
-
-#### FIXED
-
-- Remove debugging output
-
-### 2.0.15
-
-2023-04-15 22:11
-
-#### NEW
-
-- Additional themes for skylighting: nord, monokai, solarized-light/dark
-
-#### FIXED
-
-- Bad path to highlighter themes for skylighting
-
-### 2.0.14
-
-2023-04-15 21:21
-
-#### IMPROVED
-
-- Better default themes for highlighters
-
-#### FIXED
-
-- Error with lexers_db when using higlighting
-
-### 2.0.13
-
-2023-04-15 19:57
-
-#### NEW
-
-- Option to include blockquotes (>) in output
-
-### 2.0.12
-
-2023-04-15 19:28
-
-#### FIXED
-
-- Lowered minimum ruby version to allow Ruby 2.6
-- Failure to recognize snippet if title is on first line of file
-- Errantly discarding first snippet in file with multiple snippets
-
-### 2.0.11
-
-2023-04-15 19:06
-
-#### FIXED
-
-- Overactive stripping of newlines within code blocks
-- Syntax definition determination when adding new snippets
-
-### 2.0.10
-
-2023-04-15 16:28
-
-#### FIXED
-
-- Update dependencies for security
-- Incorporate fixes from @robjwells addressing #3 and #4
-- Incorporate fixes from @robjwells addressing #3 and #4
-- Best menu CLI determination missing modules
-
-<<<<<<< HEAD
-### 2.0.7
-
-2023-04-15 12:02
-=======
-### 2.0.9
-
-2023-04-15 15:44
-
-#### IMPROVED
-
-- Allow setting `menus` config key to force Snibbets to use fzf, gum, or console menus
-- Allow setting `menus` config key to force Snibbets to use fzf, gum, or console menus
-
-#### FIXED
-
-- If a header section contains no code blocks, don't display it in menu
-- Remove leading and trailing newlines without affecting indentation
-
-### 2.0.8
-
-2023-04-15 15:41
-
-#### IMPROVED
-
-- Allow setting `menus` config key to force Snibbets to use fzf, gum, or console menus
-- Allow setting `menus` config key to force Snibbets to use fzf, gum, or console menus
-
-#### FIXED
-
-- If a header section contains no code blocks, don't display it in menu
-- Remove leading and trailing newlines without affecting indentation
->>>>>>> release/2.0.9
-
-### 2.0.6
-
-2023-04-15 11:55
-
-#### IMPROVED
-
-- Refactor script as modules and classes
-
-## 2.0.2
-
-Initial release as a gem