https://github.com/shrikecode/skeleton.vim
A simple file templates plugin for Vim and Neovim
https://github.com/shrikecode/skeleton.vim
neovim neovim-plugin skel skeleton templates vim vim-plugin vim-skeleton
Last synced: about 1 month ago
JSON representation
A simple file templates plugin for Vim and Neovim
- Host: GitHub
- URL: https://github.com/shrikecode/skeleton.vim
- Owner: shrikecode
- License: mit
- Created: 2023-04-14T21:37:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-10T01:38:13.000Z (over 2 years ago)
- Last Synced: 2025-02-28T21:07:54.051Z (over 1 year ago)
- Topics: neovim, neovim-plugin, skel, skeleton, templates, vim, vim-plugin, vim-skeleton
- Language: Vim Script
- Homepage: https://lanius.dev
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# skeleton.vim
A dead simple plugin for easy Vim and Neovim file templates.
## Installation
### Vim-plug
```vim
Plug 'shrikecode/skeleton.vim'
```
### Packer
```lua
use 'shrikecode/skeleton.vim'
```
## Usage
Create a file in `~/.vim/templates` with contents you want in a template.
Files are matched by full filename (`my-template.lua`), by file directory
(`file-dir/skel.lua`) or by extension (`skel.lua`).
## Configuration
Below are the possible config values with defaults
```vim
" templates directory
let g:sigma_skeleton_dir = '~/.vim/templates'
" fill an existing empty files
let g:sigma_skeleton_fill = 0
```
```lua
-- templates directory
vim.g.sigma_skeleton_dir = '~/.vim/templates'
-- fill an existing empty files
vim.g.sigma_skeleton_fill = 0
```
## Known issues
With `g:sigma_skeleton_fill = 1`, if a buffer for a file that was deleted is open or an unsaved buffer is open,
it will be filled with matched template every time it is visited. That is likely not an issue that can be handled,
so use this option with care and prepare from some mess from time to time.
## Similar projects / inspirations
- [vim-skeleton](https://github.com/noahfrederick/vim-skeleton)