feat!: remove deprecated user commands (#1055)

BREAKING CHANGE: All `NeoTree*` commands have been removed, use `Neotree <args>` instead.

Author: cseickel

README.md

@@ -45,9 +45,6 @@ so we can fix it.
 
 #### Minimal Example for Packer:
 ```lua
--- Unless you are still migrating, remove the deprecated commands from v1.x
-vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
-
 use {
   "nvim-neo-tree/neo-tree.nvim",
     branch = "v2.x",
@@ -103,9 +100,6 @@ use {
       }
     },
     config = function ()
-      -- Unless you are still migrating, remove the deprecated commands from v1.x
-      vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
-
       -- If you want icons for diagnostic errors, you'll need to define them somewhere:
       vim.fn.sign_define("DiagnosticSignError",
         {text = " ", texthl = "DiagnosticSignError"})
@@ -364,56 +358,6 @@ into a buffer after installing Neo-tree by running:
 :lua require("neo-tree").paste_default_config()
 ```
 
-#### Configuration for Nerd Fonts v3 Users
-
-The following configuration should fix broken icons if you are using Nerd Fonts v3:
-
-```lua
-require("neo-tree").setup({
-  default_component_configs = {
-    icon = {
-      folder_empty = "󰜌",
-      folder_empty_open = "󰜌",
-    },
-    git_status = {
-      symbols = {
-        renamed   = "󰁕",
-        unstaged  = "󰄱",
-      },
-    },
-  },
-  document_symbols = {
-    kinds = {
-      File = { icon = "󰈙", hl = "Tag" },
-      Namespace = { icon = "󰌗", hl = "Include" },
-      Package = { icon = "󰏖", hl = "Label" },
-      Class = { icon = "󰌗", hl = "Include" },
-      Property = { icon = "󰆧", hl = "@property" },
-      Enum = { icon = "󰒻", hl = "@number" },
-      Function = { icon = "󰊕", hl = "Function" },
-      String = { icon = "󰀬", hl = "String" },
-      Number = { icon = "󰎠", hl = "Number" },
-      Array = { icon = "󰅪", hl = "Type" },
-      Object = { icon = "󰅩", hl = "Type" },
-      Key = { icon = "󰌋", hl = "" },
-      Struct = { icon = "󰌗", hl = "Type" },
-      Operator = { icon = "󰆕", hl = "Operator" },
-      TypeParameter = { icon = "󰊄", hl = "Type" },
-      StaticMethod = { icon = '󰠄 ', hl = 'Function' },
-    }
-  },
-  -- Add this section only if you've configured source selector.
-  source_selector = {
-    sources = {
-      { source = "filesystem", display_name = " 󰉓 Files " },
-      { source = "buffers", display_name = " 󰈚 Buffers " },
-      { source = "git_status", display_name = " 󰊢 Git " },
-    },
-  },
-  -- Other options ...
-})
-```
-
 ## The `:Neotree` Command
 
 The single `:Neotree` command accepts a range of arguments that give you full
@@ -745,7 +689,7 @@ add any features you can think of through existing hooks in the setup function.
 
 As of v1.30, a breaking change is defined as anything that _changes_ existing:
 
-- vim commands (`:NeoTreeShow`, `:NeoTreeReveal`, etc)
+- vim commands (`:Neotree`)
 - configuration options that are passed into the `setup()` function
 - `NeoTree*` highlight groups
 - lua functions exported in the following modules that are not prefixed with `_`:

lua/neo-tree.lua

@@ -1,165 +1,14 @@
 local vim = vim
 local utils = require("neo-tree.utils")
-local renderer = require("neo-tree.ui.renderer")
 local log = require("neo-tree.log")
-local manager = require("neo-tree.sources.manager")
-local setup = require("neo-tree.setup")
-
--- If you add a new source, you need to add it to the sources table.
--- Each source should have a defaults module that contains the default values
--- for the source config, and a setup function that takes that config.
-local sources = {
-  "filesystem",
-  "buffers",
-  "git_status",
-}
-
 local M = {}
 
-local check_source = function(source_name)
-  if not utils.truthy(source_name) then
-    source_name = M.config.default_source
-  end
-  local success, result = pcall(require, "neo-tree.sources." .. source_name)
-  if not success then
-    error("Source " .. source_name .. " could not be loaded: ", result)
-  end
-  return source_name
-end
-
-local get_position = function(source_name)
-  local pos = utils.get_value(M, "config." .. source_name .. ".window.position", "left", false)
-  return pos
-end
-
 M.ensure_config = function()
   if not M.config then
     M.setup({ log_to_file = false }, true)
   end
 end
 
---DEPRECATED in v2.x
-M.close_all_except = function(source_name)
-  -- this entire function is faulty now that position can be overriden at runtime
-  source_name = check_source(source_name)
-  local target_pos = get_position(source_name)
-  for _, name in ipairs(sources) do
-    if name ~= source_name then
-      local pos = utils.get_value(M, "config." .. name .. ".window.position", "left", false)
-      if pos == target_pos then
-        manager.close(name)
-      end
-    end
-  end
-  renderer.close_all_floating_windows()
-end
-
---DEPRECATED in v2.x
-M.close = manager.close
-
---DEPRECATED in v2.x, use manager.close_all()
-M.close_all = function(at_position)
-  renderer.close_all_floating_windows()
-  if type(at_position) == "string" and at_position > "" then
-    for _, name in ipairs(sources) do
-      local pos = get_position(name)
-      if pos == at_position then
-        manager.close(name)
-      end
-    end
-  else
-    for _, name in ipairs(sources) do
-      manager.close(name)
-    end
-  end
-end
-
---DEPRECATED in v2.x, use commands.execute()
-M.float = function(source_name, toggle_if_open)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if toggle_if_open then
-    if renderer.close_floating_window(source_name) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-  renderer.close_all_floating_windows()
-  manager.close(source_name) -- in case this source is open in a sidebar
-  manager.float(source_name)
-end
-
---DEPRECATED in v2.x, use commands.execute()
-M.focus = function(source_name, close_others, toggle_if_open)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if get_position(source_name) == "current" then
-    M.show_in_split(source_name, toggle_if_open)
-    return
-  end
-
-  if toggle_if_open then
-    if manager.close(source_name) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-  if close_others == nil then
-    close_others = true
-  end
-  if close_others then
-    M.close_all_except(source_name)
-  end
-  manager.focus(source_name)
-end
-
---DEPRECATED in v2.x, use commands.execute()
-M.reveal_current_file = function(source_name, toggle_if_open, force_cwd)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if get_position(source_name) == "current" then
-    M.reveal_in_split(source_name, toggle_if_open)
-    return
-  end
-  if toggle_if_open then
-    if manager.close(source_name) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-  manager.reveal_current_file(source_name, nil, force_cwd)
-end
-
---DEPRECATED in v2.x, use commands.execute()
-M.reveal_in_split = function(source_name, toggle_if_open)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if toggle_if_open then
-    local state = manager.get_state(source_name, nil, vim.api.nvim_get_current_win())
-    if renderer.close(state) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-  --TODO: if we are currently in a sidebar, don't replace it with a split style
-  manager.reveal_in_split(source_name)
-end
-
---DEPRECATED in v2.x, use commands.execute()
-M.show_in_split = function(source_name, toggle_if_open)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if toggle_if_open then
-    local state = manager.get_state(source_name, nil, vim.api.nvim_get_current_win())
-    if renderer.close(state) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-  --TODO: if we are currently in a sidebar, don't replace it with a split style
-  manager.show_in_split(source_name)
-end
-
 M.get_prior_window = function(ignore_filetypes)
   ignore_filetypes = ignore_filetypes or {}
   local ignore = utils.list_to_dict(ignore_filetypes)
@@ -212,31 +61,6 @@ M.paste_default_config = function()
   end)
 end
 
