Licenses : Provides commands to add licenses at the top of the buffer
| script karma
Downloaded by 493
Comments, bugs, improvements
|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
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.
The <name of copyright holder> tag will be automatically replaced by the
content of the g:licenses_copyright_holders_name variable (if not empty), so that
the copyright holder's name will be automatically added to the license.
Thus, you may want to add such a line to you .vimrc:
let g:licenses_copyright_holders_name = 'Last Name, First Name <firstname.lastname@example.org>'
And the <name of author> tag will be replaced by the content of the
g:licenses_authors_name variable (if not empty).
This way you can autocomplete the license template with, for example, the company
you work for as the copyright holder, and you as the author. Or you can set
yourself as the copyright holder, and thus your name will be next to the year.
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']
Add the GNU Affero license to the buffer.
Add the Apache License 2.0 to the buffer.
Add the BSD 2-Clause "New" or "Revised" license to the buffer.
Add the BSD 3-Clause "Simplified" or "FreeBSD" license to the buffer.
Add the Eclipse Public License to the buffer.
Add the GNU Free Documentation License (FDL) to the buffer.
Add the GNU General Public License (GPL) version 3.0 to the buffer.
Add the GNU General Public License (GPL) version 2.0 to the buffer.
Add the GNU "Lesser" General Public License (LGPL) license to the buffer.
Add the MIT license to the buffer.
Add the Mozilla Public License 2.0 to the buffer.
Add the Unlicense to the buffer.
Add the Do What The Fuck You Want To Public License (WTFPL) to the buffer.
Add the Zlib License to the buffer.
The g:licenses_copyright_holders_name option
The name of the copyright holder to automatically insert in the buffer in the license.
The g:licenses_authors_name option
The author name to automatically insert in the buffer in the license.
The g:licenses_default_commands option
Choose what commands to create for the listed licenses.
|1. Download the licenses.zip file and unzip the files to the $HOME/.vim directory. After this step,
you should have the following files and directories (the directory structure should be preserved):
doc/licenses.txt - documentation (help) file
licenses/ - licenses directory
plugin/licenses.vim - main licenses plugin file
test/test_insert_license.vim - The plugin unit tests
LICENSE - The licenses plugin license
2. Change to the $HOME/.vim/doc directory, start Vim and run the ":helptags ." command
to process the licenses help file. Without this step, you cannot jump to the licenses help topics.
3. Restart Vim.
4. You can now use one of the commands above to add a license to the buffer. You can
use the ":help licenses" command to get more information about using the licenses plugin.
Rating scripts is only available on the
script versions (upload new version)
Click on the package to download.
ip used for rating: 188.8.131.52
||This version breaks backward compatibility!
Please update your configuration according to the documentation.
Added new licenses.
Removed trailing spaces in the inserted licenses.
Fixed bug to avoid overriding the alternate buffer.
Added copyright holder variable (breaks backward compatibility).
||Added new licenses.
Added an option to specify the default license commands to create.
||Added many new licenses.
Created better comments option parser to support more languages.
Added an option to set the author's name instead of having to manually change the license text files.
The error shown when no <year> tag was in the license text is now hidden.
Added unit tests.
||Added support for Windows.