snibbets 2.0.29 → 2.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c514df1f69038d43d34563cc23735ccb8c3912f407a533d90aeacc5e924c81a5
-  data.tar.gz: bce3c77b30ee7369040fcc3af38801ad0b21a53c5f5ce7d991c4f95ec14a249e
+  metadata.gz: 67e546441d5515f0c3d14e754843bfc3eed76a5129bff75b810c173d3e0161a8
+  data.tar.gz: 1e98fc1fb3326dd21dfb1ccecbf4c4b44b6a0f26df8053fc998fc80dc57428cd
 SHA512:
-  metadata.gz: a41ac5237f863911b9950670073fb6922ebf341e1ad06650e475de18f724028edcb1589b5ffcd50c47ef8f144161ecde58c50761967e6f7a60b66586ac1c2a15
-  data.tar.gz: a8d3281abaa277a56e85d4e5275a68cf825fe3bb13eb5714bc43d186bd1a5ec681cf44fdea35290539fb1005c15d8dde308fe44a47295e3f46a5e4e4541f03be
+  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,96 +1,57 @@
-### 2.0.29
-
-2023-04-18 10:45
-
-#### NEW
+### 2.0.31
 
-- `--nvultra` will open the selected snippet in nvUltra
+2023-04-20 10:20
 
 #### 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
-- Better removal of extra leading/trailing newlines
+- Syntax highlight blocks individually, so multiple languages can exist within one snippet
+- If outputting notes, wrap code in backticks to differentiate
 
 #### FIXED
 
-- Code indentation with `--paste`
-- Nil error when highlighting without extension
-- When detecting indented code blocks, require a blank line (or start of file) before them, to avoid picking up lines within indented lists
-- Selecting 'All snippets' could return blank results in some cases
+- 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.28
+### 2.0.30
 
-2023-04-18 09:18
+2023-04-19 06:44
 
 #### NEW
 
-- `--nvultra` will open the selected snippet in nvUltra
+- Added `--notes` option and accompanying `all_notes` config option to allow display of all notes instead of just code blocks in each snippet
 
 #### IMPROVED
 
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
+- Previously if multiple snippets were output, titles of snippets would go to STDERR so they weren't copied. Now they go to STDOUT as well.
 
-#### FIXED
+### 2.0.29
 
-- Code indentation with `--paste`
-- Nil error when highlighting without extension
-- When detecting indented code blocks, require a blank line (or start of file) before them, to avoid picking up lines within indented lists
+2023-04-18 10:45
 
-### 2.0.27
+#### IMPROVED
 
-2023-04-17 15:54
+- Better removal of extra leading/trailing newlines
 
-#### NEW
+#### FIXED
 
-- `--nvultra` will open the selected snippet in nvUltra
+- Selecting 'All snippets' could return blank results in some cases
 
-#### IMPROVED
+### 2.0.28
 
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
+2023-04-18 09:18
 
 #### FIXED
 
-- Code indentation with `--paste`
-- Nil error when highlighting without extension
+- When detecting indented code blocks, require a blank line (or start of file) before them, to avoid picking up lines within indented lists
 
 ### 2.0.26
 
 2023-04-16 11:18
 
-#### NEW
-
-- `--nvultra` will open the selected snippet in nvUltra
-
-#### IMPROVED
-
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
-
 #### FIXED
 
-- Code indentation with `--paste`
 - Nil error when highlighting without extension
 
-### 2.0.25
-
-2023-04-16 11:09
-
-#### NEW
-
-- `--nvultra` will open the selected snippet in nvUltra
-
-#### IMPROVED
-
-- Use Readline for entering info with `--paste`, allows for better editing experience
-- Allow `--edit` with `--paste` to open the new snippet in your editor immediately
-
-#### FIXED
-
-- Code indentation with `--paste`
-
 ### 2.0.24
 
 2023-04-16 10:49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snibbets (2.0.29)
+    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

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

data/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();
+  }
+}