Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/0xJohnnyboy/scretch.nvim

📝 Neovim plugin to manage scratch files !
https://github.com/0xJohnnyboy/scretch.nvim

fzf-lua lua neovim neovim-plugin telescope

Last synced: 7 days ago
JSON representation

📝 Neovim plugin to manage scratch files !

Lists

README 

        
# Introduction



Scretch.nvim is a plugin to easily create and manage scratch files 🙂.



## Features

### New scretch



https://user-images.githubusercontent.com/49813786/235376581-4bc28110-a75f-4b29-bf75-07ae10e5a8a3.mov



### New named scretch



https://user-images.githubusercontent.com/49813786/235376612-328159ff-4209-4bc0-b21d-fcb742861a41.mov



### Search, grep, and explore scretches !



https://user-images.githubusercontent.com/49813786/235376626-6b23bf7e-def1-4d4b-bfa0-ea22e7ba3e61.mov



### Templates



You can save any buffer as a Scretch template. It'll be saved in the default directory if none is explicitely provided in the config.

You can also search and edit templates with Telescope or Fzf-Lua, and create a new Scretch from a template.

See [suggested mappings](#suggested-mappings).



# Installation



This plugin requires Telescope or fzf-lua and ripgrep to function.



If you don't have ripgrep installed, I recommend you go check the installation procedure [here](https://github.com/BurntSushi/ripgrep#installation).

If you don't want to install it, it should fall back to `find`.



You can paste the following code using Packer, or adapt to your favorite package manager:



```lua

use {

  "0xJohnnyboy/scretch.nvim",

  requires = 'nvim-telescope/telescope.nvim',

  -- or

  -- requires = 'ibhagwan/fzf-lua' ,

  config = function()

    require("scretch").setup {

      -- your configuration comes here

      -- or leave it empty to use the default settings

      -- refer to the configuration section below

    }

  end

}

```



# Configuration



Here are the default settings used in Scretch:

```lua

local config = {

    scretch_dir = vim.fn.stdpath('config') .. '/scretch/', -- will be created if it doesn't exist

    templte_dir = vim.fn.stdpath('data') .. '/scretch/templates', -- will be created if it doesn't exist

    default_name = "scretch_",

    default_type = "txt", -- default unnamed Scretches are named "scretch_*.txt"

    split_cmd = "vsplit", -- vim split command used when creating a new Scretch

    backend = "telescope.builtin" -- also accpets "fzf-lua"

}

```

You can copy those settings, update them with your preferences and put them into the setup function to load them.



## Suggested mappings



```lua

local scretch = require("scretch")

vim.keymap.set('n', 'sn', scretch.new)

vim.keymap.set('n', 'snn', scretch.new_named)

vim.keymap.set('n', 'sft', scretch.new_from_template)

vim.keymap.set('n', 'sl', scretch.last)

vim.keymap.set('n', 'ss', scretch.search)

vim.keymap.set('n', 'st', scretch.edit_template)

vim.keymap.set('n', 'sg', scretch.grep)

vim.keymap.set('n', 'sv', scretch.explore)

vim.keymap.set('n', 'sat', scretch.save_as_template)

```



# Issues



Feel free to open issues if you have a suggestion or encounter a bug. Be kind !



# License



AGPL-3.0, see [license file](./LICENSE.md)



# Contributing



Feel free to open up PRs, they should respect the [contribution guidelines](./CONTRIBUTING.md). Be kind !