-M.buffer_enter_event = setup.buffer_enter_event
-M.win_enter_event = setup.win_enter_event
-
---DEPRECATED in v2.x
---BREAKING CHANGE: Removed the do_not_focus and close_others options in 2.0
---M.show = function(source_name, do_not_focus, close_others, toggle_if_open)
-M.show = function(source_name, toggle_if_open)
-  M.ensure_config()
-  source_name = check_source(source_name)
-  if get_position(source_name) == "current" then
-    M.show_in_split(source_name, toggle_if_open)
-    return
-  end
-
-  if toggle_if_open then
-    if manager.close(source_name) then
-      -- It was open, and now it's not.
-      return
-    end
-  end
-
-  M.close_all_except(source_name)
-  manager.show(source_name)
-end
-
 M.set_log_level = function(level)
   log.set_level(level)
 end

plugin/neo-tree.vim

@@ -1,28 +1,8 @@
 if exists('g:loaded_neo_tree')
   finish
 endif
-let g:loaded_neo_tree = 1
-
-if !exists('g:neo_tree_remove_legacy_commands')
-    command! -nargs=? NeoTreeClose         lua require("neo-tree").close_all("<args>")
-    command! -nargs=? NeoTreeFloat         lua require("neo-tree").float("<args>")
-    command! -nargs=? NeoTreeFocus         lua require("neo-tree").focus("<args>")
-    command! -nargs=? NeoTreeShow          lua require("neo-tree").show("<args>", true)
-    command! -bang    NeoTreeReveal        lua require("neo-tree").reveal_current_file("filesystem", false, "<bang>" == "!") 
-    command!          NeoTreeRevealInSplit lua require("neo-tree").reveal_in_split("filesystem", false)
-    command!          NeoTreeShowInSplit   lua require("neo-tree").show_in_split("filesystem", false)
-
-    command! -nargs=? NeoTreeFloatToggle   lua require("neo-tree").float("<args>", true)
-    command! -nargs=? NeoTreeFocusToggle   lua require("neo-tree").focus("<args>", true, true)
-    command! -nargs=? NeoTreeShowToggle    lua require("neo-tree").show("<args>", true, true, true)
-    command! -bang    NeoTreeRevealToggle  lua require("neo-tree").reveal_current_file("filesystem", true, "<bang>" == "!")
-    command!    NeoTreeRevealInSplitToggle lua require("neo-tree").reveal_in_split("filesystem", true)
-    command!    NeoTreeShowInSplitToggle   lua require("neo-tree").show_in_split("filesystem", true)
-
-    command!          NeoTreePasteConfig   lua require("neo-tree").paste_default_config()
-    command! -nargs=? NeoTreeSetLogLevel   lua require("neo-tree").set_log_level("<args>")
-    command!          NeoTreeLogs          lua require("neo-tree").show_logs()
-endif
 
 command! -nargs=* -complete=custom,v:lua.require'neo-tree.command'.complete_args
             \ Neotree lua require("neo-tree.command")._command(<f-args>)
+
+let g:loaded_neo_tree = 1