Skip to content

vim-scripts/Licenses

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a mirror of http://www.vim.org/scripts/script.php?script_id=4871

This plugin provides commands to insert licenses at the top of the buffer.
If the license is already at the top of the buffer, nothing is added.
This plugin works for the most popular programming languages, including
C, Java, Objective-C, C++, C#, PHP, Python, JavaScript, Ruby, Perl, Asm and Haskell.
The HTML and CSS languages are also supported.
It may work for other languages.

There are currently more than 10 licenses, and you can add your own.
To do so, copy the license text in ~/.vim/licenses/licenseFile.txt.
Then add a command for this license:

    command! License call InsertLicense('licenseFile')

If your license file contains a <year> tag, it will be automatically
replaced by the current year.

And the <name of author> tag will be automatically replaced by the the
content of the g:licenses_authors_name variable (if not empty), so that
your name will be automatically added to the license.
Thus, you may want to add such a line to you .vimrc:

let g:licenses_authors_name = 'Last Name, First Name <my@email.com>'

If you do not want this plugin to create all these commands, you may
restrict to the licenses you want by using the g:licenses_default_commands
option. For instance, to have this plugin add only a command for the GNU GPL,
Mit and Foobar licenses, use this:

let g:licenses_default_commands = ['gpl', 'mit', 'foobar']

Commands:
:Affero
    Add the GNU Affero license to the buffer.

:Apache
    Add the Apache License 2.0 to the buffer.

:Bsd2
    Add the BSD 2-Clause "New" or "Revised" license to the buffer.

:Bsd3
    Add the BSD 3-Clause "Simplified" or "FreeBSD" license to the buffer.

:Epl
    Add the Eclipse Public License to the buffer.

:Gfdl
    Add the GNU Free Documentation License (FDL) to the buffer.

:Gpl
    Add the GNU General Public License (GPL) version 3.0 to the buffer.

:Gplv2
    Add the GNU General Public License (GPL) version 2.0 to the buffer.

:Lgpl
    Add the GNU "Lesser" General Public License (LGPL) license to the buffer.

:Mit
    Add the MIT license to the buffer.

:Mpl
    Add the Mozilla Public License 2.0 to the buffer.

:Unlicense
    Add the Unlicense to the buffer.

:Wtfpl
    Add the Do What The Fuck You Want To Public License (WTFPL) to the buffer.

:Zlib
    Add the Zlib License to the buffer.

Settings:

The g:licenses_authors_name option

The name of author to automatically insert in the buffer in the licence.

The g:licenses_default_commands option

Choose what commands to create for the listed licenses.

Git repository:

https://github.com/antoyo/vim-licenses

About

Provides commands to add licenses at the top of the buffer

Resources

License

Stars

Watchers

Forks

Packages

No packages published