snibbets 2.0.39 → 2.0.40

data/src/_README.md

@@ -97,39 +97,115 @@ output: raw
 source: "~/Dropbox/Snippets"
 ```
 
+| key                 | type    | default    | description                          |
+| ------------------- | ------- | ---------- | ------------------------------------ |
+| source              | string  | \*required | Path to snippet directory            |
+| all                 | boolean | false      | Always display all snippets          |
+| all_notes           | boolean | false      | Show full content, including notes   |
+| copy                | boolean | false      | always copy output to clipboard      |
+| editor              | string  | $EDITOR    | command or app to use with --edit    |
+| extension           | string  | md         | Snippet extension to search          |
+| highlight           | boolean | true       | Syntax highlight code                |
+| highlight_theme     | string  |            | Highlighter theme to use             |
+| highlighter         | string  |            | Can be skylight or pygments          |
+| include_blockquotes | boolean | false      | include blockquotes in output        |
+| interactive         | boolean | true       | display a menu when multiple options |
+| launchbar           | boolean | false      | Output for LaunchBar                 |
+| menus               | string  | fzf        | menu utility: fzf, gum, console      |
+| name_only           | boolean | false      | Always search by filename            |
+| output              | string  | raw        | Output format json, launchbar, raw   |
+[Configuration Options]
+
 #### Snippet Location
 
 Set the `source` key to the folder where you keep your Markdown snippets. Optionally adjust the `extension` setting if you use an extension other than `md` (e.g. `markdown` or `txt`).
 
 #### Other Options
 
-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].
+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 `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.
-
-The `menus` setting will determine what method is used for displaying interactive menus. If this is not set, it will be automatically determined in the order of `fzf`, `gum`, and `console`. You can manually choose to use one of these options over another by making it the `menus` setting.
-
-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.
+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 `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.
+
+The `menus` setting will determine what method is used for
+displaying interactive menus. If this is not set, it will be
+automatically determined in the order of `fzf`, `gum`, and
+`console`. You can manually choose to use one of these
+options over another by making it the `menus` setting.
+
+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.
+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:
 
@@ -142,15 +218,33 @@ To define a snippet as python code, for example:
             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.)
+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.
+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.
+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`.
@@ -165,37 +259,80 @@ Snibbet's implementation of Skylighting has limited but better-looking themes, a
 @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.
+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.
 
 > If you have fzf or gum installed, snibbets will use those for menus, providing fuzzy filtering of options.
 
 #### JSON output
 
-An undocumented output option is `-o json`, which will output all of the matches and their code blocks as a JSON string that can be incorporated into other scripts. It's similar to the `-o launchbar` option, but doesn't contain the extra keys required for the LaunchBar action.
+An undocumented output option is `-o json`, which will
+output all of the matches and their code blocks as a JSON
+string that can be incorporated into other scripts. It's
+similar to the `-o launchbar` option, but doesn't contain
+the extra keys required for the LaunchBar action.
 
 #### Open snippets in your editor
 
-Use the `--edit` flag on any search to open the found snippet file in your editor. Configure your default editor in the config file. `snibbets configure` will open that, but if you don't have an editor set, it might have strange results. To edit manually, open `~/.config/snibbets/snibbets.yml` in your text editor of choice.
+Use the `--edit` flag on any search to open the found
+snippet file in your editor. Configure your default editor
+in the config file. `snibbets configure` will open that, but
+if you don't have an editor set, it might have strange
+results. To edit manually, open
+`~/.config/snibbets/snibbets.yml` in your text editor of
+choice.
 
 #### Creating new snippets
 
 ##### From clipboard
 
-I do most of my snippet editing in [nvUltra], but sometimes I have a function in my clipboard that just needs quick saving and there are so few moving parts to creating a snippet that it just feels like they could be automated/simplified. That's why I added the `--paste` flag. If you have a code snippet in your clipboard, you can just run `snibbets --paste` (or just `-p`) and you'll get a prompt asking you to describe the snippet (used for filename) and one asking what language(s) are represented.
-
-You can input the languages as names, e.g. `rust`, `typescript`, or `scala`, or you can just add file extensions that represent the language. If I say `ts` to that prompt, it will generate an extension of `.ts.md` and then add a metadata tag of `typescript` to the file. The code from the clipboard goes into a fenced code block in the document. You can always go add notes to it later, but it's a great way to save snippets as you come across them (or solutions you figure out after a week of banging your head).
-
-This command requires that a clipboard utility be available. On macOS, you have `pbpaste` by default and don't need to do anything. On Windows and Linux, you'll need to [install either `xclip` or `xsel`][xclip].
+I do most of my snippet editing in [nvUltra], but sometimes
+I have a function in my clipboard that just needs quick
+saving and there are so few moving parts to creating a
+snippet that it just feels like they could be
+automated/simplified. That's why I added the `--paste` flag.
+If you have a code snippet in your clipboard, you can just
+run `snibbets --paste` (or just `-p`) and you'll get a
+prompt asking you to describe the snippet (used for
+filename) and one asking what language(s) are represented.
+
+You can input the languages as names, e.g. `rust`,
+`typescript`, or `scala`, or you can just add file
+extensions that represent the language. If I say `ts` to
+that prompt, it will generate an extension of `.ts.md` and
+then add a metadata tag of `typescript` to the file. The
+code from the clipboard goes into a fenced code block in the
+document. You can always go add notes to it later, but it's
+a great way to save snippets as you come across them (or
+solutions you figure out after a week of banging your head).
+
+This command requires that a clipboard utility be available.
+On macOS, you have `pbpaste` by default and don't need to do
+anything. On Windows and Linux, you'll need to
+[install either `xclip` or `xsel`][xclip].
 
 [nvUltra]: https://nvultra.com "nvUltra for Mac"
 
 ##### With editor
 
