Remove "TODO" section from status buffer

Author: CKolkey

README.md

@@ -291,10 +291,6 @@ neogit.setup {
       folded = true,
       hidden = false,
     },
-    todo = {
-      folded = true,
-      hidden = false,
-    },
   },
   mappings = {
     commit_editor = {

doc/neogit.txt

@@ -1835,15 +1835,6 @@ Untracked Files                                 *neogit_status_buffer_untracked*
   untracked files entirely, "normal" to show files and directories (default),
   or "all" to show all files in all directories.
 
-TODOs                                               *neogit_status_buffer_todos*
-  Requires `ripgrep` and `sort` to be available on your system. By default,
-  finds all TODO notes in the codebase matching:
-  - " TODO: "
-  - " NOTE: "
-  - " FIXME: "
-  - " HACK: "
-
-  Can be configured to find other/different keywords.
 ==============================================================================
 Editor Buffer                                             *neogit_editor_buffer*
 

lua/neogit/buffers/status/ui.lua

@@ -478,36 +478,6 @@ local BisectDetailsSection = Component.new(function(props)
   })
 end)
 
-local SectionItemTodo = Component.new(function(item)
-  local function present_item(item)
-    return row({
-      text.highlight(item.highlight)(item.kind),
-      text(" "),
-      text(item.message),
-    }, {
-      yankable = ("%s:%d"):format(item.path, item.line),
-      item = {
-        goto_path = item.path,
-        goto_cursor = { item.line, item.column },
-      },
-    })
-  end
-
-  local grouped_items = map(item, present_item)
-  table.insert(
-    grouped_items,
-    1,
-    row {
-      text(item[1].path),
-      text.highlight("NeogitObjectId")(" ("),
-      text.highlight("NeogitObjectId")(#item),
-      text.highlight("NeogitObjectId")(")")
-    }
-  )
-
-  return col.tag("Section")(grouped_items, { foldable = true, folded = true })
-end)
-
 function M.Status(state, config)
   -- stylua: ignore start
   local show_hint = not config.disable_hint
@@ -567,9 +537,6 @@ function M.Status(state, config)
   local show_recent = #state.recent.items > 0
     and not config.sections.recent.hidden
 
-  local show_todos = vim.fn.executable("rg") == 1
-    and not config.sections.todo.hidden
-
   return {
     List {
       items = {
@@ -767,38 +734,6 @@ function M.Status(state, config)
           folded = config.sections.unpulled_pushRemote.folded,
           name = "pushRemote_unpulled",
         },
-        Section {
-          visible = show_todos,
-          title = SectionTitle { title = "TODOs", highlight = "NeogitRecentcommits" },
-          render = SectionItemTodo,
-          folded = true,
-          name = "todos_plugin",
-          items = function()
-            local Collection = require("neogit.lib.collection")
-
-            local kinds = table.concat(vim.tbl_keys(config.sections.todo.keywords), "|")
-            local items = vim.system(
-              { "rg", " (" .. kinds .. "): ", "--vimgrep", "--sortr=path" },
-              { text = true }
-            ):wait()
-
-            items = filter_map(vim.split(items.stdout, "\n"), function(line)
-              local path, linenr, column, kind, msg = line:match("^([^:]+):(%d+):(%d+):.- (%w+): (.+)$")
-              if path then
-                return {
-                  path = path,
-                  line = linenr,
-                  column = column,
-                  message = msg,
-                  kind = kind,
-                  highlight = config.sections.todo.keywords[kind]
-                }
-              end
-            end)
-
-            return Collection.new(items):group_by("path")
-          end
-        }
       },
     },
   }

lua/neogit/config.lua

@@ -120,11 +120,6 @@ end
 ---@field folded boolean Whether or not this section should be open or closed by default
 ---@field hidden boolean Whether or not this section should be shown
 
----@class NeogitTodoConfigSection A section to show in the Neogit Status buffer, e.g. Staged/Unstaged/Untracked
----@field folded boolean Whether or not this section should be open or closed by default
----@field hidden boolean Whether or not this section should be shown
----@field keywords { [string]: string } Dictionary of keywords to search for (key) and the highlight to apply (value)
-
 ---@class NeogitConfigSections
 ---@field untracked NeogitConfigSection|nil
 ---@field unstaged NeogitConfigSection|nil
@@ -138,7 +133,6 @@ end
 ---@field rebase NeogitConfigSection|nil
 ---@field sequencer NeogitConfigSection|nil
 ---@field bisect NeogitConfigSection|nil
----@field todo NeogitTodoConfigSection|nil
 
 ---@class HighlightOptions
 ---@field italic?     boolean
@@ -520,16 +514,6 @@ function M.get_default_values()
         folded = true,
         hidden = false,
       },
-      todo = {
-        folded = true,
-        hidden = false,
-        keywords = {
-          ["TODO"] = "NeogitGraphBoldBlue",
-          ["NOTE"] = "NeogitGraphBoldGreen",
-          ["FIXME"] = "NeogitGraphBoldRed",
-          ["HACK"] = "NeogitGraphBoldOrange",
-        },
-      },
     },
     ignored_settings = {
       "NeogitPushPopup--force-with-lease",
@@ -810,10 +794,6 @@ function M.validate_config()
       validate_type(section, "section." .. section_name, "table")
       validate_type(section.folded, string.format("section.%s.folded", section_name), "boolean")
       validate_type(section.hidden, string.format("section.%s.hidden", section_name), "boolean")
-
-      if section_name == "todo" then
-        validate_type(section.keywords, "section.todo.keywords", "table")
-      end
     end
   end
 
@@ -1234,10 +1214,6 @@ function M.setup(opts)
     end
   end
 
-  if opts.sections.todo and type(opts.sections.todo.keywords) == "table" then
-    M.values.sections.todo.keywords = opts.sections.todo.keywords
-  end
-
   M.values = vim.tbl_deep_extend("force", M.values, opts)
 
   local config_errs = M.validate_config()