telescope-frecency.nvim/README.md

telescope-frecency.nvim

An implementation of Mozillas Frecency algorithm for telescope.nvim.

Frecency: sorting by "frequency" and "recency."

Frecency is a score given to each file loaded into a Neovim buffer. The score is calculated by combining the timestamps recorded on each load and how recent the timestamps are:

score  = frequency * recency_score / number_of_timestamps

WIP

TODO

• Implement sorter based on frecency score
• Check file entries are valid via async job on VimClose

Requirements

• telescope.nvim (required)
• sql.nvim (required)

Timestamps and file records are stored in an SQLite3 database for persistence and speed. This plugin uses sql.nvim to perform the database transactions.

Installation

TODO:

use {
  "sunjon/telescope-frecency",
  config = function()
    require"telescope".load_extension("frecency")
  end
}

Configuration

Function for keymaps

lua require("telescope").extensions.frecency.frecency(opts)

:Telescope frecency