plugins.project-nvim.settings

Options provided to the require('project_nvim').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  detection_methods = [
    "lsp"
  ];
  excludeDirs = [
    "/home/user/secret-directory"
  ];
  ignore_lsp = [
    "tsserver"
  ];
  patterns = [
    ".git"
  ];
  showHidden = true;
  silent_chdir = false;
}

Declared by:

plugins.project-nvim.settings.data_path

Path where project.nvim will store the project history for use in telescope.

Type: null or string or raw lua code

Default: null

Plugin default:

{
  __raw = "vim.fn.stdpath('data')";
}

Declared by:

plugins.project-nvim.settings.detection_methods

Methods of detecting the root directory. “lsp” uses the native neovim lsp, while “pattern” uses vim-rooter like glob pattern matching. Here order matters: if one is not detected, the other is used as fallback. You can also delete or rearangne the detection methods.

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

Default: null

Plugin default:

[
  "lsp"
  "pattern"
]

Declared by:

plugins.project-nvim.settings.exclude_dirs

Don’t calculate root dir on specific directories.

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

Default: null

Plugin default: [ ]

Declared by:

plugins.project-nvim.settings.ignore_lsp

Table of lsp clients to ignore by name.

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

Default: null

Plugin default: [ ]

Declared by:

plugins.project-nvim.settings.manual_mode

Manual mode doesn’t automatically change your root directory, so you have the option to manually do so using :ProjectRoot command.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.project-nvim.settings.patterns

All the patterns used to detect root dir, when “pattern” is in detectionMethods.

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

Default: null

Plugin default:

[
  ".git"
  "_darcs"
  ".hg"
  ".bzr"
  ".svn"
  "Makefile"
  "package.json"
]

Declared by:

plugins.project-nvim.settings.scope_chdir

What scope to change the directory.

Type: null or one of “global”, “tab”, “win” or raw lua code

Default: null

Plugin default: "global"

Declared by:

plugins.project-nvim.settings.show_hidden

Show hidden files in telescope.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.project-nvim.settings.silent_chdir

When set to false, you will get a message when project.nvim changes your directory.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: