Merge pull request #58 from jghauser/move-to-pathlib

Remove plenary.nvim

Author: jghauser

README.md

@@ -73,59 +73,69 @@ To run, papis.nvim requires the [yq](https://github.com/mikefarah/yq) utility to
 
 You'll need the [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) plugin if you intend to use the completion module.
 
-### Package managers
+### Neovim package managers
 
-With rocks.nvim:
+In addition to the below snippets, make sure to also install the *treesitter yaml parser* if you intend to use the completion module.
+
+<details>
+  <summary>rocks.nvim configuration</summary>
 
 ```vim
 :Rocks install papis.nvim
 ```
 
-With packer:
+</details>
+
+<details>
+  <summary>lazy.nvim configuration</summary>
 
 ```lua
-use({
+{
   "jghauser/papis.nvim",
-  after = { "telescope.nvim", "nvim-cmp" },
-  requires = {
+  dependencies = {
     "kkharji/sqlite.lua",
-    "nvim-lua/plenary.nvim",
+	  "pysan3/pathlib.nvim"
     "MunifTanjim/nui.nvim",
   },
   config = function()
-    require("papis").setup(
+    require("papis").setup({
     -- Your configuration goes here
-    )
+    })
   end,
-})
+}
 ```
 
-With lazy.nvim:
+</details>
+
+<details>
+  <summary>packer configuration</summary>
 
 ```lua
-{
+use({
   "jghauser/papis.nvim",
-  dependencies = {
+  after = { "telescope.nvim", "nvim-cmp" },
+  requires = {
     "kkharji/sqlite.lua",
-    "nvim-lua/plenary.nvim",
+	  "pysan3/pathlib.nvim"
     "MunifTanjim/nui.nvim",
   },
   config = function()
-    require("papis").setup({
+    require("papis").setup(
     -- Your configuration goes here
-    })
+    )
   end,
-}
+})
 ```
 
-Additional dependencies:
-
-- *treesitter yaml parser*: Required by the completion module.
+</details>
 
 ### Nix
 
 The `flake.nix` provides an overlay that can be used to install `papis.nvim`. With `home-manager`, this can be achieved with something along the following lines:
 
+<details>
+  <summary>Nix configuration</summary>
+
 ```nix
 {
   inputs = {
@@ -158,6 +168,8 @@ The `flake.nix` provides an overlay that can be used to install `papis.nvim`. Wi
 }
 ```
 
+</details>
+
 ## Setup
 
 Papis.nvim exposes a rather large number of configuration options, most of which can be left alone -- and quite a few of which probably *should* be left alone (or not, if you're feeling brave). Currently, papis.nvim doesn't check whether you've managed to set incompatible options, and weird failures will likely occur in such instances.
@@ -398,12 +410,9 @@ init_filetypes = { "markdown", "norg", "yaml" },
 -- Configuration of logging.
 log = {
 
-  -- What levels to log (`off` to disable). Debug mode is more conveniently
+  -- What levels to log. Debug mode is more conveniently
   -- enabled in `enable_modules`.
-  level = "off",
-
-  -- How to format log strings.
-  notify_format = "%s",
+  level = "info",
 },
 ```
 

doc/papis.txt

@@ -1,4 +1,4 @@
-*papis.txt*              For NVIM v0.8.0             Last change: 2024 June 03
+*papis.txt*              For NVIM v0.8.0             Last change: 2024 June 04
 
 ==============================================================================
 Table of Contents                                    *papis-table-of-contents*
@@ -134,62 +134,63 @@ You’ll need the nvim-cmp <https://github.com/hrsh7th/nvim-cmp> plugin if you
 intend to use the completion module.
 
 
-PACKAGE MANAGERS ~
+NEOVIM PACKAGE MANAGERS ~
 
-With rocks.nvim:
+In addition to the below snippets, make sure to also install the _treesitter
+yaml parser_ if you intend to use the completion module.
+
+rocks.nvim configuration ~
 
 >vim
     :Rocks install papis.nvim
 <
 
-With packer:
+lazy.nvim configuration ~
 
 >lua
-    use({
+    {
       "jghauser/papis.nvim",
-      after = { "telescope.nvim", "nvim-cmp" },
-      requires = {
+      dependencies = {
         "kkharji/sqlite.lua",
-        "nvim-lua/plenary.nvim",
+          "pysan3/pathlib.nvim"
         "MunifTanjim/nui.nvim",
       },
       config = function()
-        require("papis").setup(
+        require("papis").setup({
         -- Your configuration goes here
-        )
+        })
       end,
-    })
+    }
 <
 
-With lazy.nvim:
+packer configuration ~
 
 >lua
-    {
+    use({
       "jghauser/papis.nvim",
-      dependencies = {
+      after = { "telescope.nvim", "nvim-cmp" },
+      requires = {
         "kkharji/sqlite.lua",
-        "nvim-lua/plenary.nvim",
+          "pysan3/pathlib.nvim"
         "MunifTanjim/nui.nvim",
       },
       config = function()
-        require("papis").setup({
+        require("papis").setup(
         -- Your configuration goes here
-        })
+        )
       end,
-    }
+    })
 <
 
-Additional dependencies:
-
-- _treesitter yaml parser_: Required by the completion module.
-
 
 NIX ~
 
 The `flake.nix` provides an overlay that can be used to install `papis.nvim`.
 With `home-manager`, this can be achieved with something along the following
 lines:
 
+Nix configuration ~
+
 >nix
     {
       inputs = {
@@ -466,12 +467,9 @@ All configuration options (with defaults) ~
     -- Configuration of logging.
     log = {
 
-      -- What levels to log (`off` to disable). Debug mode is more conveniently
+      -- What levels to log. Debug mode is more conveniently
       -- enabled in `enable_modules`.
-      level = "off",
-    
-      -- How to format log strings.
-      notify_format = "%s",
+      level = "info",
     },
 <