feat(backend): add save_to_disk option (#65)

This can be used to only copy to clipboard

Author: gorillamoe

README.md

@@ -79,9 +79,11 @@ See: [lazy.nvim](https://github.com/folke/lazy.nvim)
 ```lua
 {
   'mistweaverco/snap.nvim',
-  version = 'v1.4.5',
+  version = 'v1.5.0',
+  cmd = "Snap",
   ---@type SnapUserConfig
   opts = {}
+  event = "VeryLazy",
 },
 ```
 
@@ -95,7 +97,7 @@ See: [packer.nvim](https://github.com/wbthomason/packer.nvim)
 ```lua
 use {
   'mistweaverco/snap.nvim',
-  tag = 'v1.4.5',
+  tag = 'v1.5.0',
   config = function()
 
     ---@type SnapUserConfig
@@ -114,7 +116,7 @@ use {
 ```lua
 vim.pack.add({
   src = 'https://github.com/mistweaverco/snap.nvim.git',
-  version = 'v1.4.5',
+  version = 'v1.5.0',
 })
 ---@type SnapUserConfig
 local cfg = {}
@@ -246,7 +248,7 @@ This would then translate to the following `font_settings`:
 ```lua
 return {
   "mistweaverco/snap.nvim",
-  version = 'v1.4.5',
+  version = 'v1.5.0',
   ---@type SnapUserConfig
   opts = {
     template = "linux",
@@ -323,6 +325,17 @@ Optional. Defaults to `nil`.
 Absolute path to a custom handlebars template file.
 If set, this option overrides the `template` option.
 
+### Configure `save_to_disk`
+
+Optional. Defaults to:
+
+```lua
+{
+  image = true,
+  html = true,
+}
+```
+
 ### Configure `copy_to_clipboard`
 
 Optional. Defaults to:
@@ -375,7 +388,7 @@ by running `bun install` in the plugin directory.
 ```lua
 {
   'mistweaverco/snap.nvim',
-  version = 'v1.4.5',
+  version = 'v1.5.0',
   opts = {
     timeout = 5000, -- Timeout for screenshot command in milliseconds
     log_level = "error", -- Log level for debugging (e.g., "trace", "debug", "info", "warn", "error", "off")
@@ -388,6 +401,10 @@ by running `bun install` in the plugin directory.
     },
     output_dir = "$HOME/Pictures/Screenshots", -- Directory to save screenshots
     filename_pattern = "snap.nvim_%t", -- e.g., "snap.nvim_%t" (supports %t for timestamp)
+    save_to_disk = {
+        image = true, -- Whether to save the image to disk
+        html = true, -- Whether to save the HTML to disk
+    },
     copy_to_clipboard = {
         image = true, -- Whether to copy the image to clipboard
         html = true, -- Whether to copy the HTML to clipboard

backend/bun/src/generators/image.ts

@@ -19,7 +19,7 @@ export const ImageGenerator = async (json: JSONObjectImageSuccessRequest): Promi
   // Convert HTML to image using our custom Playwright implementation
   // Pass the executable path explicitly to ensure Playwright uses the bundled browser
   const buffer = await htmlToImage({
-    output: filepath,
+    output: json.data.toDisk.image ? filepath : undefined,
     html: code,
     transparent: json.data.transparent,
     type: json.data.outputImageFormat,

backend/bun/src/generators/rtf.ts

@@ -120,6 +120,9 @@ export const RTFGenerator = async (json: JSONObjectRTFSuccessRequest): Promise<[
 
   const filepath = outputFilepath + ".rtf";
 
-  fs.writeFileSync(filepath, doc, { encoding: "utf-8" });
+  if (json.data.toDisk.rtf) {
+    fs.writeFileSync(filepath, doc, { encoding: "utf-8" });
+  }
+
   return [doc, filepath];
 };

backend/bun/src/index.ts

@@ -106,24 +106,32 @@ const main = async () => {
 
   let bufstr: NodeHTMLToImageBuffer | Buffer | string | null = null;
   let filepath: string = "";
+  let toClipboard: boolean = false;
+  let toDisk: boolean = false;
 
   switch (jsonPayload.data.type) {
     case JSONRequestType.CodeImageGeneration:
       json = jsonPayload as JSONObjectImageSuccessRequest;
+      toClipboard = json.data.toClipboard.image;
+      toDisk = json.data.toDisk.image;
       [bufstr, filepath] = await ImageGenerator(json);
       if (bufstr && json.data.toClipboard.image) {
         Clipboard.write(bufstr, "image/png");
       }
       break;
     case JSONRequestType.CodeHTMLGeneration:
       json = jsonPayload as JSONObjectHTMLSuccessRequest;
-      [bufstr, filepath] = await HTMLGenerator(json, true);
+      toClipboard = json.data.toClipboard.html;
+      toDisk = json.data.toDisk.html;
+      [bufstr, filepath] = await HTMLGenerator(json, json.data.toDisk.html);
       if (bufstr && json.data.toClipboard.html) {
         Clipboard.write(bufstr, "text/html");
       }
       break;
     case JSONRequestType.CodeRTFGeneration:
       json = jsonPayload as JSONObjectRTFSuccessRequest;
+      toClipboard = json.data.toClipboard.rtf;
+      toDisk = json.data.toDisk.rtf;
       [bufstr, filepath] = await RTFGenerator(json);
       if (bufstr && json.data.toClipboard.rtf) {
         Clipboard.write(bufstr, "text/rtf");
@@ -138,9 +146,19 @@ const main = async () => {
       return;
   }
 
+  const message =
+    toClipboard && toDisk
+      ? `Written to clipboard and saved to disk at ${filepath}`
+      : toClipboard
+        ? "Written to clipboard"
+        : toDisk
+          ? `Saved to disk at ${filepath}`
+          : "No output destination specified";
+
   writeJSONToStdout({
     success: true,
     debug: json.debug,
+    message,
     data: {
       ...json.data,
       filepath,

backend/bun/src/types/index.ts

@@ -66,10 +66,14 @@ export interface JSONObjectHTMLSuccessRequest {
     templateFilepath?: string;
     fontSettings: FontSettings;
     additionalTemplateData?: { [key: string]: unknown };
+    toDisk: {
+      image: boolean;
+      html: boolean;
+      rtf: boolean;
+    };
     toClipboard: {
       image: boolean;
       html: boolean;
-      css: boolean;
       rtf: boolean;
     };
     outputDir?: string;
@@ -95,10 +99,14 @@ export interface JSONObjectRTFSuccessRequest {
     templateFilepath?: string;
     fontSettings: FontSettings;
     additionalTemplateData?: { [key: string]: unknown };
+    toDisk: {
+      image: boolean;
+      html: boolean;
+      rtf: boolean;
+    };
     toClipboard: {
       image: boolean;
       html: boolean;
-      css: boolean;
       rtf: boolean;
     };
     outputDir?: string;
@@ -127,10 +135,14 @@ export interface JSONObjectImageSuccessRequest {
     fontSettings: FontSettings;
     templateFilepath?: string;
     additionalTemplateData?: { [key: string]: unknown };
+    toDisk: {
+      image: boolean;
+      html: boolean;
+      rtf: boolean;
+    };
     toClipboard: {
       image: boolean;
       html: boolean;
-      css: boolean;
       rtf: boolean;
     };
     outputDir?: string;
@@ -182,6 +194,7 @@ export interface JSONObjectInstallResponse {
 
 export interface JSONObjectSuccessResponse {
   success: true;
+  message: string;
   debug: boolean;
   context?: unknown;
   data:

lua/snap/config/init.lua

@@ -21,6 +21,10 @@ M.defaults = {
     image = true, -- Whether to copy the image to clipboard
     html = true, -- Whether to copy the HTML to clipboard
   },
+  save_to_disk = {
+    image = true, -- Whether to save the image to disk
+    html = true, -- Whether to save the HTML to disk
+  },
   notify = {
     enabled = true, -- Whether to show notifications
     provider = "notify", -- Notification provider: "notify", "print"

lua/snap/export.lua

@@ -267,8 +267,7 @@ end
 ---Run backend export with given options
 ---@param opts table Export options
 ---@param export_type SnapPayloadType Export type
----@param success_message string Success message format string (with %s for filepath)
-local function run_backend_export(opts, export_type, success_message)
+local function run_backend_export(opts, export_type)
   opts = opts or {}
   local conf = Config.get()
 
@@ -327,7 +326,7 @@ local function run_backend_export(opts, export_type, success_message)
               return
             end
             if res.success then
-              Logger.notify(string.format(success_message, tostring(res.data.filepath)), Logger.LoggerLogLevels.info)
+              Logger.notify(tostring(res.message), Logger.LoggerLogLevels.info)
             else
               print("Backend error when exporting failed: " .. vim.inspect(res))
             end
@@ -385,25 +384,22 @@ end
 ---Export current buffer to RTF
 ---@param opts SnapExportOptions|nil Export options
 function M.rtf_to_clipboard(opts)
-  run_backend_export(opts, types.SnapPayloadType.rtf, "Exported RTF to: %s")
+  opts = opts or {}
+  run_backend_export(opts, types.SnapPayloadType.rtf)
 end
 
 ---Export current buffer to HTML
 ---@param opts SnapExportOptions|nil Export options
 function M.html_to_clipboard(opts)
-  run_backend_export(opts, types.SnapPayloadType.html, "Exported HTML to: %s")
+  opts = opts or {}
+  run_backend_export(opts, types.SnapPayloadType.html)
 end
 
 ---Export current buffer to image
 ---@param opts SnapExportOptions|nil Export options
 function M.image_to_clipboard(opts)
   opts = opts or {}
-  local save_path = M.get_default_save_path()
-  if not save_path then
-    Logger.error("No valid save path found for screenshots. Please set 'output_dir' in config")
-    return
-  end
-  run_backend_export({ range = opts.range }, types.SnapPayloadType.image, "Exported image to: %s")
+  run_backend_export({ range = opts.range }, types.SnapPayloadType.image)
 end
 
 return M

lua/snap/globals/versions/backend.lua

@@ -1 +1 @@
-return "1.4.4"
+return "1.5.0"

lua/snap/globals/versions/plugin.lua

@@ -1 +1 @@
-return "1.4.5"
+return "1.5.0"

lua/snap/payload.lua

@@ -67,8 +67,7 @@ function M.get_backend_payload_from_buf(opts, callback)
   local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
   local hl_map = highlights_map.build_hl_map(bufnr)
 
-  --- @type SnapPayload
-  local tabstop = vim.api.nvim_buf_get_option(bufnr, "tabstop")
+  local tabstop = vim.bo[bufnr].tabstop or 4
 
   local snap_payload = {
     success = true,
@@ -82,13 +81,14 @@ function M.get_backend_payload_from_buf(opts, callback)
         fgColor = default_fg,
       },
       template = user_config.template or "default",
-      toClipboard = user_config.copy_to_clipboard or Config.defaults.copy_to_clipboard,
-      outputDir = user_config.output_dir or Config.defaults.output_dir,
+      toDisk = user_config.save_to_disk,
+      toClipboard = user_config.copy_to_clipboard,
+      outputDir = user_config.output_dir,
       filename = M.get_filename(bufnr),
-      filenamePattern = user_config.filename_pattern or Config.defaults.filename_pattern,
-      fontSettings = user_config.font_settings or Config.defaults.font_settings,
+      filenamePattern = user_config.filename_pattern,
+      fontSettings = user_config.font_settings,
       outputImageFormat = types.SnapImageOutputFormat.png,
-      templateFilepath = user_config.templateFilepath or Config.defaults.templateFilepath,
+      templateFilepath = user_config.templateFilepath,
       transparent = true,
       minWidth = 0,
       type = (opts and opts.type) or types.SnapPayloadType.image,