create boilerplate structure for neovim plugins

Related tags

Command Line boilit
Overview

boilit

PR Go releases

Boil yourself a sweet plugin

InstallationUsage

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 get -u -v github.com/gennaro-tedesco/boilit

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

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!

Issues
  • Add an autoload/checkhealth ?

    Add an autoload/checkhealth ?

    checkhealth is a neat feature that can tremendously help debugging what goes wrong.

    I think all but the smallest plugins have something to check, be it only that they're up to date (something that's not trivial to do in vimscript/lua) but sometimes that an external dependency is installed or a ressource is present.

    opened by michaelb 14
  • Problem on running

    Problem on running

    There is some problem on running boilit after installation.

    boilit nvim-awesome-plugin
    

    after installation i cannot execute the command below:

    boilit nvim-awesome-plugin
    
    opened by mthnglac 4
  • Error with GO download command

    Error with GO download command

    Hi,

    This is a nice project that I would like to use. I am running into errors when I try to run the go get command.

    I have no experience with GO.

    go version
    go version go1.10.4 linux/amd64
    
    go get -u -v github.com/gennaro-tedesco/boilit
    github.com/gennaro-tedesco/boilit (download)
    github.com/spf13/cobra (download)
    github.com/spf13/pflag (download)
    github.com/spf13/cobra
    # github.com/spf13/cobra
    go/src/github.com/spf13/cobra/bash_completions.go:22:24: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:383:26: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:425:24: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:437:27: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:475:25: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:486:20: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:501:38: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:529:21: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:566:28: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:591:29: undefined: io.StringWriter
    go/src/github.com/spf13/cobra/bash_completions.go:591:29: too many errors
    
    opened by derekthecool 2
Releases(v.1.1.0)
Owner
Gennaro Tedesco
Theoretical physicist and data scientist
Gennaro Tedesco
A command tool to help user install oh-my-zsh plugins fast in a comfortable way

zshx A command tool to help user install oh-my-zsh plugins fast in a comfortable way. in other way, it is a zsh plugin package manager. How to use the

xylon 6 Feb 11, 2022
go program that installs and customizes ohmyzsh tmux vim via various plugins and other nice to haves

Pimp-My-Shell Table of Contents Pimp-My-Shell Install Usage About Resources Tmux Hotkeys VIM Hotkeys Adjusting Custom Aliases Mac Fix Terminal bind ke

null 6 Jun 8, 2022
Node is where client will send data to, create block send to miner, create block send to parent and receive tick from validator and do validate

Node Receive Tick from validator Validate POH of tick send result to validator Receive confirm block from validator Send Checked block to validator Ho

Hieu Phan 0 Dec 31, 2021
An easy to use menu structure for cli applications that prompts users to make choices.

WMenu Package wmenu creates menus for cli programs. It uses wlog for its interface with the command line. It uses os.Stdin, os.Stdout, and os.Stderr w

Will Dixon 165 Jun 30, 2022
A command line utility for generating language-specific project structure.

hydra hydra is a command line utility for generating language-specific project structures. ⏬ ✨ Features Build project templates with just one command

Shravan 18 Oct 8, 2021
:zap: boilerplate template manager that generates files or directories from template repositories

Boilr Are you doing the same steps over and over again every time you start a new programming project? Boilr is here to help you create projects from

Tamer Tas 1.5k Jul 2, 2022
A tool to manage all your boilerplate from cli and generate files for you !

A tool to manage all your boilerplate from cli and generate files for you !

null 27 May 22, 2022
Onion-Layer-Golang - A web application boilerplate built with go and clean architecture

go-clean-architecture-web-application-boilerplate A web application boilerplate

Endy Gigih Pratama 1 May 4, 2022
Softsuite - Start from gofiber boilerplate and plan to build large projects

Softsuite Thanks to Cozy (ItsCosmas) to build gofiber boilerplate. I start learn

Mai 4 Apr 25, 2022
Strumt is a library to create prompt chain

Strumt Strumt is a library to create prompt chain. It provides multiline prompt, input validation, retry on error, ability to create typesafe prompt,

Anthony HAMON 46 May 7, 2022
Commandline Utility To Create Secure Password Hashes (scrypt / bcrypt / pbkdf2)

passhash Create Secure Password Hashes with different algorithms. I/O format is base64 conforming to RFC 4648 (also known as url safe base64 encoding)

Michael Gebetsroither 14 Jan 22, 2021
Small, fast library to create ANSI colored strings and codes. [go, golang]

ansi Package ansi is a small, fast library to create ANSI colored strings and codes. Install Get it go get -u github.com/mgutz/ansi Example import "gi

Mario Gutierrez 363 May 25, 2022
A CLI tool that you can use create regular backups of your Notion.so Pages.

notion-offliner A CLI tool that you can use create regular backups of your Notion.so Pages. Perfect for disaster scenarios and offline usage. MacOS an

Ned McClain 10 Apr 18, 2022
A shell tool to create counting semaphores, acquire them and release them.

A shell tool to create counting semaphores, acquire them and release them. This is useful if you want to e.g. run no more than N out of M commands in parallel.

Antoine Grondin 2 Oct 12, 2021
Create new commands from your shell history or terminal.

overdub Create new commands from your shell history or terminal. TODO list for initial release Filter out unlikely commands (e.g. package managers) fr

Michael Zalimeni 5 Oct 14, 2021
✨ Create a new production-ready project with backend, frontend and deploy automation by running one CLI command!

✨ Create a new production-ready project with backend, frontend and deploy automation by running one CLI command!

Create Go App 1.4k Jul 1, 2022
A command-line to create a pull request to review the entire content of a Github repository.

Pull Request Me Pull Request Me (PRMe) creates a pull request for the entire content of a Github repository. This is useful to solicit review comments

Ivan Fetch 3 Nov 2, 2021
GitHub CLI extension to create and revoke installation tokens

GitHub CLI extension to create and revoke installation tokens.

Carlsberg 1 Nov 22, 2021