https://github.com/gennaro-tedesco/boilit

create boilerplate structure for neovim plugins
https://github.com/gennaro-tedesco/boilit

neovim

Last synced: 3 months ago
JSON representation

create boilerplate structure for neovim plugins

• Host: GitHub
• URL: https://github.com/gennaro-tedesco/boilit
• Owner: gennaro-tedesco
• License: apache-2.0
• Created: 2021-04-12T23:19:32.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-22T08:42:22.000Z (about 2 years ago)
• Last Synced: 2024-07-31T20:51:56.684Z (6 months ago)
• Topics: neovim
• Language: Go
• Homepage:
• Size: 68.4 KB
• Stars: 71
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - gennaro-tedesco/boilit - Create boilerplate structure plugins. (External / Boilerplate)

README

        


  boilit





  

    

  

  

    

  

  

    

  



Boil yourself a sweet plugin



  Installation •

  Usage



Ain't nobody got time to create plugin directories: `boilit` yourself! `boilit` creates boilerplate directory structure and code files for neovim plugins; although there is no unique way to do so, we create a reasonable tree structure useful for most use cases, so that you can build on it.

## Installation

Go get it!

```

go install github.com/gennaro-tedesco/boilit@latest

```

## Usage

All you have to do is thinking of an awesome name for your plugin: once you have it

```

boilit nvim-awesome-plugin

```

creates a plugin boilerplate structure as

```

.

├── autoload

│  └── health

│     └── nvim-awesome-plugin.vim

├── doc

│  ├── nvim-awesome-plugin.txt

│  └── tags

├── lua

│  └── nvim-awesome-plugin

│     ├── config.lua

│     ├── init.lua

│     └── main.lua

├── plugin

│  ├── nvim-awesome-plugin.vim

│  └── reload.vim

└── README.md

```

Watch it in action:

[![asciicast](https://asciinema.org/a/VpggIG2YeksuuryIHFmVATX43.svg)](https://asciinema.org/a/VpggIG2YeksuuryIHFmVATX43)

The plugin skeleton is created by default in the user's current directory: you can specify a custom location via the `-p` flag

```

boilit nvim-awesome-plugin -p ~/custom/path

```

Check the help `boilit -h` for further details.

Batteries included:

- headers and description of what goes in what file

- relative imports of lua modules

- a useful `reload.vim` function to reload your changes without having to exit and reload neovim

- healthcheck template to appear in `:checkhealth`

If your plugin name contains special characters or escape sequences, they _may_ generate exceptions in some of the template functions: make sure to escape the escapable in case.

## Feedback

If you find this application useful consider awarding it a ⭐, it is a great way to give feedback! Otherwise, any additional suggestions or merge request is warmly welcome!