initial commit

Author: cseickel

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021 cseickel (https://github.com/cseickel) and nvim-neo-tree
+maintaners.
+
+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,50 @@
+# Neo-tree.nvim: Example source
+
+This is just an example of how build a custom source for [Neo-tree](https://github.com/nvim-neo-tree/neo-tree.nvim)
+as an external plugin.
+
+
+## Quickstart
+
+  
+```lua
+use {
+  "nvim-neo-tree/neo-tree.nvim",
+    branch = "v2.x",
+    requires = { 
+      "nvim-lua/plenary.nvim",
+      "kyazdani42/nvim-web-devicons",
+      "MunifTanjim/nui.nvim",
+      "nvim-neo-tree/example-source" -- <-- THIS IS US! Add This line to your existing config.
+    },
+    config = function ()
+      require("neo-tree").setup({
+        sources = {
+            "filesystem",
+            "buffers",
+            "git_status",
+            "example" -- <-- external sources need to be a fully qualified path to the module
+            --"my.name.example" <-- Feel free to add to your folder structure to create a namespace,
+                                 -- The name of the modeul will be the last part, or whatever your module
+                                 -- experts as the `name` field.
+        },
+        example = {
+            -- The config for your source goes here. This is the same as any other source, plus whatever
+            -- special config options you add.
+            --window = {...}
+            --renderers = { ..}
+            --etc
+        },
+      })
+
+      vim.cmd([[nnoremap \ :Neotree reveal<cr>]])
+    end
+}
+```
+
+After installing, run:
+```
+:Neotree example
+```
+
+...to see the example source in all it's glory!

lua/example/commands.lua

@@ -0,0 +1,21 @@
+--This file should contain all commands meant to be used by mappings.
+local cc = require("neo-tree.sources.common.commands")
+
+local vim = vim
+
+local M = {}
+
+M.example_command = function(state)
+  local tree = state.tree
+  local node = tree:get_node()
+  local id = node:get_id()
+  local name = node.name
+  print(string.format("example_command: id=%s, name=%s", id, name))
+end
+
+M.show_debug_info = function(state)
+  print(vim.inspect(state))
+end
+
+cc._add_common_commands(M)
+return M

lua/example/components.lua

@@ -0,0 +1,66 @@
+-- This file contains the built-in components. Each componment is a function
+-- that takes the following arguments:
+--      config: A table containing the configuration provided by the user
+--              when declaring this component in their renderer config.
+--      node:   A NuiNode object for the currently focused node.
+--      state:  The current state of the source providing the items.
+--
+-- The function should return either a table, or a list of tables, each of which
+-- contains the following keys:
+--    text:      The text to display for this item.
+--    highlight: The highlight group to apply to this text.
+
+local highlights = require("neo-tree.ui.highlights")
+local common = require("neo-tree.sources.common.components")
+
+local M = {}
+
+M.custom = function(config, node, state)
+  local text = node.extra.custom_text or ""
+  local highlight = highlights.DIM_TEXT
+  return {
+    text = text .. " ",
+    highlight = highlight,
+  }
+end
+
+M.icon = function(config, node, state)
+  local icon = config.default or " "
+  local padding = config.padding or " "
+  local highlight = config.highlight or highlights.FILE_ICON
+  if node.type == "directory" then
+    highlight = highlights.DIRECTORY_ICON
+    if node:is_expanded() then
+      icon = config.folder_open or "-"
+    else
+      icon = config.folder_closed or "+"
+    end
+  elseif node.type == "file" then
+    local success, web_devicons = pcall(require, "nvim-web-devicons")
+    if success then
+      local devicon, hl = web_devicons.get_icon(node.name, node.ext)
+      icon = devicon or icon
+      highlight = hl or highlight
+    end
+  end
+  return {
+    text = icon .. padding,
+    highlight = highlight,
+  }
+end
+
+M.name = function(config, node, state)
+  local highlight = config.highlight or highlights.FILE_NAME
+  if node.type == "directory" then
+    highlight = highlights.DIRECTORY_NAME
+  end
+  if node:get_depth() == 1 then
+    highlight = highlights.ROOT_NAME
+  end
+  return {
+    text = node.name,
+    highlight = highlight,
+  }
+end
+
+return vim.tbl_deep_extend("force", common, M)

lua/example/init.lua

@@ -0,0 +1,65 @@
+--This file should have all functions that are in the public api and either set
+--or read the state of this source.
+
+local vim = vim
+local renderer = require("neo-tree.ui.renderer")
+local manager = require("neo-tree.sources.manager")
+local events = require("neo-tree.events")
+
+local M = { name = "example" }
+
+---Navigate to the given path.
+---@param path string Path to navigate to. If empty, will navigate to the cwd.
+M.navigate = function(state, path)
+  if path == nil then
+    path = vim.fn.getcwd()
+  end
+  state.path = path
+
+  -- Do something useful here to get items
+  local items = {
+    {
+      id = "1",
+      name = "root",
+      type = "directory",
+      children = {
+        {
+          id = "1.1",
+          name = "child1",
+          type = "directory",
+          children = {
+            {
+              id = "1.1.1",
+              name = "child1.1 (you'll need a custom renderer to display this properly)",
+              type = "custom",
+              extra = { custom_text = "HI!" },
+            },
+            {
+              id = "1.1.2",
+              name = "child1.2",
+              type = "file"
+            },
+          },
+        },
+      },
+    },
+  }
+  renderer.show_nodes(items, state)
+end
+
+---Configures the plugin, should be called before the plugin is used.
+---@param config table Configuration table containing any keys that the user
+--wants to change from the defaults. May be empty to accept default values.
+M.setup = function(config, global_config)
+  -- You most likely want to use this function to subscribe to events
+  if config.use_libuv_file_watcher then
+    manager.subscribe(M.name, {
+      event = events.FS_EVENT,
+      handler = function(args)
+        manager.refresh(M.name)
+      end,
+    })
+  end
+end
+
+return M