Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericrswanny/chkn.nvim
chkn - a persistent neovim scratchpad
https://github.com/ericrswanny/chkn.nvim
neovim neovim-plugin neovim-plugin-lua scratchpad
Last synced: 19 days ago
JSON representation
chkn - a persistent neovim scratchpad
- Host: GitHub
- URL: https://github.com/ericrswanny/chkn.nvim
- Owner: ericrswanny
- License: mit
- Created: 2024-11-27T14:28:59.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-09T16:12:26.000Z (24 days ago)
- Last Synced: 2024-12-09T16:18:59.754Z (24 days ago)
- Topics: neovim, neovim-plugin, neovim-plugin-lua, scratchpad
- Language: Lua
- Homepage:
- Size: 424 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chkn.nvim
🐔 **Scratch smarter, not harder!**
**chkn.nvim** is a Neovim plugin that gives you a cozy little scratchpad to jot down your fleeting thoughts, ideas, and code snippets — right in the middle of your editor. Like a chicken scratching in the dirt, it’s simple, persistent, and always ready to dig up something useful.
## Features
- 🖋️ **Centered Floating Window**: A clean, distraction-free space to scratch out ideas.
- 💾 **Persistent Memory**: Save your scratches automatically—no more lost nuggets of genius!
- ⚡ **LazyVim-Ready**: Easy to install and configure with your LazyVim setup.
- 🐓 **Quick Access**: Open it with a keybind, scratch away, and get back to work.
## Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim):
Add the following to `plugins/chkn.lua`, then run `:Lazy sync` and restart Neovim.
With defualt configuration:
```lua
return {
"ericrswanny/chkn.nvim",
config = function()
require("chkn").setup() -- Use the default configuration
end,
lazy = false,
keys = {
{
"sp",
function()
vim.cmd("silent! ChknToggle")
end,
desc = "Toggle Scratchpad",
},
},
}
```
With custom configuration:
```lua
return {
"ericrswanny/chkn.nvim",
config = function()
require("chkn").setup({
width = 80,
height = 20,
border = "rounded",
persistent = true,
})
end,
lazy = false,
keys = {
{
"sp",
function()
vim.cmd("silent! ChknToggle")
end,
desc = "Toggle Scratchpad",
},
},
}
```
## Development
To get started developing, checkout the project and set the dependency directory to your local dev checkout of the project. And add a plenary dependency to the project.
```lua
return {
-- Use a local development path instead of the GitHub repository
dir = "~/dev/chkn.nvim", -- Replace this with the path to your dev dir
dependencies = { "nvim-lua/plenary.nvim" }, -- plenary for tests
config = function()
require("chkn").setup() -- Use the default
-- Or use this if you would like custom configuration
-- config = function()
-- require("chkn").setup({
-- width = 80,
-- height = 20,
-- border = "rounded",
-- persistent = true,
-- })
end,
lazy = false,
keys = {
{
"sp",
function()
vim.cmd("silent! ChknToggle")
end,
desc = "Toggle Scratchpad",
},
},
}
```
Run tests with `./run_tests.sh`
GitHub actions can be run locally using `act`.
- https://github.com/nektos/act
- `act`
- `act -j test`
ericrswanny