Directory filter for todo items

[abhayk]

Hey all ! My notes directory currently looks like this -

├── notes
   ├── personal
   └── work

I have individual notes inside both these directories and most of them contain TODO: items. The command :Trouble todo works fine and it displays all the todos across both directories.

I want to view the todo items in either directory separately i.e with Trouble todo_personal I should see all the todos in the personal directory and with Trouble todo_work I should see all the todos in my work directory.

I tried setting up modes like this -

modes = {
    todo_personal = {
        mode = "todo",
        filter = { dirname = "personal*"}
    },
    todo_work = {
        mode = "todo",
        filter = { dirname = "work*" }
    }
},

I open Neovim at the notes directory and when I run either command it does not find any of the todos.

I tried poking through the code but I'm not entirely sure how to debug the value for dirname at runtime. Any help would be appreciated here. Thanks !

[abhayk]

I figured this out by building on top of some of the examples listed in the filter docs. Basically this works -

todo_personal = {
    mode = "todo",
    filter = function(items)
        return vim.tbl_filter(function(item)
            local sep = package.config:sub(1,1)
            return item.filename:find((vim.loop or vim.uv).cwd() .. sep .. "personal", 1, true)
        end, items)
    end,
},

I have the same function set up for todo_work as well. One pending thing is to define the function only once and have it accept the sub folder as an argument.

But this works for me now. Marking this as resolved.

[abhayk]

The above code works on Macos but not on Windows. The issue seems to be that cwd() returns the path with the OS specific separator. But item.filename is OS agnostic and always returns the path with /.

As a fix replaced all \ with / in the output of cwd(). The function looks like this now -

todo_personal = {
    mode = "todo",
    filter = function(items)
        return vim.tbl_filter(function(item)
            return item.filename:find((vim.loop or vim.uv).cwd():gsub("\\", "/") .. "/personal", 1, true)
        end, items)
    end,

Debugging this was a lot of fun. Basically I've now learned that -

• the plugin code can be modified locally and we can debug them
• we can print statements from the plugin code and they can be viewed via :messages
• we can execute lua code in command mode (for example to check what cwd returns we can run the following lua print(vim.uv.cwd()))