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

https://github.com/piersolenski/plugin-addict.nvim

For those who just can't help themselves
https://github.com/piersolenski/plugin-addict.nvim

lua neovim neovim-plugin nvim nvim-lua nvim-plugin plugin-manager

Last synced: 5 months ago
JSON representation

For those who just can't help themselves

Awesome Lists containing this project

README

          

# πŸ”Œ plugin-addict.nvim

Ever find yourself constantly adding new plugins to your config? Yeah, me too. That's why I made `plugin-addict.nvim` - a dead simple plugin that does one thing: makes adding new plugins to your config **blazingly fastβ„’**, so you can spend even less time working and more time tweaking your config.

## ✨ Features

- Creates a new plugin config file with one command
- Automatically names and places it in your plugins directory
- Opens it for editing immediately
- That's it. That's the plugin.

https://github.com/user-attachments/assets/b9b1e051-c8eb-4f07-b54f-a5fc3be31ae4

## πŸ”© Installation

### Lazy

```lua
{
"piersolenski/plugin-addict.nvim",
opts = {},
keys = {
{
"n",
function()
require("plugin-addict").new()
end,
desc = "New plugin config",
},
},
}
```

### Packer

```lua
use({
"piersolenski/plugin-addict.nvim",
config = function()
require("plugin-addict").setup()
end,
})
```

## βš™οΈ Configuration

`plugin-addict.nvim` works out of the box with no configuration necessary. If you want to customize the path for your plugins directory, you can use the `setup` function.

Here is the default configuration:

```lua
require("plugin-addict").setup({
-- The path to your plugins directory
plugins_path = vim.fn.stdpath("config") .. "/lua/plugins",
})
```

## πŸš€ Usage

`plugin-addict.nvim` provides a command and Lua function to create new plugin files:

### Lua API

```lua
-- Prompt for plugin name
require("plugin-addict").new()

-- Create plugin with specific name
require("plugin-addict").new("cool-plugin")
```

### Commands

Prompt for plugin name:
`:PluginAddictNew [name]`

Create file directly:
`:PluginAddictNew [name]`

## ❓ FAQ:

**Q: Did this really need to be a plugin?**
A: No. But here we are.

**Q: Why would I use this?**
A: Because you're going to keep adding plugins anyway, might as well make it faster.

**Q: Is this just enabling my addiction?**
A: Yes. You're welcome.

## πŸ€“ About the author

As well as a passionate Vim enthusiast, I am a Full Stack Developer and Technical Lead from London, UK.

Whether it's to discuss a project, talk shop or just say hi, I'd love to hear from you!

- [Website](https://www.piersolenski.com/)
- [CodePen](https://codepen.io/piers)
- [LinkedIn](https://www.linkedin.com/in/piersolenski/)


Buy Me a Coffee at ko-fi.com