Merge branch 'savq:master' into fix1

3 files changed, 38 insertions, 12 deletions

diff --git a/README.md b/README.md
index 13bc098..014349f 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,20 @@ For Windows:
 git clone https://github.com/savq/paq-nvim.git "$env:LOCALAPPDATA\nvim-data\site\pack\paqs\start\paq-nvim"
 ```
 
+## Bootstrapping 
+
+Add the following snippet before your first usage of `paq-nvim` if you want to automatically
+install `paq-nvim`.
+
+```lua
+local fn = vim.fn
+
+local install_path = fn.stdpath('data') .. '/site/pack/paqs/start/paq-nvim'
+
+if fn.empty(fn.glob(install_path)) > 0 then
+  fn.system({'git', 'clone', '--depth=1', 'https://github.com/savq/paq-nvim.git', install_path})
+end
+```
 
 ## Usage
 
diff --git a/doc/paq-nvim.txt b/doc/paq-nvim.txt
index aa18f15..aebe16a 100644
--- a/doc/paq-nvim.txt
+++ b/doc/paq-nvim.txt
@@ -1,4 +1,4 @@
-*paq-nvim.txt*  Package manager for Neovim v0.4.4      Last change: 2021-07-07
+*paq-nvim.txt*  Package manager for Neovim >= v0.4.4.  Last change: 2021-08-13
 *paq-nvim*
 *paq*
 
@@ -13,7 +13,6 @@ CONTENTS                                                        *paq-contents*
   Usage                                                  |paq-usage|
   Functions and Commands                                 |paq-commands|
   Package options                                        |paq-options|
-  Commands                                               |paq-commands|
   Paq directory                                          |paq-dir|
   Paq log                                                |paq-log|
   Troubleshooting                                        |paq-troubleshooting|
@@ -99,13 +98,16 @@ imported as `paq`, the functions are:
 |paq.install|                                                    *paq.install*
                                                                *:PaqInstall*
   Installs all packages listed on your configuration, if a package is already
-  installed, the function ignores it.
+  installed, the function ignores it. If a package has a `run` argument, it'll
+  be executed after a package is installed.
 
 
 |paq.update|                                                      *paq.update*
                                                                 *:PaqUpdate*
   Updates the installed packages listed on your configuration. If a package
   hasn't been installed with |PaqInstall|, the function ignores it.
+  If a package had changes and it has a `run` argument, then the `run`
+  argument will be executed.
 
 
 |paq.clean|                                                        *paq.clean*
@@ -121,6 +123,13 @@ imported as `paq`, the functions are:
   out of order.
 
 
+|paq.run_hooks|                                                *paq.run_hooks*
+                                                              *:PaqRunHooks*
+  Executes all `run` hooks (functions and shell commands). This can be used
+  when a hook fails, to run a hook without a package having changed, or for
+  other debugging purposes.
+
+
 |paq.list|                                                          *paq.list*
                                                                   *:PaqList*
   Lists installed packages as well as packages that were recently removed.
@@ -138,7 +147,7 @@ imported as `paq`, the functions are:
   Deletes the |paq-log| file.
 
 
-|paq.setup|                                                        *paq:setup*
+|paq:setup|                                                        *paq:setup*
 
   Method to configure specific global behavior.  It can take a table with the
   following keys:
@@ -157,7 +166,7 @@ imported as `paq`, the functions are:
 
     Default value: `true`
 
-  Note that unlike most Lua plugins, paq.setup is a method, not a function.
+  Note that unlike most Lua plugins, paq:setup is a method, not a function.
   This allows chaining it with the list of packages without needing to
   bind `"paq"` locally, for example:
 >
diff --git a/lua/paq.lua b/lua/paq.lua
index 73a1489..ac6bab0 100644
--- a/lua/paq.lua
+++ b/lua/paq.lua
@@ -26,7 +26,7 @@ local messages = {
         err = "failed to remove %s",
     },
     hook = {
-        ok = "ran hook for %s (%s)",
+        ok = "ran hook for %s",
         err = "failed to run hook for %s",
     }
 }
@@ -51,7 +51,7 @@ local function report(op, result, name, total)
     local count = cur and string.format("%d/%d", cur, total) or ""
     local msg = messages[op][result]
     local p = result == "err" and print_err or print
-    p(string.format("Paq [%s] " .. msg, count, name, hook))
+    p(string.format("Paq [%s] " .. msg, count, name))
 end
 
 local function call_proc(process, args, cwd, cb)
@@ -61,7 +61,7 @@ local function call_proc(process, args, cwd, cb)
     stderr:open(log)
     handle = uv.spawn(
         process,
-        {args = args, cwd = cwd, stdio = {nil, nil, stderr}},
+        {args=args, cwd=cwd, stdio={nil, nil, stderr}, env={"GIT_TERMINAL_PROMPT=0"}},
         vim.schedule_wrap(function(code)
             uv.fs_close(log)
             stderr:close()
@@ -89,9 +89,9 @@ end
 
 local function install(pkg)
     if pkg.exists then return update_count("install", "nop", nil, num_pkgs) end
-    local args = pkg.branch
-        and {"clone", pkg.url, "--depth=1", "-b", pkg.branch, pkg.dir}
-        or {"clone", pkg.url, "--depth=1", pkg.dir}
+    local args = {"clone", pkg.url, "--depth=1", "--recurse-submodules", "--shallow-submodules"}
+    if pkg.branch then vim.list_extend(args, {"-b", pkg.branch}) end
+    vim.list_extend(args, {pkg.dir})
     local post_install = function(ok)
         if ok then
             pkg.exists = true
@@ -130,7 +130,7 @@ local function update(pkg)
             (cfg.verbose and report or update_count)("update", "nop", pkg.name, num_pkgs) -- blursed
         end
     end
-    call_proc("git", {"pull"}, pkg.dir, post_update)
+    call_proc("git", {"pull", "--recurse-submodules", "--update-shallow"}, pkg.dir, post_update)
 end
 
 local function remove(packdir)
@@ -158,6 +158,7 @@ local function remove(packdir)
     end
 end
 
+
 local function list()
     local installed = vim.tbl_filter(function(name) return packages[name].exists end, vim.tbl_keys(packages))
     local removed = vim.tbl_filter(function(name) return last_ops[name] == "remove" end, vim.tbl_keys(last_ops))
@@ -211,6 +212,7 @@ do
         "command! PaqInstall  lua require('paq'):install()",
         "command! PaqUpdate   lua require('paq'):update()",
         "command! PaqClean    lua require('paq'):clean()",
+        "command! PaqRunHooks lua require('paq'):run_hooks()",
         "command! PaqSync     lua require('paq'):sync()",
         "command! PaqList     lua require('paq').list()",
         "command! PaqLogOpen  lua require('paq').log_open()",
@@ -224,6 +226,7 @@ return setmetatable({
     update = function(self) Counter "update" vim.tbl_map(update, packages) return self end,
     clean = function(self) Counter "remove" remove(cfg.paqdir .. "start/") remove(cfg.paqdir .. "opt/") return self end,
     sync = function(self) self:clean():update():install() return self end,
+    run_hooks = function(self) vim.tbl_map(run_hook, packages) return self end,
     list = list,
     setup = function(self, args) for k,v in pairs(args) do cfg[k] = v end return self end,
     log_open = function(self) vim.cmd("sp " .. LOGFILE) return self end,