Header

This vim plugin is use to add header in development files.

For now, the supported language are :

• Awk
• Bash
• C
• C++ (cpp)
• DockerFile (Docker)
• Lex (works with Flex)
• Makefile
• Pentadactyl (firefox extension)
• Python
• Vimscript
• Yacc (works with Bison)

Installation

For the installation, you can use Pathogen by tpope or Vundle by gmarik

Pathogen

# with Pathogen (describe with classic utilization of Pathogen)
# if 'bundle' repo desn't exist
$ mkdir ~/.vim/bundle
# global installation
$ cd ~/.vim/bundle
$ git clone https://github.com/thmsaurel/header

Vundle

" Add to your vimrc
Plugin 'thmsaurel/header'

Configuration

Basic

For the script functionment, you have to had your name in your vimrc

let g:header_author = "Thomas Aurel"

If you use docker and you want create dockerfile you have to put your name and the default docker container

let g:header_docker_maintainer = "beargeek <thms.aurel@gmail.com>"
let g:header_docker_base = "centos:centos7"

Note:

By default for the default docker container, centos:centos7 is used.

Advanced

You can add many other options (but add can't guarantee the running script)

" you can your own language in the script lists
let g:header_types = ['vim', 'c', 'sh', 'make']

" you can add your own header in for the language 
" (be careful you have to create the header selection)
let g:header_file = my_file

If you want to add your own file with this current template, this is a example, for Vimscript :

" description
" " TITLE "
"
" File Name         :
" Created By        :
" Creation Date     :
" Version           : 0.1
" Last Change       :
" Last Changed By   :
"

This is the main main header for the script:

• File Name : the current file name
• Created By : the file author
• Creation Date : the file creation date
• Last Change : the file last modification date
• Last Change By : the file last modification author

For each file you have to had this line on the top

:insert

you have to put your file into the headers repo in this purpose and modify the g:header_types in your Vimrc

Links

A syntax for headers file is available in another plugin.

License

Header by Thomas Aurel is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.