local Database = require "frecency.database" local EntryMaker = require "frecency.entry_maker" local FS = require "frecency.fs" local Finder = require "frecency.finder" local Picker = require "frecency.picker" local Recency = require "frecency.recency" local WebDevicons = require "frecency.web_devicons" ---@class Frecency ---@field config FrecencyConfig ---@field private buf_registered table flag to indicate the buffer is registered to the database. ---@field private database FrecencyDatabase ---@field private finder FrecencyFinder ---@field private fs FrecencyFS ---@field private picker FrecencyPicker ---@field private recency FrecencyRecency local Frecency = {} ---@class FrecencyConfig ---@field auto_validate boolean? default: true ---@field db_root string? default: vim.fn.stdpath "data" ---@field db_safe_mode boolean? default: true ---@field db_validate_threshold? integer default: 10 ---@field default_workspace string? default: nil ---@field disable_devicons boolean? default: false ---@field filter_delimiter string? default: ":" ---@field ignore_patterns string[]? default: { "*.git/*", "*/tmp/*", "term://*" } ---@field show_filter_column boolean|string[]|nil default: true ---@field show_scores boolean? default: false ---@field show_unindexed boolean? default: true ---@field workspaces table? default: {} ---@param opts FrecencyConfig? ---@return Frecency Frecency.new = function(opts) ---@type FrecencyConfig local config = vim.tbl_extend("force", { auto_validate = true, db_root = vim.fn.stdpath "data", db_safe_mode = true, db_validate_threshold = 10, default_workspace = nil, disable_devicons = false, filter_delimiter = ":", ignore_patterns = { "*.git/*", "*/tmp/*", "term://*" }, show_filter_column = true, show_scores = false, show_unindexed = true, workspaces = {}, }, opts or {}) local self = setmetatable({ buf_registered = {}, config = config }, { __index = Frecency })--[[@as Frecency]] self.fs = FS.new { ignore_patterns = config.ignore_patterns } self.database = Database.new(self.fs, { root = config.db_root }) local web_devicons = WebDevicons.new(not config.disable_devicons) local entry_maker = EntryMaker.new(self.fs, web_devicons, { show_filter_column = config.show_filter_column, show_scores = config.show_scores, }) self.finder = Finder.new(entry_maker, self.fs) self.recency = Recency.new() return self end ---@return nil function Frecency:setup() -- TODO: Should we schedule this after loading shada? if not self.database:has_entry() then self.database:insert_files(vim.v.oldfiles) self:notify("Imported %d entries from oldfiles.", #vim.v.oldfiles) end ---@param cmd_info { bang: boolean } vim.api.nvim_create_user_command("FrecencyValidate", function(cmd_info) self:validate_database(cmd_info.bang) end, { bang = true, desc = "Clean up DB for telescope-frecency" }) if self.config.auto_validate then self:validate_database() end local group = vim.api.nvim_create_augroup("TelescopeFrecency", {}) vim.api.nvim_create_autocmd({ "BufWinEnter", "BufWritePost" }, { desc = "Update database for telescope-frecency", group = group, ---@param args { buf: integer } callback = function(args) self:register(args.buf) end, }) end ---@param opts FrecencyPickerOptions? ---@return nil function Frecency:start(opts) opts = opts or {} self.picker = Picker.new(self.database, self.finder, self.fs, self.recency, { default_workspace_tag = self.config.default_workspace, editing_bufnr = vim.api.nvim_get_current_buf(), filter_delimiter = self.config.filter_delimiter, initial_workspace_tag = opts.workspace, show_unindexed = self.config.show_unindexed, workspaces = self.config.workspaces, }) self.picker:start(opts) end ---@param findstart 1|0 ---@param base string ---@return integer|''|string[] function Frecency:complete(findstart, base) return self.picker:complete(findstart, base) end ---@private ---@param force boolean? ---@return nil function Frecency:validate_database(force) local unlinked = self.database:unlinked_entries() if #unlinked == 0 or (not force and #unlinked < self.config.db_validate_threshold) then return end local function remove_entries() self.database:remove_files(unlinked) self:notify("removed %d missing entries.", #unlinked) end if force and not self.config.db_safe_mode then remove_entries() return end vim.ui.select({ "y", "n" }, { prompt = self:message("remove %d entries from SQLite3 database?", #unlinked), ---@param item "y"|"n" ---@return string format_item = function(item) return item == "y" and "Yes. Remove them." or "No. Do nothing." end, }, function(item) if item == "y" then remove_entries() else self:notify "validation aborted" end end) end ---@private ---@param bufnr integer ---@param datetime string? ISO8601 format string function Frecency:register(bufnr, datetime) local path = vim.api.nvim_buf_get_name(bufnr) if self.buf_registered[bufnr] or not self.fs:is_valid_path(path) then return end local id, inserted = self.database:upsert_files(path) self.database:insert_timestamps(id, datetime) self.database:trim_timestamps(id, self.recency.config.max_count) if inserted and self.picker then self.picker:discard_results() end self.buf_registered[bufnr] = true end ---@private ---@param fmt string ---@param ... any? ---@return string function Frecency:message(fmt, ...) return ("[Telescope-Frecency] " .. fmt):format(unpack { ... }) end ---@private ---@param fmt string ---@param ... any? ---@return nil function Frecency:notify(fmt, ...) vim.notify(self:message(fmt, ...)) end return Frecency