-You can also create new snippets by opening a skeleton file in your editor with `--edit-new`. This will prompt for a title and languages, create the new file, and open it in your editor (or in nvUltra with the `--nvultra` flag). If you use `--edit-new-titled TITLE`, the new snippet will get a filename from `TITLE` and languages will be determined from any extension added to the title, or prompted for if none are found.
+You can also create new snippets by opening a skeleton file
+in your editor with `--edit-new`. This will prompt for a
+title and languages, create the new file, and open it in
+your editor (or in nvUltra with the `--nvultra` flag). If
+you use `--edit-new-titled TITLE`, the new snippet will get
+a filename from `TITLE` and languages will be determined
+from any extension added to the title, or prompted for if
+none are found.
 
 #### Saving Settings When Running
 
-Any time you specify things like a source folder with the `--source` flag, or turn on highlighting or name-only search, you can add the flag `--save` to write those to your config and make them the default options.
+Any time you specify things like a source folder with the
+`--source` flag, or turn on highlighting or name-only
+search, you can add the flag `--save` to write those to your
+config and make them the default options.
 
 ## LaunchBar Action
 
@@ -203,9 +340,12 @@ _I'm currently reworking the LaunchBar action, and it doesn't function very well
 
 <!-- ### 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.
+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.
 
-Once installed, run the action (type `snib` and hit return on the result) to select your Snippets folder.
+Once installed, run the action (type `snib` and hit return on the result) to
+select your Snippets folder.
 
 ### Usage
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: snibbets
 version: !ruby/object:Gem::Version
-  version: 2.0.39
+  version: 2.0.40
 platform: ruby
 authors:
 - Brett Terpstra
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2025-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -246,7 +245,6 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - README.rdoc
@@ -266,7 +264,6 @@ 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
@@ -295,6 +292,7 @@ files:
 - lib/themes/solarized-dark.theme
 - lib/themes/solarized-light.theme
 - lib/themes/vim-dark.theme
+- mise.toml
 - scripts/fixreadme.rb
 - snibbets.gemspec
 - src/_README.md
@@ -308,7 +306,6 @@ metadata:
   bug_tracker_uri: https://github.com/ttscoff/snibbets/issues
   changelog_uri: https://github.com/ttscoff/snibbets/blob/main/CHANGELOG.md
   github_repo: git@github.com:ttscoff/snibbets.git
-post_install_message:
 rdoc_options:
 - "--title"
 - snibbets
@@ -330,8 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Snibbets
 test_files: []

data/Gemfile.lock

@@ -1,125 +0,0 @@
-PATH
-  remote: .
-  specs:
-    snibbets (2.0.39)
-      mdless (~> 1.0, >= 1.0.32)
-      tty-reader (~> 0.9, >= 0.9.0)
-      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)
-    lint_roller (1.0.0)
-    mdless (1.0.37)
-    multi_json (1.15.0)
-    parallel (1.23.0)
-    parse_gemspec (1.0.0)
-    parse_gemspec-cli (1.0.0)
-      multi_json
-      parse_gemspec
-      thor
-    parser (3.2.2.3)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rdoc (6.3.4.1)
-    regexp_parser (2.8.1)
-    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.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      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.52.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.3)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.18.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.29.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.52.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.1.0)
-    standard-custom (1.0.1)
-      lint_roller (~> 1.0)
-    standard-performance (1.1.0)
-      lint_roller (~> 1.0)
-      rubocop-performance (~> 1.18.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.2)
-    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.2)
-    tty-which (0.5.0)
-    unicode-display_width (2.4.2)
-    wisper (2.0.1)
-    yard (0.9.36)
-
-PLATFORMS
-  arm64-darwin-20
-  arm64-darwin-21
-  ruby
-  x64-mingw32
-  x86_64-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.4.1)
-  rspec (~> 3.0)
-  simplecov (~> 0.21)
-  simplecov-console (~> 0.9)
-  snibbets!
-  standard (~> 1.3)
-  yard (~> 0.9, >= 0.9.36)
-
-BUNDLED WITH
-   2.2.29

data/lib/snibbets/todo_spec.rb

@@ -1,11 +0,0 @@
-# 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