mirror of
https://github.com/kristoferssolo/telescope-frecency.nvim.git
synced 2025-10-21 20:10:38 +00:00
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# telescope-frecency.nvim
|
|
|
|
An implementation of Mozillas [Frecency algorithm](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/Places/Frecency_algorithm) for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
|
|
|
|
## Frecency: sorting by "frequency" and "recency"
|
|
|
|
Frecency is a score given to each unique file loaded into a Neovim buffer.
|
|
On each load a timestamp is recorded to a database. The score is calculated using the age of each of the timestamps and the amount of times the file has been loaded:
|
|
|
|
```
|
|
recency_score =
|
|
timestamp_age 4 hours => value = 100
|
|
timestamp_age day => value = 80
|
|
timestamp_age 3 days => value = 60
|
|
timestamp_age week => value = 40
|
|
timestamp_age month => value = 20
|
|
timestamp_age 90 days => value = 10
|
|
|
|
final_score = frequency * recency_score / max_number_of_timestamps
|
|
|
|
```
|
|
## WIP
|
|
|
|
TODO
|
|
|
|
- [ ] Implement sorter based on frecency score
|
|
- [ ] Check file entries are valid via async job on VimClose
|
|
|
|
|
|
<img src="https://raw.githubusercontent.com/sunjon/images/master/gh_readme_telescope_frecency.png" height="600">
|
|
|
|
## Requirements
|
|
|
|
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) (required)
|
|
- [sql.nvim](https://github.com/tami5/sql.nvim) (required)
|
|
|
|
Timestamps and file records are stored in an [SQLite3](https://www.sqlite.org/index.html) 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
|
|
lua require("telescope").extensions.frecency.frecency(opts)
|
|
```
|
|
|
|
```
|
|
:Telescope frecency
|
|
```
|