A RSS/Atom feed reader in Neovim. It aims to be fully compatible with the database schema of newsboat, so migration can be done seamlessly.

1. Extending newsboat is a pain. Everything has to be set to 'browser' before it can be executed.
2. Keymaps cannot be bound to custom functions. Only Macros can call user defined scripts and I don't want to press an extra key just to invoke that.
3. There is no visual mode in newsboat.
4. Vim movements are more comfortable.
5. Because you can.

• I'm using the latest stable version (whatever that may be at the time of you reading this). So development will always be done on that.
• Offers a more versatile UI than newsboat.
• Plugin implements a special mode for viewing and managing feeds and articles.

• Backend of the plugin
• Handles formatting and display logic
• Interacts with the database to fetch/update the required information

• Store the feed data in the same format as newsboat
• Can be used interchangeably between these two programs

• Configures Neovim to function as a feed/article selector
• Creates a special mode with slightly different keymaps
• Colorscheme is based on treesitter nodes

• Default reload script for standard RSS feeds
• Caches recent requests
• Makes updates to the database

{
    "EinYakAmNil/Nvimboat",
    build = function()
        local nvimboat_go_path = vim.fn.stdpath("data") .. "/lazy/Nvimboat/go"
        vim.fn.jobstart("go build -C " .. nvimboat_go_path)
    end
},

nvimboat.godir = runtime_path .. "go/"
nvimboat.cachedir = runtime_path .. "cache/"
nvimboat.cachetime = 600
nvimboat.dbpath = nvimboat.cachedir .. "cache.db"
nvimboat.log = runtime_path .. "nvimboat.log"
nvimboat.separator = " | "
nvimboat.reloader = runtime_path .. "python/reloader.py"

• Feeds can be tagged to put them into categories and mark them for filters
• A feed needs to have all the tags defined in a filter to be shown
• Putting an exclamation mark in front of a tag can be used to exclude any feed that has been tagged by that

local nvimboat = require("nvimboat")

nvimboat.setup({
    urls = {
        {
            rssurl = "https://www.youtube.com/feeds/videos.xml?user=Harry101UK",
            tags = { "YouTube", "Animation" },
        },
        { rssurl = "https://www.archlinux.org/feeds/news/", tags = { "Tech" } },
        { rssurl = "https://suckless.org/atom.xml", tags = { "Tech" } },
        {
            rssurl = "https://twitter.com/DoctorLalve",
            tags = { "YouTube", "Animation" },
            reloader = "/path/to/custom/reloader" -- Custom reloaders can be defined
        },
    },
    filters = {
        {
           name = "New YouTube tech videos, but not music",
           query = "unread = 1",
           tags = { "YouTube", "Tech", "!Music" },
        },
        {
           name = "New Music",
           query = "unread = 1",
           tags = { "Music" },
        },
    -- These values don't have to be configured, but they can be.
    db = 'path/to/database'
    separator = " | " -- separator for UI, changing it will break treesitter
    cache_dir = "path/to/xml/cache"
    cache_time = 1200 -- time for which cache is valid
})

To start use the command: Nvimboat enable or use the included nvimboat.desktop file. When in Nvimboat mode remaps are done for the local buffer. Disabling Nvimboat mode should restore any custom configuration.

Keymaps:

• l selects an item, while h goes back to the last page. The pages are stored in the Go plugin as a sort of stack.
• n shows or puts the cursor on the next unread feed/article. N/p does it for the previous one. TODO: implement periodic behaviour, maybe with a ring buffer?
• t shows all the tags similar to newsboat and let's you select them to view all feeds of a specific tag.
• While inside an article J and K can be used to show the next/previous article in the feed/filter. TODO: Show first article of next feed when reaching the end of one feed.
• o in normal and visual mode: will attempt to play selected articles when mpv is installed. TODO: Make it more general, but maybe a link handler shouldn't be part of this project.
• q goes back to the main menu.
• R updates all the feeds. TODO: rework state tracking in neovim so individual feed reload can be done.

When reloading, the plugin first sorts the feeds by their reloader an then passes all the URLs of each reloader as a long line of arguments. This should be taken into account when making custom scripts.

You can just copy your old newsboat database into the cache directory of the installation path. If you use lazy.nvim it should look something like $HOME/.local/share/nvim/lazy/Nvimboat/cache.

Please feel free to give me any feedback you have about this plugin. It is the first project I made that is somewhat intended to be usable by other people.