Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgilad/vim-skeletons
Quickly scaffold template files in your favorite editor using UltiSnips templates
https://github.com/pgilad/vim-skeletons
generator productivity script skeletons vim vim-plugin vimscript
Last synced: 15 days ago
JSON representation
Quickly scaffold template files in your favorite editor using UltiSnips templates
- Host: GitHub
- URL: https://github.com/pgilad/vim-skeletons
- Owner: pgilad
- License: mit
- Created: 2014-05-30T08:26:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-01-18T14:04:15.000Z (almost 4 years ago)
- Last Synced: 2024-10-04T19:43:25.323Z (about 1 month ago)
- Topics: generator, productivity, script, skeletons, vim, vim-plugin, vimscript
- Language: Vim script
- Size: 34.2 KB
- Stars: 28
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vim-skeletons
> Quickly scaffold template files in your favorite editor using UltiSnips templates
## Intro
This project is based on [skeletons.vim](https://github.com/tobyS/skeletons.vim) and expanded
from it.
The idea is to scaffold skeleton files when creating new files with vim, but add the power of
snippets generating using UltiSnips.
For any information on the snippets engine see [UltiSnips](https://github.com/SirVer/ultisnips)
## Installation
This plugin follows the standard runtime path structure, and can be installed with a variety of plugin managers:
#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
`NeoBundle 'pgilad/vim-skeletons'`
#### [Pathogen](https://github.com/tpope/vim-pathogen)
`git clone https://github.com/pgilad/vim-skeletons ~/.vim/bundle/vim-skeletons`
#### [Vundle](https://github.com/gmarik/vundle)
`Plugin 'pgilad/vim-skeletons'`
#### [VAM](https://github.com/MarcWeber/vim-addon-manager)
`call vam#ActivateAddons([ 'vim-skeletons' ])`
#### Manual
copy all of the files into your `~/.vim` directory
## Usage
`vim-skeletons` is shipped with sample skeletons, thus you will need to either add your
own skeletons or add a skeleton repository.
**PRs for example skeletons will be happily accepted**
To activate `vim-skeletons` you can use `:SkeletonsOn`. Or just set in your `.vimrc`:
```vim
let skeletons#autoRegister = 1
```
You can change the skeletons directory:
```vim
let skeletons#skeletonsDir += "~/.dotfiles/vim/skeletons"
```
## Skeletons
### Loading and Filetypes
Skeletons are loaded from `skeletons#skeletonsDir`. They follow the following pattern:
`skeleton-name..`, for example:
- `skeleton.js` for Javascript files.
- `skeleton.angular.js` for Angular.js Javascript files.
- `skeleton.backbone.js` for Backbone.js Javascript files.
- `skeleton.jquery.js` for Jquery Javascript files.
You can also have multiple skeletons for a filetype, and when you open a new file `vim-skeletons` will ask you which
skeleton you want to use for that filetype, the default being the file without the extra field. In our examples `skeleton.js`.
### Skeleton Details
A skeleton can be:
- A blank file
- A file with any text in it
- An `UltiSnips` template
After creating a new file, `vim-skeleton` will interpolate the skeleton using the `UltiSnips` engine,
thus allowing you to set defaults, use snippet structure and anything else you can think of.
An example skeleton `skeleton.php` is included:
```php