Initial commit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Arijit Basu
+
+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.

README.md

@@ -0,0 +1,52 @@
+# xplr plugin template
+
+Use this template to [write your own xplr plugin](https://arijitbasu.in/xplr/en/writing-plugins.html).
+
+> **NOTE:** The `src` directory is a symlink to `.` for compatibility reasons.
+> It may be removed in the future.
+
+## Requirements
+
+- Some tool
+
+## Installation
+
+### Install manually
+
+- Add the following line in `~/.config/xplr/init.lua`
+
+  ```lua
+  local home = os.getenv("HOME")
+  package.path = home
+    .. "/.config/xplr/plugins/?/src/init.lua;"
+    .. home
+    .. "/.config/xplr/plugins/?.lua;"
+    .. package.path
+  ```
+
+- Clone the plugin
+
+  ```bash
+  mkdir -p ~/.config/xplr/plugins
+
+  git clone https://github.com/{username}/{plugin}.xplr ~/.config/xplr/plugins/{plugin}
+  ```
+
+- Require the module in `~/.config/xplr/init.lua`
+
+  ```lua
+  require("{plugin}").setup()
+
+  -- Or
+
+  require("{plugin}").setup{
+    mode = "action",
+    key = ":",
+  }
+
+  -- Type `::` and enjoy.
+  ```
+
+## Features
+
+- Some cool feature

init.lua

@@ -0,0 +1,13 @@
+---@diagnostic disable
+local xplr = xplr
+---@diagnostic enable
+
+local util = require("plugin-template1.lib.util")
+
+local function setup(args)
+  print(util.dump(args))
+  print(util.dump(xplr))
+  io.read()
+end
+
+return { setup = setup }

lib/util.lua

@@ -0,0 +1,16 @@
+local function dump(o)
+  if type(o) == "table" then
+    local s = "{ "
+    for k, v in pairs(o) do
+      if type(k) ~= "number" then
+        k = '"' .. k .. '"'
+      end
+      s = s .. "[" .. k .. "] = " .. dump(v) .. ","
+    end
+    return s .. "} "
+  else
+    return tostring(o)
+  end
+end
+
+return { dump = dump }

src

@@ -0,0 +1 @@
+.