esqueleto.nvim

Reduce your boilerplate code the lazy-bones way.

What is `esqueleto`?

esqueleto.nvim is a minimal plugin that intends to make the use of templates or "skeletons" as easy and straightfoward as possible. This package adds a prompt for inserting an specific template when creating a new file that matches an specific file name or pattern.

Installation

Install esqueleto.nvim with your preferred package manager:

vim-plug

# Stable
Plug 'cvigilv/esqueleto.nvim'

# Development (lastest)
Plug 'cvigilv/esqueleto.nvim', { 'branch': 'develop'}

packer

-- Stable
use 'cvigilv/esqueleto.nvim'

-- Development (lastest)
use { 'cvigilv/esqueleto.nvim', branch = "develop" }

Usage & configuration

In order to configure esqueleto.nvim and use it, the following should be present in your init.lua:

require("esqueleto").setup(
    {
      -- Directory where templates are stored
      directory = "~/.config/nvim/skeletons/",

      -- Patterns to match when creating new file
      -- Can be either (i) file names or (ii) file types.
      -- Exact file name match have priority
      patterns = { "README.md", "python" }
    }
)

For more information, refer to docs (:h esqueleto). For example skeleton files, check the the skeletons folder.

Roadmap

esqueleto.nvim is in its infancy (therefore, expect breaking changes from time to time). I intend on extending this plugin with some functionality I would like for a template manager. At some point esqueleto.nvim should have the following (ordered by priority):

Template creation interface
Handle multiple template folders
Proyect specific templates
Template preview via Telescope
User customizable prompt and insertion rules

Contributing

Pull requests are welcomed for improvement of tool and community templates. Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Please open an issue for support. upport.