telescope-software-licenses.nvim's Introduction

telescope-software-licenses.nvim

This telescope.nvim extension allows you to view common software licenses and paste them into a buffer.

Currently supports the following licenses:

Requirements

Neovim (v0.6.0)
telescope.nvim (required)
Only tested on MacOS 11.6.1

Install

You can install the extension by using your plugin manager of choice or by cloning this repository somewhere on your filepath, and then adding the following somewhere after telescope in your configuration file (init.vim or init.lua).

Using Paq

require "paq" {
  "nvim-lua/plenary.nvim";
  "nvim-telescope/telescope.nvim";
  "chip/telescope-software-licenses.nvim";
}
require("telescope").load_extension("software-licenses");

Using packer.nvim

use "nvim-lua/plenary.nvim"
use "nvim-telescope/telescope.nvim"
use "chip/telescope-software-licenses.nvim"
require("telescope").load_extension("software-licenses")

Setup

Commands

" Prompts user for Github user/repo
" Prompts for file argument, but uses README.md as default
:Telescope software-licenses find

Bind to Keys:

" Replace <Leader>sl with whatever you prefer
nnoremap <Leader>sl :Telescope software-licenses find<CR>

Development

$ git clone [email protected]:chip/telescope-software-licenses.nvim.git
$ cd telescope-software-licenses.nvim/lua/telescope/_extensions

See plugin/dev.vim for details.

telescope-software-licenses.nvim's People

Contributors

Stargazers

Watchers

telescope-software-licenses.nvim's Issues

use external assets

Hi, these plugin is a convenient detail. I think that there is not need use licenses files of these repo. Maybe could be possible to use licenses of these repo or this or maybe according to the OS search in the filesystem, for example in linux there is a set of licenses in /usr/share/licenses/common.

note: Out of topic, but maybe the telescope picker could be simply Telescope licenses or Telescope software-licenses instead of Telescope software-licenses find/healt

Wrong MIT license description in README

This seems like the result of a copy and paste accident, in the README:

Currently supports the following licenses:

MIT: GNU General Public License (GPL)

The link makes sense, however why is MIT license's accompanying text "GNU General Public License (GPL)"?

Feel free to disregard and close the issue if I'm mistaken or misunderstood somehow.

Recommend Projects

chip / telescope-software-licenses.nvim Goto Github PK