plugins.telescope.extensions.frecency.settings

settings for the frecency telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  db_root = "/home/my_username/path/to/db_root";
  disable_devicons = false;
  ignore_patterns = [
    "*.git/*"
    "*/tmp/*"
  ];
  show_scores = false;
  show_unindexed = true;
  workspaces = {
    conf = "/home/my_username/.config";
    data = "/home/my_username/.local/share";
    project = "/home/my_username/projects";
    wiki = "/home/my_username/wiki";
  };
}

Declared by:

plugins.telescope.extensions.frecency.settings.auto_validate

If true, it removes stale entries count over than db_validate_threshold.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.frecency.settings.db_root

Path to parent directory of custom database location. Defaults to $XDG_DATA_HOME/nvim if unset.

Type: null or string or raw lua code

Default: null

Plugin default: "{__raw = \"vim.fn.stdpath 'data'\";}"

Declared by:

plugins.telescope.extensions.frecency.settings.db_safe_mode

If true, it shows confirmation dialog by vim.ui.select() before validating DB.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.frecency.settings.db_validate_threshold

It will removes over than this count in validating DB.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 10

Declared by:

plugins.telescope.extensions.frecency.settings.default_workspace

Default workspace tag to filter by e.g. 'CWD' to filter by default to the current directory. Can be overridden at query time by specifying another filter like ':*:'.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.disable_devicons

Disable devicons (if available).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.frecency.settings.filter_delimiter

Delimiters to indicate the filter like :CWD:.

Type: null or string or raw lua code

Default: null

Plugin default: ":"

Declared by:

plugins.telescope.extensions.frecency.settings.hide_current_buffer

If true, it does not show the current buffer in candidates.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.frecency.settings.ignore_patterns

Patterns in this table control which files are indexed (and subsequently which you’ll see in the finder results).

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "*.git/*"
  "*/tmp/*"
  "term://*"
]

Declared by:

plugins.telescope.extensions.frecency.settings.max_timestamps

Set the max count of timestamps DB keeps when you open files. It ignores the value and use 10 if you set less than or equal to 0.

CAUTION: When you reduce the value of this option, it removes old timestamps when you open the file. It is reasonable to set this value more than or equal to the default value: 10.

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Plugin default: 10

Declared by:

plugins.telescope.extensions.frecency.settings.show_filter_column

Show the path of the active filter before file paths. In default, it uses the tail of paths for 'LSP' and 'CWD' tags. You can configure this by setting a table for this option.

Type: null or boolean or list of string

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.frecency.settings.show_scores

To see the scores generated by the algorithm in the results, set this to true.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.frecency.settings.show_unindexed

Determines if non-indexed files are included in workspace filter results.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.frecency.settings.workspace_scan_cmd

This option can be set values as "LUA"|string[]|null. With the default value: null, it uses these way below to make entries for workspace files. It tries in order until it works successfully.

  1. rg -.g '!.git' --files
  2. fdfind -Htf
  3. fd -Htf
  4. Native Lua code (old way)

If you like another commands, set them to this option, like

  workspace_scan_cmd = ["find" "." "-type" "f"];

If you prefer Native Lua code, set workspace_scan_cmd.__raw = "LUA".

Type: null or raw lua code or list of string

Default: null

Declared by:

plugins.telescope.extensions.frecency.settings.workspaces

This attrs contains mappings of workspace_tag -> workspace_directory. The key corresponds to the :tag_name used to select the filter in queries. The value corresponds to the top level directory by which results will be filtered.

Type: null or (attribute set of (string or raw lua code))

Default: null

Plugin default: {}

Declared by: