kksat / licenses.nvim

NeoVim plugin to add license notices

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

licenses.nvim

A plugin for easily writing license files and inserting license headers.

Setup

First install the plugin with your package manager of choice. Don't know what that is? Check out Paq.

Inside your init.lua file run the following function:

require('licenses').setup({
    copyright_holder = 'your name',
    email = 'example@email.com',
    license = 'your license of choice'
})

For more configuration options and in depth explanation run :help licenses-nvim.Config.

Usage

  • LicenseInsert - insert a license on top of your current buffer
  • LicenseFetch - fetch a license from spdx.org
  • LicenseUpdate - update the date in your copyright notice
  • LicenseWrite - write license text to a file

Documentation

The documentation is in form of a vimdoc file, it contains much more information than this README, check it out by doing :help licenses-nvim.

Issues

About

NeoVim plugin to add license notices

License:Other


Languages

Language:Lua 97.2%Language:Python 2.8%