feat: add sort_case_insensitive option, close #203

Author: cseickel

doc/neo-tree.txt

@@ -361,10 +361,11 @@ wish to remove a default mapping without overriding it with your own function,
 assign it the the string "none". This will cause it to be skipped and allow any
 existing global mappings to work.
 
-Run |NeoTreePasteConfig| to dump the fully commented default config in your
-current file. Even if you don't want to use that config as your starting point,
-you still may want to dump it to a blank .lua file just to read it as
-documentation. SOME OPTIONS ARE ONLY DOCUMENTED IN THE DEFAULT CONFIG!
+NOTE: SOME OPTIONS ARE ONLY DOCUMENTED IN THE DEFAULT CONFIG!~
+Run `:lua require("neo-tree").paste_default_config()` to dump the fully
+commented default config in your current file. Even if you don't want to use
+that config as your starting point, you still may want to dump it to a blank
+lua file just to read it as documentation. 
 
 
 FILTERED ITEMS                                         *neo-tree-filtered-items*

lua/neo-tree/defaults.lua

@@ -11,6 +11,7 @@ local config = {
   enable_git_status = true,
   git_status_async = true,
   open_files_in_last_window = true, -- false = open files in top left window
+  sort_case_insensitive = false, -- used when sorting files and directories in the tree
   log_level = "info", -- "trace", "debug", "info", "warn", "error", "fatal"
   log_to_file = false, -- true, false, "/path/to/file.log", use :NeoTreeLogs to show the file
   --

lua/neo-tree/sources/common/file-items.lua

@@ -12,11 +12,27 @@ local function sort_items(a, b)
   end
 end
 
-local function deep_sort(tbl)
-  table.sort(tbl, sort_items)
+local function sort_items_case_insensitive(a, b)
+  if a.type == b.type then
+    return a.path:lower() < b.path:lower()
+  else
+    return a.type < b.type
+  end
+end
+
+local function deep_sort(tbl, sort_func)
+  if sort_func == nil then
+    local config = require("neo-tree").config
+    if config.sort_case_insensitive then
+      sort_func = sort_items_case_insensitive
+    else
+      sort_func = sort_items
+    end
+  end
+  table.sort(tbl, sort_func)
   for _, item in pairs(tbl) do
     if item.type == "directory" then
-      deep_sort(item.children)
+      deep_sort(item.children, sort_func)
     end
   end
 end