From 3fb8b9830640ec32210f71462563b0583c4d3b3f Mon Sep 17 00:00:00 2001 From: Chip Castle Date: Sat, 26 Feb 2022 13:31:26 -0600 Subject: [PATCH] Initial commit --- .luarc.json | 5 + LICENSE | 21 ++ Makefile | 4 + README.md | 61 ++++ lua/telescope/_extensions/plugin/dev.vim | 23 ++ .../_extensions/software-licenses/find.lua | 55 +++ .../_extensions/software-licenses/health.lua | 34 ++ .../_extensions/software-licenses/init.lua | 11 + .../software-licenses/licenses.lua | 329 ++++++++++++++++++ .../_extensions/software-licenses/utils.lua | 15 + 10 files changed, 558 insertions(+) create mode 100644 .luarc.json create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 lua/telescope/_extensions/plugin/dev.vim create mode 100644 lua/telescope/_extensions/software-licenses/find.lua create mode 100644 lua/telescope/_extensions/software-licenses/health.lua create mode 100644 lua/telescope/_extensions/software-licenses/init.lua create mode 100644 lua/telescope/_extensions/software-licenses/licenses.lua create mode 100644 lua/telescope/_extensions/software-licenses/utils.lua diff --git a/.luarc.json b/.luarc.json new file mode 100644 index 0000000..b937819 --- /dev/null +++ b/.luarc.json @@ -0,0 +1,5 @@ +{ + "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json", + "Lua.completion.autoRequire": false, + "Lua.workspace.checkThirdParty": false +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a69136c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Chip Castle Dot Com, Inc. - http://chipcastle.com + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ddd4c89 --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +.PHONY: test + +test: + nvim --headless -c "PlenaryBustedDirectory lua/tests/" diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4eac2d --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# telescope-software-licenses.nvim + +![telescope-software-licenses.nvim DEMO](assets/telescope-software-licenses.gif "telescope-software-licenses.nvim DEMO") + +This [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) +extension + +## Requirements + +- Neovim (v0.6.0) +- [telescope.nvim](https://github.com/nvim-telescope/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](https://github.com/savq/paq-nvim) +```lua +require "paq" { + { 'nvim-lua/plenary.nvim' }; + { 'nvim-telescope/telescope.nvim' }; + { "chip/telescope-software-licenses.nvim" }; +} +require('telescope').load_extension('telescope-software-licenses'); +``` + +### Using [packer.nvim](https://github.com/wbthomason/packer.nvim) +```lua +use 'nvim-lua/plenary.nvim' +use 'nvim-telescope/telescope.nvim' +use { "chip/telescope-software-licenses.nvim" } +require('telescope').load_extension('telescope-software-licenses') +``` +## Setup + +### Commands + +```vim +" Prompts user for Github user/repo +" Prompts for file argument, but uses README.md as default +:Telescope telescope-software-licenses list +``` + +### Bind to Keys: + +```vim +" Replace cf with whatever you prefer +nnoremap sl Telescope telescope-software-licenses list +``` + +### Development + +```zsh +$ git clone git@github.com:chip/telescope-software-licenses.nvim.git +$ cd telescope-software-licenses.nvim/lua/telescope/_extensions +$ nvim --cmd "set rtp+=$(pwd)" -u plugin/dev.vim +``` diff --git a/lua/telescope/_extensions/plugin/dev.vim b/lua/telescope/_extensions/plugin/dev.vim new file mode 100644 index 0000000..cb40c71 --- /dev/null +++ b/lua/telescope/_extensions/plugin/dev.vim @@ -0,0 +1,23 @@ +" FOR DEVELOPMENT +" nvim --cmd "set rtp+=$(pwd)" -u lua/telescope/_extensions/plugin/dev.vim +set rtp+=. + +function! ReloadPlugin() +lua << EOF + for k in pairs(package.loaded) do + if k:match("software%-licenses") then + package.loaded[k] = nil + end + end +EOF +endfunction + +" Reload the plugin +nnoremap rp :call ReloadPlugin() +" Test the plugin +nnoremap sl :Telescope software-licenses find + +" Inital load +lua <= 0.6 then + return true + else + return false + end +end + +M.check = function() + health.report_start("Start health check for telescope-software-licenses.nvim") + if vim_installed() then + health.report_ok("nvim version >= 0.6 installed") + else + health.report_error("please install nvim > 0.6") + end + + local packages = {"telescope", "plenary.curl"} + for _, package in pairs(packages) do + local has_package, _ = pcall(require, package) + if has_package then + health.report_ok(string.format("%s is installed", package)) + else + health.report_error(string.format("This plugin requires %s", package)) + end + end +end + +return M diff --git a/lua/telescope/_extensions/software-licenses/init.lua b/lua/telescope/_extensions/software-licenses/init.lua new file mode 100644 index 0000000..54fef68 --- /dev/null +++ b/lua/telescope/_extensions/software-licenses/init.lua @@ -0,0 +1,11 @@ +local has_telescope, telescope = pcall(require, "telescope") +if not has_telescope then + error("This plugin requires nvim-telescope/telescope.nvim") +end + +local find = require("telescope._extensions.software-licenses.find") +local health = require("telescope._extensions.software-licenses.health") +return telescope.register_extension { + setup = function(opts) return opts end, + exports = {find = find.licenses, health = health.check} +} diff --git a/lua/telescope/_extensions/software-licenses/licenses.lua b/lua/telescope/_extensions/software-licenses/licenses.lua new file mode 100644 index 0000000..3f8fd02 --- /dev/null +++ b/lua/telescope/_extensions/software-licenses/licenses.lua @@ -0,0 +1,329 @@ +local M = { + { + name = "agpl-3.0", + text = [[ +Copyright (C) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +]] + }, + { + name = "fdl-1.1", + text = [[ +Copyright (c) YEAR YOUR NAME. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 +or any later version published by the Free Software Foundation; +with the Invariant Sections being LIST THEIR TITLES, with the +Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. +A copy of the license is included in the section entitled "GNU +Free Documentation License". +]] + }, + { + name = "fdl-1.2", + text = [[ +Copyright (c) YEAR YOUR NAME. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.2 +or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU +Free Documentation License". +]] + }, + { + name = "fdl-1.3", + text = [[ +Copyright (c) YEAR YOUR NAME. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 +or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU +Free Documentation License". +]] + }, + { + name = "gpl-1.0", + text = [[ +Copyright (C) 19yy + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 1, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA +]] + }, + { + name = "gpl-2.0", + text = [[ +Copyright (C) + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +]] + }, + { + name = "gpl-3.0", + text = [[ +Copyright (C) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +]] + }, + { + name = "lgpl-2.0", + text = [[ +Copyright (C) + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Library General Public +License as published by the Free Software Foundation; either +version 2 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Library General Public License for more details. + +You should have received a copy of the GNU Library General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +]] + }, + { + name = "lgpl-2.1", + text = [[ +Copyright (C) + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +]] + }, + { + name = "lgpl-3.0", + text = [[ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. +]] + } +} + +return M diff --git a/lua/telescope/_extensions/software-licenses/utils.lua b/lua/telescope/_extensions/software-licenses/utils.lua new file mode 100644 index 0000000..f6e93ab --- /dev/null +++ b/lua/telescope/_extensions/software-licenses/utils.lua @@ -0,0 +1,15 @@ +local M = {} + +M.pp = function(format, s) + local fmt = "\n" .. format .. "\n" + return print(string.format(fmt, vim.inspect(s))) +end +M.format_msg = function(s) + return "[ERROR telescope-software-licenses.nvim] " .. s .. "\n" +end +M.error = function(s) + local msg = M.format_msg(s) + vim.api.nvim_err_writeln(msg) +end + +return M