athar-qadri/scratchpad.nvim

github

note-taking

5

0

1

0

CREATED

2024-12-31

UPDATED

14 days ago

---

scratchpad.nvim

scratchpad.nvim is a customizable and feature-rich Neovim plugin for managing and synchronizing scratchpad data. It provides a flexible configuration system, intuitive UI, and reliable data storage to streamline your development workflow.

What makes scratchpad.nvim stand out?

• Floating Windows: Scratchpads open in floating windows, eliminating the need for additional splits or buffers.
• Push Data Seamlessly: Push text from the current buffer (selected text or current line) directly to the scratchpad without opening it.
• Automatic Filename Management: Scratchpad filenames are handled internally, so you can focus on more important things.

https://github.com/user-attachments/assets/eddde5de-0fe7-42c2-b868-a682229f2c67

• Features
• Installation
• Usage
• Configuration
• Contributing
• License
• Acknowledgments

Features

• Customizable Configurations: Easily extend and merge default configurations to suit your needs.
• Data Synchronization: Automatically save and sync scratchpad data with robust error handling.
• Project Root Detection: Supports a wide range of project identifiers for seamless integration.

Installation

• neovim 0.8.0+ required
• install using your favorite plugin manager (i am using lazy in this case)

Using lazy.nvim

{
  "athar-qadri/scratchpad.nvim",
  event = "VeryLazy",
  dependencies = { "nvim-lua/plenary.nvim" }, -- don't forget to add this one if you don't have it yet!
  config = function()
    require("scratchpad"):setup()
  end,
}

Using packer.nvim

use {
  "athar-qadri/scratchpad.nvim",
  requires = { "nvim-lua/plenary.nvim" },
  config = function()
    require("scratchpad"):setup()
  end,
}

Usage

Setup

Initialize scratchpad.nvim with default settings or provide a custom configuration.

local scratchpad = require("scratchpad")

-- Default setup
scratchpad:setup()
--or
-- Custom setup
scratchpad:setup({
  settings = {
    sync_on_ui_close = true,
    title = "My Scratch Pad"
  },
  default = {
  --here you specify project root identifiers (Cargo.toml, package.json, blah-blah-blah)
  --or let your man do the job
    root_patterns = { ".git", "package.json", "README.md" },
  },
})

Keymap Configuration

You can set up custom key mappings for enhanced functionality. Below is an example keymap configuration:

{
  keys = {
    {
      "<Leader>es",
      function()
        local scratchpad = require("scratchpad")
        scratchpad.ui:new_scratchpad()
      end,
      desc = "open scratchpad",
    },
  },
}

Easy Setup Using Lazy

return {
  "athar-qadri/scratchpad.nvim",
  event = "VeryLazy",
  opts = {},
  dependencies = {
    "nvim-lua/plenary.nvim",
  },
  config = function()
    local scratchpad = require("scratchpad")
    scratchpad:setup({ settings = { sync_on_ui_close = true } })
  end,
  keys = {
    {
      "<Leader>es",
      function()
        local scratchpad = require("scratchpad")
        scratchpad.ui:new_scratchpad()
      end,
      desc = "show scratch pad",
    
      vim.keymap.set({ "n", "v" }, "<leader>ps", function()
        local scratchpad = require("scratchpad")
        scratchpad.ui:sync()
      end, { desc = "Push selection / current line to scratchpad" }),
    },
  },
}

Run the command :Scratch to open Scratchpad for your current project.

You can also directly push the data - text selection (visual mode) or current line (normal mode) to your scratchpad by pressing <leader>ps using above configuration.

Example Workflow

1. Initialize a Scratchpad: The plugin detects your project root and initializes a scratchpad associated with the directory. If no project root is found, your current working directory will be consider for a unique scratchpad.

2. Synchronize Data: Changes to the scratchpad are saved automatically based on your configuration. Your cursor position in scratchpad is saved even after the closing the ui.

3. Customize Behavior: Modify setting sync_on_ui_close to control how data is managed.

Configuration

Below is a detailed breakdown of the configuration options available:

ScratchpadConfig

Refer to config.lua for more detailed options and comments.

Contributing

We welcome contributions! Feel free to submit issues or pull requests to improve the plugin.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

• Built with ❤️ using Lua and Neovim.
• Inspired by Harpoon.